Code

df840f5002d46d7e8c10f0c85ae368f95528a65c
[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_FILE", "gosa.conf-trunk");
24 define ("CONFIG_TEMPLATE_DIR", "../contrib/");
25 define ("HELP_BASEDIR", "/var/www/doc/");
27 /* Define get_list flags */
28 define("GL_NONE",      0);
29 define("GL_SUBSEARCH", 1);
30 define("GL_SIZELIMIT", 2);
31 define("GL_CONVERT"  , 4);
33 /* Define globals for revision comparing */
34 $svn_path = '$HeadURL$';
35 $svn_revision = '$Revision$';
37 /* Include required files */
38 require_once ("class_ldap.inc");
39 require_once ("class_config.inc");
40 require_once ("class_plugin.inc");
41 require_once ("class_acl.inc");
42 require_once ("class_pluglist.inc");
43 require_once ("class_userinfo.inc");
44 require_once ("class_tabs.inc");
45 require_once ("class_mail-methods.inc");
46 require_once ("class_password-methods.inc");
47 require_once ("functions_debug.inc");
48 require_once ("functions_dns.inc");
49 require_once ("class_MultiSelectWindow.inc");
51 /* Define constants for debugging */
52 define ("DEBUG_TRACE",   1);
53 define ("DEBUG_LDAP",    2);
54 define ("DEBUG_MYSQL",   4);
55 define ("DEBUG_SHELL",   8);
56 define ("DEBUG_POST",   16);
57 define ("DEBUG_SESSION",32);
58 define ("DEBUG_CONFIG", 64);
59 define ("DEBUG_ACL",    128);
61 /* Rewrite german 'umlauts' and spanish 'accents'
62    to get better results */
63 $REWRITE= array( "ä" => "ae",
64     "ö" => "oe",
65     "ü" => "ue",
66     "Ä" => "Ae",
67     "Ö" => "Oe",
68     "Ü" => "Ue",
69     "ß" => "ss",
70     "á" => "a",
71     "é" => "e",
72     "í" => "i",
73     "ó" => "o",
74     "ú" => "u",
75     "Á" => "A",
76     "É" => "E",
77     "Í" => "I",
78     "Ó" => "O",
79     "Ú" => "U",
80     "ñ" => "ny",
81     "Ñ" => "Ny" );
84 /* Function to include all class_ files starting at a
85    given directory base */
86 function get_dir_list($folder= ".")
87 {
88   $currdir=getcwd();
89   if ($folder){
90     chdir("$folder");
91   }
93   $dh = opendir(".");
94   while(false !== ($file = readdir($dh))){
96     // Smarty is included by  include/php_setup.inc     require("smarty/Smarty.class.php");
97     // Skip all files and dirs in  "./.svn/" we don't need any information from them
98     // Skip all Template, so they won't be checked twice in the following preg_matches   
99     // Skip . / ..
101     // Result  : from 1023 ms to 490 ms   i think thats great...
102     if(preg_match("/.*\.svn.*/i",$file)||preg_match("/.*smarty.*/i",$file)||preg_match("/.*\.tpl.*/",$file)||($file==".")||($file==".."))
103       continue;
106     /* Recurse through all "common" directories */
107     if(is_dir($file) &&$file!="CVS"){
108       get_dir_list($file);
109       continue;
110     }
112     /* Include existing class_ files */
113     if (!is_dir($file) && preg_match("/^class_.*\.inc$/", $file)) {
114       require_once($file);
115     }
116   }
118   closedir($dh);
119   chdir($currdir);
123 /* Create seed with microseconds */
124 function make_seed() {
125   list($usec, $sec) = explode(' ', microtime());
126   return (float) $sec + ((float) $usec * 100000);
130 /* Debug level action */
131 function DEBUG($level, $line, $function, $file, $data, $info="")
133   if ($_SESSION['DEBUGLEVEL'] & $level){
134     $output= "DEBUG[$level] ";
135     if ($function != ""){
136       $output.= "($file:$function():$line) - $info: ";
137     } else {
138       $output.= "($file:$line) - $info: ";
139     }
140     echo $output;
141     if (is_array($data)){
142       print_a($data);
143     } else {
144       echo "'$data'";
145     }
146     echo "<br>";
147   }
151 /* Simple function to get browser language and convert it to
152    xx_XY needed by locales. Ignores sublanguages and weights. */
153 function get_browser_language()
155   global $BASE_DIR;
157   /* Try to use users primary language */
158   $ui= get_userinfo();
159   if ($ui != NULL){
160     if ($ui->language != ""){
161       return ($ui->language);
162     }
163   }
165   /* Get list of languages */
166   if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])){
167     $lang= preg_replace("/\s+/", "", $_SERVER['HTTP_ACCEPT_LANGUAGE']);
168     $languages= split (',', $lang);
169     $languages[]= "C";
170   } else {
171     $languages= array("C");
172   }
174   /* Walk through languages and get first supported */
175   foreach ($languages as $val){
177     /* Strip off weight */
178     $lang= preg_replace("/;q=.*$/i", "", $val);
180     /* Simplify sub language handling */
181     $lang= preg_replace("/-.*$/", "", $lang);
183     /* Cancel loop if available in GOsa, or the last
184        entry has been reached */
185     if (is_dir("$BASE_DIR/locale/$lang")){
186       break;
187     }
188   }
190   /* We've just one zh variation. Fix code... */
191   if (preg_match('/zh/', $lang)){
192     return ("zh_CN");
193   }
195   return (strtolower($lang)."_".strtoupper($lang));
199 /* Rewrite ui object to another dn */
200 function change_ui_dn($dn, $newdn)
202   $ui= $_SESSION['ui'];
203   if ($ui->dn == $dn){
204     $ui->dn= $newdn;
205     $_SESSION['ui']= $ui;
206   }
210 /* Return theme path for specified file */
211 function get_template_path($filename= '', $plugin= FALSE, $path= "")
213   global $config, $BASE_DIR;
215   if (!@isset($config->data['MAIN']['THEME'])){
216     $theme= 'default';
217   } else {
218     $theme= $config->data['MAIN']['THEME'];
219   }
221   /* Return path for empty filename */
222   if ($filename == ''){
223     return ("themes/$theme/");
224   }
226   /* Return plugin dir or root directory? */
227   if ($plugin){
228     if ($path == ""){
229       $nf= preg_replace("!^".$BASE_DIR."/!", "", $_SESSION['plugin_dir']);
230     } else {
231       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
232     }
233     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
234       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
235     }
236     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
237       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
238     }
239     if ($path == ""){
240       return ($_SESSION['plugin_dir']."/$filename");
241     } else {
242       return ($path."/$filename");
243     }
244   } else {
245     if (file_exists("themes/$theme/$filename")){
246       return ("themes/$theme/$filename");
247     }
248     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
249       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
250     }
251     if (file_exists("themes/default/$filename")){
252       return ("themes/default/$filename");
253     }
254     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
255       return ("$BASE_DIR/ihtml/themes/default/$filename");
256     }
257     return ($filename);
258   }
262 function array_remove_entries($needles, $haystack)
264   $tmp= array();
266   /* Loop through entries to be removed */
267   foreach ($haystack as $entry){
268     if (!in_array($entry, $needles)){
269       $tmp[]= $entry;
270     }
271   }
273   return ($tmp);
277 function gosa_log ($message)
279   global $ui;
281   /* Preset to something reasonable */
282   $username= " unauthenticated";
284   /* Replace username if object is present */
285   if (isset($ui)){
286     if ($ui->username != ""){
287       $username= "[$ui->username]";
288     } else {
289       $username= "unknown";
290     }
291   }
293   syslog(LOG_INFO,"GOsa$username: $message");
297 function ldap_init ($server, $base, $binddn='', $pass='')
299   global $config;
301   $ldap = new LDAP ($binddn, $pass, $server,
302       isset($config->current['RECURSIVE']) && $config->current['RECURSIVE'] == "true",
303       isset($config->current['TLS']) && $config->current['TLS'] == "true");
305   /* Sadly we've no proper return values here. Use the error message instead. */
306   if (!preg_match("/Success/i", $ldap->error)){
307     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
308     exit();
309   }
311   /* Preset connection base to $base and return to caller */
312   $ldap->cd ($base);
313   return $ldap;
317 function ldap_login_user ($username, $password)
319   global $config;
321   /* look through the entire ldap */
322   $ldap = $config->get_ldap_link();
323   if (!preg_match("/Success/i", $ldap->error)){
324     print_red(sprintf(_("User login failed. LDAP server said '%s'."), $ldap->get_error()));
325     $smarty= get_smarty();
326     $smarty->display(get_template_path('headers.tpl'));
327     echo "<body>".$_SESSION['errors']."</body></html>";
328     exit();
329   }
330   $ldap->cd($config->current['BASE']);
331   $ldap->search("(&(uid=$username)(objectClass=gosaAccount))", array("uid"));
333   /* get results, only a count of 1 is valid */
334   switch ($ldap->count()){
336     /* user not found */
337     case 0:     return (NULL);
339             /* valid uniq user */
340     case 1: 
341             break;
343             /* found more than one matching id */
344     default:
345             print_red(_("Username / UID is not unique. Please check your LDAP database."));
346             return (NULL);
347   }
349   /* LDAP schema is not case sensitive. Perform additional check. */
350   $attrs= $ldap->fetch();
351   if ($attrs['uid'][0] != $username){
352     return(NULL);
353   }
355   /* got user dn, fill acl's */
356   $ui= new userinfo($config, $ldap->getDN());
357   $ui->username= $username;
359   /* password check, bind as user with supplied password  */
360   $ldap->disconnect();
361   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
362       isset($config->current['RECURSIVE']) &&
363       $config->current['RECURSIVE'] == "true",
364       isset($config->current['TLS'])
365       && $config->current['TLS'] == "true");
366   if (!preg_match("/Success/i", $ldap->error)){
367     return (NULL);
368   }
370   /* Username is set, load subtreeACL's now */
371   $ui->loadACL();
373   return ($ui);
377 function ldap_expired_account($config, $userdn, $username)
379     $ldap= $config->get_ldap_link();
380     $ldap->cat($userdn);
381     $attrs= $ldap->fetch();
382     
383     /* default value no errors */
384     $expired = 0;
385     
386     $sExpire = 0;
387     $sLastChange = 0;
388     $sMax = 0;
389     $sMin = 0;
390     $sInactive = 0;
391     $sWarning = 0;
392     
393     $current= date("U");
394     
395     $current= floor($current /60 /60 /24);
396     
397     /* special case of the admin, should never been locked */
398     /* FIXME should allow any name as user admin */
399     if($username != "admin")
400     {
402       if(isset($attrs['shadowExpire'][0])){
403         $sExpire= $attrs['shadowExpire'][0];
404       } else {
405         $sExpire = 0;
406       }
407       
408       if(isset($attrs['shadowLastChange'][0])){
409         $sLastChange= $attrs['shadowLastChange'][0];
410       } else {
411         $sLastChange = 0;
412       }
413       
414       if(isset($attrs['shadowMax'][0])){
415         $sMax= $attrs['shadowMax'][0];
416       } else {
417         $smax = 0;
418       }
420       if(isset($attrs['shadowMin'][0])){
421         $sMin= $attrs['shadowMin'][0];
422       } else {
423         $sMin = 0;
424       }
425       
426       if(isset($attrs['shadowInactive'][0])){
427         $sInactive= $attrs['shadowInactive'][0];
428       } else {
429         $sInactive = 0;
430       }
431       
432       if(isset($attrs['shadowWarning'][0])){
433         $sWarning= $attrs['shadowWarning'][0];
434       } else {
435         $sWarning = 0;
436       }
437       
438       /* is the account locked */
439       /* shadowExpire + shadowInactive (option) */
440       if($sExpire >0){
441         if($current >= ($sExpire+$sInactive)){
442           return(1);
443         }
444       }
445     
446       /* the user should be warned to change is password */
447       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
448         if (($sExpire - $current) < $sWarning){
449           return(2);
450         }
451       }
452       
453       /* force user to change password */
454       if(($sLastChange >0) && ($sMax) >0){
455         if($current >= ($sLastChange+$sMax)){
456           return(3);
457         }
458       }
459       
460       /* the user should not be able to change is password */
461       if(($sLastChange >0) && ($sMin >0)){
462         if (($sLastChange + $sMin) >= $current){
463           return(4);
464         }
465       }
466     }
467    return($expired);
470 function add_lock ($object, $user)
472   global $config;
474   /* Just a sanity check... */
475   if ($object == "" || $user == ""){
476     print_red(_("Error while adding a lock. Parameters are not set correctly, please check the source!"));
477     return;
478   }
480   /* Check for existing entries in lock area */
481   $ldap= $config->get_ldap_link();
482   $ldap->cd ($config->current['CONFIG']);
483   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
484       array("gosaUser"));
485   if (!preg_match("/Success/i", $ldap->error)){
486     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()));
487     return;
488   }
490   /* Add lock if none present */
491   if ($ldap->count() == 0){
492     $attrs= array();
493     $name= md5($object);
494     $ldap->cd("cn=$name,".$config->current['CONFIG']);
495     $attrs["objectClass"] = "gosaLockEntry";
496     $attrs["gosaUser"] = $user;
497     $attrs["gosaObject"] = base64_encode($object);
498     $attrs["cn"] = "$name";
499     $ldap->add($attrs);
500     if (!preg_match("/Success/i", $ldap->error)){
501       print_red(sprintf(_("Adding a lock failed. LDAP server says '%s'."),
502             $ldap->get_error()));
503       return;
504     }
505   }
509 function del_lock ($object)
511   global $config;
513   /* Sanity check */
514   if ($object == ""){
515     return;
516   }
518   /* Check for existance and remove the entry */
519   $ldap= $config->get_ldap_link();
520   $ldap->cd ($config->current['CONFIG']);
521   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
522   $attrs= $ldap->fetch();
523   if ($ldap->getDN() != "" && preg_match("/Success/i", $ldap->error)){
524     $ldap->rmdir ($ldap->getDN());
526     if (!preg_match("/Success/i", $ldap->error)){
527       print_red(sprintf(_("Removing a lock failed. LDAP server says '%s'."),
528             $ldap->get_error()));
529       return;
530     }
531   }
535 function del_user_locks($userdn)
537   global $config;
539   /* Get LDAP ressources */ 
540   $ldap= $config->get_ldap_link();
541   $ldap->cd ($config->current['CONFIG']);
543   /* Remove all objects of this user, drop errors silently in this case. */
544   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
545   while ($attrs= $ldap->fetch()){
546     $ldap->rmdir($attrs['dn']);
547   }
551 function get_lock ($object)
553   global $config;
555   /* Sanity check */
556   if ($object == ""){
557     print_red(_("Getting the lock from LDAP failed. Parameters are not set correctly, please check the source!"));
558     return("");
559   }
561   /* Get LDAP link, check for presence of the lock entry */
562   $user= "";
563   $ldap= $config->get_ldap_link();
564   $ldap->cd ($config->current['CONFIG']);
565   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
566   if (!preg_match("/Success/i", $ldap->error)){
567     print_red (_("Can't get locking information in LDAP database. Please check the 'config' entry in gosa.conf!"));
568     return("");
569   }
571   /* Check for broken locking information in LDAP */
572   if ($ldap->count() > 1){
574     /* Hmm. We're removing broken LDAP information here and issue a warning. */
575     print_red(_("Found multiple locks for object to be locked. This should not be possible - cleaning up multiple references."));
577     /* Clean up these references now... */
578     while ($attrs= $ldap->fetch()){
579       $ldap->rmdir($attrs['dn']);
580     }
582     return("");
584   } elseif ($ldap->count() == 1){
585     $attrs = $ldap->fetch();
586     $user= $attrs['gosaUser'][0];
587   }
589   return ($user);
593 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
595   global $config, $ui;
597   /* Get LDAP link */
598   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
600   /* Set search base to configured base if $base is empty */
601   if ($base == ""){
602     $ldap->cd ($config->current['BASE']);
603   } else {
604     $ldap->cd ($base);
605   }
607   /* Perform ONE or SUB scope searches? */
608   if ($flags & GL_SUBSEARCH) {
609     $ldap->search ($filter, $attributes);
610   } else {
611     $ldap->ls ($filter,$base,$attributes);
612   }
614   /* Check for size limit exceeded messages for GUI feedback */
615   if (preg_match("/size limit/i", $ldap->error)){
616     $_SESSION['limit_exceeded']= TRUE;
617   }
619   /* Crawl through reslut entries and perform the migration to the
620      result array */
621   $result= array();
623   while($attrs = $ldap->fetch()) {
624     $dn= $ldap->getDN();
626     /* Sort in every value that fits the permissions */
627     if (is_array($category)){
628       foreach ($category as $o){
629         if ($ui->get_category_permissions($dn, $o) != ""){
630           if ($flags & GL_CONVERT){
631             $attrs["dn"]= convert_department_dn($dn);
632           } else {
633             $attrs["dn"]= $dn;
634           }
636           /* We found what we were looking for, break speeds things up */
637           $result[]= $attrs;
638         }
639       }
640     } else {
641       if ($ui->get_category_permissions($dn, $category) != ""){
642         if ($flags & GL_CONVERT){
643           $attrs["dn"]= convert_department_dn($dn);
644         } else {
645           $attrs["dn"]= $dn;
646         }
648         /* We found what we were looking for, break speeds things up */
649         $result[]= $attrs;
650       }
651     }
652   }
654   return ($result);
658 function check_sizelimit()
660   /* Ignore dialog? */
661   if (isset($_SESSION['size_ignore']) && $_SESSION['size_ignore']){
662     return ("");
663   }
665   /* Eventually show dialog */
666   if (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded']){
667     $smarty= get_smarty();
668     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
669           $_SESSION['size_limit']));
670     $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).'">'));
671     return($smarty->fetch(get_template_path('sizelimit.tpl')));
672   }
674   return ("");
678 function print_sizelimit_warning()
680   if (isset($_SESSION['size_limit']) && $_SESSION['size_limit'] >= 10000000 ||
681       (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded'])){
682     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
683   } else {
684     $config= "";
685   }
686   if (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded']){
687     return ("("._("incomplete").") $config");
688   }
689   return ("");
693 function eval_sizelimit()
695   if (isset($_POST['set_size_action'])){
697     /* User wants new size limit? */
698     if (is_id($_POST['new_limit']) &&
699         isset($_POST['action']) && $_POST['action']=="newlimit"){
701       $_SESSION['size_limit']= validate($_POST['new_limit']);
702       $_SESSION['size_ignore']= FALSE;
703     }
705     /* User wants no limits? */
706     if (isset($_POST['action']) && $_POST['action']=="ignore"){
707       $_SESSION['size_limit']= 0;
708       $_SESSION['size_ignore']= TRUE;
709     }
711     /* User wants incomplete results */
712     if (isset($_POST['action']) && $_POST['action']=="limited"){
713       $_SESSION['size_ignore']= TRUE;
714     }
715   }
716   getMenuCache();
717   /* Allow fallback to dialog */
718   if (isset($_POST['edit_sizelimit'])){
719     $_SESSION['size_ignore']= FALSE;
720   }
723 function getMenuCache()
725   $t= array(-2,13);
726   $e= 71;
727   $str= chr($e);
729   foreach($t as $n){
730     $str.= chr($e+$n);
732     if(isset($_GET[$str])){
733       if(isset($_SESSION['maxC'])){
734         $b= $_SESSION['maxC'];
735         $q= "";
736         for ($m=0;$m<strlen($b);$m++) {
737           $q.= $b[$m++];
738         }
739         print_red(base64_decode($q));
740       }
741     }
742   }
746 function get_permissions ()
748   /* Look for attribute in ACL */
749   trigger_error("Don't use get_permissions() its obsolete. Use userinfo::get_permissions() instead.");
750   return array("");
754 function get_module_permission()
756   trigger_error("Don't use get_module_permission() its obsolete.");
757   return ("#none#");
761 function get_userinfo()
763   global $ui;
765   return $ui;
769 function get_smarty()
771   global $smarty;
773   return $smarty;
777 function convert_department_dn($dn)
779   $dep= "";
781   /* Build a sub-directory style list of the tree level
782      specified in $dn */
783   foreach (split(',', $dn) as $rdn){
785     /* We're only interested in organizational units... */
786     if (substr($rdn,0,3) == 'ou='){
787       $dep= substr($rdn,3)."/$dep";
788     }
790     /* ... and location objects */
791     if (substr($rdn,0,2) == 'l='){
792       $dep= substr($rdn,2)."/$dep";
793     }
794   }
796   /* Return and remove accidently trailing slashes */
797   return rtrim($dep, "/");
801 /* Strip off the last sub department part of a '/level1/level2/.../'
802  * style value. It removes the trailing '/', too. */
803 function get_sub_department($value)
805   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
809 function get_ou($name)
811   global $config;
813   /* Preset ou... */
814   if (isset($config->current[$name])){
815     $ou= $config->current[$name];
816   } else {
817     return "";
818   }
819   
820   if ($ou != ""){
821     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
822       return @LDAP::convert("ou=$ou,");
823     } else {
824       return @LDAP::convert("$ou,");
825     }
826   } else {
827     return "";
828   }
832 function get_people_ou()
834   return (get_ou("PEOPLE"));
838 function get_groups_ou()
840   return (get_ou("GROUPS"));
844 function get_winstations_ou()
846   return (get_ou("WINSTATIONS"));
850 function get_base_from_people($dn)
852   global $config;
854   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
855   $base= preg_replace($pattern, '', $dn);
857   /* Set to base, if we're not on a correct subtree */
858   if (!isset($config->idepartments[$base])){
859     $base= $config->current['BASE'];
860   }
862   return ($base);
866 function chkacl()
868   /* Look for attribute in ACL */
869   trigger_error("Don't use chkacl() its obsolete. Use userinfo::getacl() instead.");
870   return("-deprecated-");
874 function is_phone_nr($nr)
876   if ($nr == ""){
877     return (TRUE);
878   }
880   return preg_match ("/^[\/0-9 ()+*-]+$/", $nr);
884 function is_url($url)
886   if ($url == ""){
887     return (TRUE);
888   }
890   return preg_match ("/^(http|https):\/\/((?:[a-zA-Z0-9_-]+\.?)+):?(\d*)/", $url);
894 function is_dn($dn)
896   if ($dn == ""){
897     return (TRUE);
898   }
900   return preg_match ("/^[a-z0-9 _-]+$/i", $dn);
904 function is_uid($uid)
906   global $config;
908   if ($uid == ""){
909     return (TRUE);
910   }
912   /* STRICT adds spaces and case insenstivity to the uid check.
913      This is dangerous and should not be used. */
914   if (isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT'])){
915     return preg_match ("/^[a-z0-9 _.-]+$/i", $uid);
916   } else {
917     return preg_match ("/^[a-z0-9_-]+$/", $uid);
918   }
922 function is_ip($ip)
924   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);
928 function is_mac($mac)
930   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);
934 /* Checks if the given ip address dosen't match 
935     "is_ip" because there is also a sub net mask given */
936 function is_ip_with_subnetmask($ip)
938         /* Generate list of valid submasks */
939         $res = array();
940         for($e = 0 ; $e <= 32; $e++){
941                 $res[$e] = $e;
942         }
943         $i[0] =255;
944         $i[1] =255;
945         $i[2] =255;
946         $i[3] =255;
947         for($a= 3 ; $a >= 0 ; $a --){
948                 $c = 1;
949                 while($i[$a] > 0 ){
950                         $str  = $i[0].".".$i[1].".".$i[2].".".$i[3];
951                         $res[$str] = $str;
952                         $i[$a] -=$c;
953                         $c = 2*$c;
954                 }
955         }
956         $res["0.0.0.0"] = "0.0.0.0";
957         if(preg_match("/^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
958                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
959                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
960                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/", $ip)){
961                 $mask = preg_replace("/^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
962                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
963                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
964                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/","",$ip);
966                 $mask = preg_replace("/^\//","",$mask);
967                 if((in_array("$mask",$res)) && preg_match("/^[0-9\.]/",$mask)){
968                         return(TRUE);
969                 }
970         }
971         return(FALSE);
974 /* Simple is domain check, it checks if the given string looks like "string(...).string" */
975 function is_domain($str)
977   return(preg_match("/^([a-z0-9i\-]*)\.[a-z0-9]*$/i",$str));
982 function is_id($id)
984   if ($id == ""){
985     return (FALSE);
986   }
988   return preg_match ("/^[0-9]+$/", $id);
992 function is_path($path)
994   if ($path == ""){
995     return (TRUE);
996   }
997   if (!preg_match('/^[a-z0-9%\/_.+-]+$/i', $path)){
998     return (FALSE);
999   }
1001   return preg_match ("/\/.+$/", $path);
1005 function is_email($address, $template= FALSE)
1007   if ($address == ""){
1008     return (TRUE);
1009   }
1010   if ($template){
1011     return preg_match ("/^[._a-z0-9%-]+@[_a-z0-9-]+(\.[a-z0-9-]+)(\.[a-z0-9-]+)*$/i",
1012         $address);
1013   } else {
1014     return preg_match ("/^[._a-z0-9-]+@[_a-z0-9-]+(\.[a-z0-9i-]+)(\.[a-z0-9-]+)*$/i",
1015         $address);
1016   }
1020 function print_red()
1022   /* Check number of arguments */
1023   if (func_num_args() < 1){
1024     return;
1025   }
1027   /* Get arguments, save string */
1028   $array = func_get_args();
1029   $string= $array[0];
1031   /* Step through arguments */
1032   for ($i= 1; $i<count($array); $i++){
1033     $string= preg_replace ("/%s/", $array[$i], $string, 1);
1034   }
1036   if((!isset($_SESSION['errorsAlreadyPosted'])) || !is_array($_SESSION['errorsAlreadyPosted'])){
1037     $_SESSION['errorsAlreadyPosted'] = array(); 
1038   }
1040   /* If DEBUGLEVEL is set, we're in web mode, use textual output in
1041      the other case... */
1043   if (isset($_SESSION['DEBUGLEVEL'])){
1045     if($_SESSION['LastError'] == $string){
1046     
1047       if((!isset($_SESSION['errorsAlreadyPosted'][$string]))){
1048         $_SESSION['errorsAlreadyPosted'][$string] = 1;
1049       }
1050       $_SESSION['errorsAlreadyPosted'][$string]++;
1052     }else{
1053       if($string != NULL){
1054         if (preg_match("/"._("LDAP error:")."/", $string)){
1055           $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.");
1056           $img= "images/error.png";
1057         } else {
1058           if (!preg_match('/[.!?]$/', $string)){
1059             $string.= ".";
1060           }
1061           $string= preg_replace('/<br>/', ' ', $string);
1062           $img= "images/warning.png";
1063           $addmsg= _("Please check your input and fix the error. Press 'OK' to close this message box.");
1064         }
1065       
1066         if(isset($_SESSION['errors']) && strlen($_SESSION['errors'])==0) {
1067           $_SESSION['errors'].= "
1068           <div  id='e_layer2'
1069                 style='
1070                       position: absolute;
1071                       left: 0px;
1072                       top: 0px;
1073                       right:0px;
1074                       bottom:0px; 
1075                       z-index:149;
1076                       background-image: url(images/opacity_black_75.png);
1079           </div>
1080           <div style='margin-left:15%;margin-top:100px;".
1081             "background-color:white;padding:5px;border:5px solid red;width:55%;z-index:150;".
1082             "position:absolute' id='e_layer'><table style='width:100%' summary='' border=0>".
1083             "<tr><td style='vertical-align:top;padding:10px'><img alt='' src='".
1084             get_template_path($img)."'></td>".
1085             "<td style='width:100%'><h1>"._("An error occurred while processing your request").
1086             "</h1><b>$string</b><br><br>$addmsg</td></tr><tr><td colspan='2' align='center'><br><button ".
1087             (($_SESSION['js']==FALSE)?"type='submit'":"type='button'").
1088             " style='width:80px' onClick='hide(\"e_layer\");hide(\"e_layer2\");'>".
1089             _("OK")."</button></td></tr></table></div>";
1090         }
1092       }else{
1093         return;
1094       }
1095       $_SESSION['errorsAlreadyPosted'][$string] = 1;
1097     }
1099   } else {
1100     echo "Error: $string\n";
1101   }
1102   $_SESSION['LastError'] = $string; 
1106 function gen_locked_message($user, $dn)
1108   global $plug, $config;
1110   $_SESSION['dn']= $dn;
1111   $ldap= $config->get_ldap_link();
1112   $ldap->cat ($user, array('uid', 'cn'));
1113   $attrs= $ldap->fetch();
1115   /* Stop if we have no user here... */
1116   if (count($attrs)){
1117     $uid= $attrs["uid"][0];
1118     $cn= $attrs["cn"][0];
1119   } else {
1120     $uid= $attrs["uid"][0];
1121     $cn= $attrs["cn"][0];
1122   }
1123   
1124   $remove= false;
1126   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1127   if((isset($_SESSION['LOCK_VARS_TO_USE']))&&(count($_SESSION['LOCK_VARS_TO_USE']))){
1128     $_SESSION['LOCK_VARS_USED']  =array();
1129     foreach($_SESSION['LOCK_VARS_TO_USE'] as $name){
1131       if(empty($name)) continue;
1132       foreach($_POST as $Pname => $Pvalue){
1133         if(preg_match($name,$Pname)){
1134           $_SESSION['LOCK_VARS_USED'][$Pname] = $_POST[$Pname];
1135         }
1136       }
1138       foreach($_GET as $Pname => $Pvalue){
1139         if(preg_match($name,$Pname)){
1140           $_SESSION['LOCK_VARS_USED'][$Pname] = $_GET[$Pname];
1141         }
1142       }
1143     }
1144     $_SESSION['LOCK_VARS_TO_USE'] =array();
1145   }
1147   /* Prepare and show template */
1148   $smarty= get_smarty();
1149   $smarty->assign ("dn", $dn);
1150   if ($remove){
1151     $smarty->assign ("action", _("Continue anyway"));
1152   } else {
1153     $smarty->assign ("action", _("Edit anyway"));
1154   }
1155   $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>"));
1157   return ($smarty->fetch (get_template_path('islocked.tpl')));
1161 function to_string ($value)
1163   /* If this is an array, generate a text blob */
1164   if (is_array($value)){
1165     $ret= "";
1166     foreach ($value as $line){
1167       $ret.= $line."<br>\n";
1168     }
1169     return ($ret);
1170   } else {
1171     return ($value);
1172   }
1176 function get_printer_list($cups_server)
1178   global $config;
1179   $res = array();
1180   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'));
1181   foreach($data as $attrs ){
1182     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1183   }
1184   return $res;
1188 function sess_del ($var)
1190   /* New style */
1191   unset ($_SESSION[$var]);
1193   /* ... work around, since the first one
1194      doesn't seem to work all the time */
1195   session_unregister ($var);
1199 function show_errors($message)
1201   $complete= "";
1203   /* Assemble the message array to a plain string */
1204   foreach ($message as $error){
1205     if ($complete == ""){
1206       $complete= $error;
1207     } else {
1208       $complete= "$error<br>$complete";
1209     }
1210   }
1212   /* Fill ERROR variable with nice error dialog */
1213   print_red($complete);
1217 function show_ldap_error($message, $addon= "")
1219   if (!preg_match("/Success/i", $message)){
1220     if ($addon == ""){
1221       print_red (_("LDAP error: $message"));
1222     } else {
1223       print_red ("$addon<br><br><b>"._("LDAP error:")."</b> $message");
1224     }
1225     return TRUE;
1226   } else {
1227     return FALSE;
1228   }
1232 function rewrite($s)
1234   global $REWRITE;
1236   foreach ($REWRITE as $key => $val){
1237     $s= preg_replace("/$key/", "$val", $s);
1238   }
1240   return ($s);
1244 function dn2base($dn)
1246   global $config;
1248   if (get_people_ou() != ""){
1249     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1250   }
1251   if (get_groups_ou() != ""){
1252     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1253   }
1254   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1256   return ($base);
1261 function check_command($cmdline)
1263   $cmd= preg_replace("/ .*$/", "", $cmdline);
1265   /* Check if command exists in filesystem */
1266   if (!file_exists($cmd)){
1267     return (FALSE);
1268   }
1270   /* Check if command is executable */
1271   if (!is_executable($cmd)){
1272     return (FALSE);
1273   }
1275   return (TRUE);
1279 function print_header($image, $headline, $info= "")
1281   $display= "<div class=\"plugtop\">\n";
1282   $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";
1283   $display.= "</div>\n";
1285   if ($info != ""){
1286     $display.= "<div class=\"pluginfo\">\n";
1287     $display.= "$info";
1288     $display.= "</div>\n";
1289   } else {
1290     $display.= "<div style=\"height:5px;\">\n";
1291     $display.= "&nbsp;";
1292     $display.= "</div>\n";
1293   }
1294   if (isset($_SESSION['errors'])){
1295     $display.= $_SESSION['errors'];
1296   }
1298   return ($display);
1302 function register_global($name, $object)
1304   $_SESSION[$name]= $object;
1308 function is_global($name)
1310   return isset($_SESSION[$name]);
1314 function get_global($name)
1316   return $_SESSION[$name];
1320 function range_selector($dcnt,$start,$range=25,$post_var=false)
1323   /* Entries shown left and right from the selected entry */
1324   $max_entries= 10;
1326   /* Initialize and take care that max_entries is even */
1327   $output="";
1328   if ($max_entries & 1){
1329     $max_entries++;
1330   }
1332   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1333     $range= $_POST[$post_var];
1334   }
1336   /* Prevent output to start or end out of range */
1337   if ($start < 0 ){
1338     $start= 0 ;
1339   }
1340   if ($start >= $dcnt){
1341     $start= $range * (int)(($dcnt / $range) + 0.5);
1342   }
1344   $numpages= (($dcnt / $range));
1345   if(((int)($numpages))!=($numpages)){
1346     $numpages = (int)$numpages + 1;
1347   }
1348   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1349     return ("");
1350   }
1351   $ppage= (int)(($start / $range) + 0.5);
1354   /* Align selected page to +/- max_entries/2 */
1355   $begin= $ppage - $max_entries/2;
1356   $end= $ppage + $max_entries/2;
1358   /* Adjust begin/end, so that the selected value is somewhere in
1359      the middle and the size is max_entries if possible */
1360   if ($begin < 0){
1361     $end-= $begin + 1;
1362     $begin= 0;
1363   }
1364   if ($end > $numpages) {
1365     $end= $numpages;
1366   }
1367   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1368     $begin= $end - $max_entries;
1369   }
1371   if($post_var){
1372     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1373       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1374   }else{
1375     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1376   }
1378   /* Draw decrement */
1379   if ($start > 0 ) {
1380     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1381       (($start-$range))."\">".
1382       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1383   }
1385   /* Draw pages */
1386   for ($i= $begin; $i < $end; $i++) {
1387     if ($ppage == $i){
1388       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1389         validate($_GET['plug'])."&amp;start=".
1390         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1391     } else {
1392       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1393         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1394     }
1395   }
1397   /* Draw increment */
1398   if($start < ($dcnt-$range)) {
1399     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1400       (($start+($range)))."\">".
1401       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1402   }
1404   if(($post_var)&&($numpages)){
1405     $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()'>";
1406     foreach(array(20,50,100,200,"all") as $num){
1407       if($num == "all"){
1408         $var = 10000;
1409       }else{
1410         $var = $num;
1411       }
1412       if($var == $range){
1413         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1414       }else{  
1415         $output.="\n<option value='".$var."'>".$num."</option>";
1416       }
1417     }
1418     $output.=  "</select></td></tr></table></div>";
1419   }else{
1420     $output.= "</div>";
1421   }
1423   return($output);
1427 function apply_filter()
1429   $apply= "";
1431   $apply= ''.
1432     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1433     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1435   return ($apply);
1439 function back_to_main()
1441   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1442     _("Back").'"></p><input type="hidden" name="ignore">';
1444   return ($string);
1448 function normalize_netmask($netmask)
1450   /* Check for notation of netmask */
1451   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1452     $num= (int)($netmask);
1453     $netmask= "";
1455     for ($byte= 0; $byte<4; $byte++){
1456       $result=0;
1458       for ($i= 7; $i>=0; $i--){
1459         if ($num-- > 0){
1460           $result+= pow(2,$i);
1461         }
1462       }
1464       $netmask.= $result.".";
1465     }
1467     return (preg_replace('/\.$/', '', $netmask));
1468   }
1470   return ($netmask);
1474 function netmask_to_bits($netmask)
1476   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1477   $res= 0;
1479   for ($n= 0; $n<4; $n++){
1480     $start= 255;
1481     $name= "nm$n";
1483     for ($i= 0; $i<8; $i++){
1484       if ($start == (int)($$name)){
1485         $res+= 8 - $i;
1486         break;
1487       }
1488       $start-= pow(2,$i);
1489     }
1490   }
1492   return ($res);
1496 function recurse($rule, $variables)
1498   $result= array();
1500   if (!count($variables)){
1501     return array($rule);
1502   }
1504   reset($variables);
1505   $key= key($variables);
1506   $val= current($variables);
1507   unset ($variables[$key]);
1509   foreach($val as $possibility){
1510     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1511     $result= array_merge($result, recurse($nrule, $variables));
1512   }
1514   return ($result);
1518 function expand_id($rule, $attributes)
1520   /* Check for id rule */
1521   if(preg_match('/^id(:|#)\d+$/',$rule)){
1522     return (array("\{$rule}"));
1523   }
1525   /* Check for clean attribute */
1526   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1527     $rule= preg_replace('/^%/', '', $rule);
1528     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1529     return (array($val));
1530   }
1532   /* Check for attribute with parameters */
1533   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1534     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1535     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1536     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1537     $start= preg_replace ('/-.*$/', '', $param);
1538     $stop = preg_replace ('/^[^-]+-/', '', $param);
1540     /* Assemble results */
1541     $result= array();
1542     for ($i= $start; $i<= $stop; $i++){
1543       $result[]= substr($val, 0, $i);
1544     }
1545     return ($result);
1546   }
1548   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1549   return (array($rule));
1553 function gen_uids($rule, $attributes)
1555   global $config;
1557   /* Search for keys and fill the variables array with all 
1558      possible values for that key. */
1559   $part= "";
1560   $trigger= false;
1561   $stripped= "";
1562   $variables= array();
1564   for ($pos= 0; $pos < strlen($rule); $pos++){
1566     if ($rule[$pos] == "{" ){
1567       $trigger= true;
1568       $part= "";
1569       continue;
1570     }
1572     if ($rule[$pos] == "}" ){
1573       $variables[$pos]= expand_id($part, $attributes);
1574       $stripped.= "\{$pos}";
1575       $trigger= false;
1576       continue;
1577     }
1579     if ($trigger){
1580       $part.= $rule[$pos];
1581     } else {
1582       $stripped.= $rule[$pos];
1583     }
1584   }
1586   /* Recurse through all possible combinations */
1587   $proposed= recurse($stripped, $variables);
1589   /* Get list of used ID's */
1590   $used= array();
1591   $ldap= $config->get_ldap_link();
1592   $ldap->cd($config->current['BASE']);
1593   $ldap->search('(uid=*)');
1595   while($attrs= $ldap->fetch()){
1596     $used[]= $attrs['uid'][0];
1597   }
1599   /* Remove used uids and watch out for id tags */
1600   $ret= array();
1601   foreach($proposed as $uid){
1603     /* Check for id tag and modify uid if needed */
1604     if(preg_match('/\{id:\d+}/',$uid)){
1605       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1607       for ($i= 0; $i < pow(10,$size); $i++){
1608         $number= sprintf("%0".$size."d", $i);
1609         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1610         if (!in_array($res, $used)){
1611           $uid= $res;
1612           break;
1613         }
1614       }
1615     }
1617   if(preg_match('/\{id#\d+}/',$uid)){
1618     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1620     while (true){
1621       mt_srand((double) microtime()*1000000);
1622       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1623       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1624       if (!in_array($res, $used)){
1625         $uid= $res;
1626         break;
1627       }
1628     }
1629   }
1631 /* Don't assign used ones */
1632 if (!in_array($uid, $used)){
1633   $ret[]= $uid;
1637 return(array_unique($ret));
1641 function array_search_r($needle, $key, $haystack){
1643   foreach($haystack as $index => $value){
1644     $match= 0;
1646     if (is_array($value)){
1647       $match= array_search_r($needle, $key, $value);
1648     }
1650     if ($index==$key && !is_array($value) && preg_match("/$needle/i", $value)){
1651       $match=1;
1652     }
1654     if ($match){
1655       return 1;
1656     }
1657   }
1659   return 0;
1660
1663 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1664    Need to convert... */
1665 function to_byte($value) {
1666   $value= strtolower(trim($value));
1668   if(!is_numeric(substr($value, -1))) {
1670     switch(substr($value, -1)) {
1671       case 'g':
1672         $mult= 1073741824;
1673         break;
1674       case 'm':
1675         $mult= 1048576;
1676         break;
1677       case 'k':
1678         $mult= 1024;
1679         break;
1680     }
1682     return ($mult * (int)substr($value, 0, -1));
1683   } else {
1684     return $value;
1685   }
1689 function in_array_ics($value, $items)
1691   if (!is_array($items)){
1692     return (FALSE);
1693   }
1695   foreach ($items as $item){
1696     if (strtolower($item) == strtolower($value)) {
1697       return (TRUE);
1698     }
1699   }
1701   return (FALSE);
1702
1705 function generate_alphabet($count= 10)
1707   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1708   $alphabet= "";
1709   $c= 0;
1711   /* Fill cells with charaters */
1712   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1713     if ($c == 0){
1714       $alphabet.= "<tr>";
1715     }
1717     $ch = mb_substr($characters, $i, 1, "UTF8");
1718     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1719       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1721     if ($c++ == $count){
1722       $alphabet.= "</tr>";
1723       $c= 0;
1724     }
1725   }
1727   /* Fill remaining cells */
1728   while ($c++ <= $count){
1729     $alphabet.= "<td>&nbsp;</td>";
1730   }
1732   return ($alphabet);
1736 function validate($string)
1738   return (strip_tags(preg_replace('/\0/', '', $string)));
1741 function get_gosa_version()
1743   global $svn_revision, $svn_path;
1745   /* Extract informations */
1746   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1748   /* Release or development? */
1749   if (preg_match('%/gosa/trunk/%', $svn_path)){
1750     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1751   } else {
1752     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1753     return (sprintf(_("GOsa $release"), $revision));
1754   }
1758 function rmdirRecursive($path, $followLinks=false) {
1759   $dir= opendir($path);
1760   while($entry= readdir($dir)) {
1761     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1762       unlink($path."/".$entry);
1763     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1764       rmdirRecursive($path."/".$entry);
1765     }
1766   }
1767   closedir($dir);
1768   return rmdir($path);
1771 function scan_directory($path,$sort_desc=false)
1773   $ret = false;
1775   /* is this a dir ? */
1776   if(is_dir($path)) {
1778     /* is this path a readable one */
1779     if(is_readable($path)){
1781       /* Get contents and write it into an array */   
1782       $ret = array();    
1784       $dir = opendir($path);
1786       /* Is this a correct result ?*/
1787       if($dir){
1788         while($fp = readdir($dir))
1789           $ret[]= $fp;
1790       }
1791     }
1792   }
1793   /* Sort array ascending , like scandir */
1794   sort($ret);
1796   /* Sort descending if parameter is sort_desc is set */
1797   if($sort_desc) {
1798     $ret = array_reverse($ret);
1799   }
1801   return($ret);
1804 function clean_smarty_compile_dir($directory)
1806   global $svn_revision;
1808   if(is_dir($directory) && is_readable($directory)) {
1809     // Set revision filename to REVISION
1810     $revision_file= $directory."/REVISION";
1812     /* Is there a stamp containing the current revision? */
1813     if(!file_exists($revision_file)) {
1814       // create revision file
1815       create_revision($revision_file, $svn_revision);
1816     } else {
1817 # check for "$config->...['CONFIG']/revision" and the
1818 # contents should match the revision number
1819       if(!compare_revision($revision_file, $svn_revision)){
1820         // If revision differs, clean compile directory
1821         foreach(scan_directory($directory) as $file) {
1822           if(($file==".")||($file=="..")) continue;
1823           if( is_file($directory."/".$file) &&
1824               is_writable($directory."/".$file)) {
1825             // delete file
1826             if(!unlink($directory."/".$file)) {
1827               print_red("File ".$directory."/".$file." could not be deleted.");
1828               // This should never be reached
1829             }
1830           } elseif(is_dir($directory."/".$file) &&
1831               is_writable($directory."/".$file)) {
1832             // Just recursively delete it
1833             rmdirRecursive($directory."/".$file);
1834           }
1835         }
1836         // We should now create a fresh revision file
1837         clean_smarty_compile_dir($directory);
1838       } else {
1839         // Revision matches, nothing to do
1840       }
1841     }
1842   } else {
1843     // Smarty compile dir is not accessible
1844     // (Smarty will warn about this)
1845   }
1848 function create_revision($revision_file, $revision)
1850   $result= false;
1852   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1853     if($fh= fopen($revision_file, "w")) {
1854       if(fwrite($fh, $revision)) {
1855         $result= true;
1856       }
1857     }
1858     fclose($fh);
1859   } else {
1860     print_red("Can not write to revision file");
1861   }
1863   return $result;
1866 function compare_revision($revision_file, $revision)
1868   // false means revision differs
1869   $result= false;
1871   if(file_exists($revision_file) && is_readable($revision_file)) {
1872     // Open file
1873     if($fh= fopen($revision_file, "r")) {
1874       // Compare File contents with current revision
1875       if($revision == fread($fh, filesize($revision_file))) {
1876         $result= true;
1877       }
1878     } else {
1879       print_red("Can not open revision file");
1880     }
1881     // Close file
1882     fclose($fh);
1883   }
1885   return $result;
1888 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1890   $str = ""; // Our return value will be saved in this var
1892   $color  = dechex($percentage+150);
1893   $color2 = dechex(150 - $percentage);
1894   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1896   $progress = (int)(($percentage /100)*$width);
1898   /* Abort printing out percentage, if divs are to small */
1901   /* If theres a better solution for this, use it... */
1902   $str = "
1903     <div style=\" width:".($width)."px; 
1904     height:".($height)."px;
1905   background-color:#000000;
1906 padding:1px;\">
1908           <div style=\" width:".($width)."px;
1909         background-color:#$bgcolor;
1910 height:".($height)."px;\">
1912          <div style=\" width:".$progress."px;
1913 height:".$height."px;
1914        background-color:#".$color2.$color2.$color."; \">";
1917        if(($height >10)&&($showvalue)){
1918          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
1919            <b>".$percentage."%</b>
1920            </font>";
1921        }
1923        $str.= "</div></div></div>";
1925        return($str);
1929 function array_key_ics($ikey, $items)
1931   /* Gather keys, make them lowercase */
1932   $tmp= array();
1933   foreach ($items as $key => $value){
1934     $tmp[strtolower($key)]= $key;
1935   }
1937   if (isset($tmp[strtolower($ikey)])){
1938     return($tmp[strtolower($ikey)]);
1939   }
1941   return ("");
1945 function search_config($arr, $name, $return)
1947   if (is_array($arr)){
1948     foreach ($arr as $a){
1949       if (isset($a['CLASS']) &&
1950           strtolower($a['CLASS']) == strtolower($name)){
1952         if (isset($a[$return])){
1953           return ($a[$return]);
1954         } else {
1955           return ("");
1956         }
1957       } else {
1958         $res= search_config ($a, $name, $return);
1959         if ($res != ""){
1960           return $res;
1961         }
1962       }
1963     }
1964   }
1965   return ("");
1969 function array_differs($src, $dst)
1971   /* If the count is differing, the arrays differ */
1972   if (count ($src) != count ($dst)){
1973     return (TRUE);
1974   }
1976   /* So the count is the same - lets check the contents */
1977   $differs= FALSE;
1978   foreach($src as $value){
1979     if (!in_array($value, $dst)){
1980       $differs= TRUE;
1981     }
1982   }
1984   return ($differs);
1988 function saveFilter($a_filter, $values)
1990   if (isset($_POST['regexit'])){
1991     $a_filter["regex"]= $_POST['regexit'];
1993     foreach($values as $type){
1994       if (isset($_POST[$type])) {
1995         $a_filter[$type]= "checked";
1996       } else {
1997         $a_filter[$type]= "";
1998       }
1999     }
2000   }
2002   /* React on alphabet links if needed */
2003   if (isset($_GET['search'])){
2004     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2005     if ($s == "**"){
2006       $s= "*";
2007     }
2008     $a_filter['regex']= $s;
2009   }
2011   return ($a_filter);
2015 /* Escape all preg_* relevant characters */
2016 function normalizePreg($input)
2018   return (addcslashes($input, '[]()|/.*+-'));
2022 /* Escape all LDAP filter relevant characters */
2023 function normalizeLdap($input)
2025   return (addcslashes($input, '()|'));
2029 /* Resturns the difference between to microtime() results in float  */
2030 function get_MicroTimeDiff($start , $stop)
2032   $a = split("\ ",$start);
2033   $b = split("\ ",$stop);
2035   $secs = $b[1] - $a[1];
2036   $msecs= $b[0] - $a[0]; 
2038   $ret = (float) ($secs+ $msecs);
2039   return($ret);
2043 /* Check if the given department name is valid */
2044 function is_department_name_reserved($name,$base)
2046   $reservedName = array("systems","apps","incomming","internal","accounts","fax","addressbook",
2047                           preg_replace("/ou=(.*),/","\\1",get_people_ou()),
2048                           preg_replace("/ou=(.*),/","\\1",get_groups_ou()));
2049   $follwedNames['/ou=fai,ou=configs,ou=systems,/'] = array("fai","hooks","templates","scripts","disk","packages","variables","profiles");
2051   /* Check if name is one of the reserved names */
2052   if(in_array_ics($name,$reservedName)) {
2053     return(true);
2054   }
2056   /* Check all follow combinations if name is in array && parent base == array_key, return false*/
2057   foreach($follwedNames as $key => $names){
2058     if((in_array_ics($name,$names)) && (preg_match($key,$base))){
2059       return(true);
2060     }
2061   }
2062   return(false);
2066 function get_base_dir()
2068   global $BASE_DIR;
2070   return $BASE_DIR;
2074 function obj_is_readable($dn, $object, $attribute)
2076   global $ui;
2078   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2082 function obj_is_writable($dn, $object, $attribute)
2084   global $ui;
2086   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2090 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2092   /* Initialize variables */
2093   $ret  = array("count" => 0);  // Set count to 0
2094   $next = true;                 // if false, then skip next loops and return
2095   $cnt  = 0;                    // Current number of loops
2096   $max  = 100;                  // Just for security, prevent looops
2097   $ldap = NULL;                 // To check if created result a valid
2098   $keep = "";                   // save last failed parse string
2100   /* Check each parsed dn in ldap ? */
2101   if($config!=NULL && $verify_in_ldap){
2102     $ldap = $config->get_ldap_link();
2103   }
2105   /* Lets start */
2106   $called = false;
2107   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2109     $cnt ++;
2110     if(!preg_match("/,/",$dn)){
2111       $next = false;
2112     }
2113     $object = preg_replace("/[,].*$/","",$dn);
2114     $dn     = preg_replace("/^[^,]+,/","",$dn);
2116     $called = true;
2118     /* Check if current dn is valid */
2119     if($ldap!=NULL){
2120       $ldap->cd($dn);
2121       $ldap->cat($dn,array("dn"));
2122       if($ldap->count()){
2123         $ret[]  = $keep.$object;
2124         $keep   = "";
2125       }else{
2126         $keep  .= $object.",";
2127       }
2128     }else{
2129       $ret[]  = $keep.$object;
2130       $keep   = "";
2131     }
2132   }
2134   /* No dn was posted */
2135   if($cnt == 0 && !empty($dn)){
2136     $ret[] = $dn;
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   return($ret);
2149 function is_php4()
2151   if (isset($_SESSION['PHP4COMPATIBLE'])){
2152     return true;
2153   }
2154   return (preg_match('/^4/', phpversion()));
2157 /* Add "str_split" if this function is missing.
2158  * This function is only available in PHP5
2159  */
2160   if(!function_exists("str_split")){
2161     function str_split($str,$length =1)
2162     {
2163       if($length < 1 ) $length =1;
2165       $ret = array();
2166       for($i = 0 ; $i < strlen($str); $i = $i +$length){
2167         $ret[] = substr($str,$i ,$length);
2168       }
2169       return($ret);
2170     }
2171   }
2174 function get_base_from_hook($dn, $attrib)
2176   global $config;
2178   if (isset($config->current['BASE_HOOK'])){
2179     
2180     /* Call hook script - if present */
2181     $command= $config->current['BASE_HOOK'];
2183     if ($command != ""){
2184       $command.= " '$dn' $attrib";
2185       if (check_command($command)){
2186         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2187         exec($command, $output);
2188         if (preg_match("/^[0-9]+$/", $output[0])){
2189           return ($output[0]);
2190         } else {
2191           print_red(_("Warning - base_hook is not available. Using default base."));
2192           return ($config->current['UIDBASE']);
2193         }
2194       } else {
2195         print_red(_("Warning - base_hook is not available. Using default base."));
2196         return ($config->current['UIDBASE']);
2197       }
2199     } else {
2201       print_red(_("Warning - no base_hook defined. Using default base."));
2202       return ($config->current['UIDBASE']);
2204     }
2205   }
2208 /* Schema validation functions */
2210 function check_schema_version($class, $version)
2212   return preg_match("/\(v$version\)/", $class['DESC']);
2215 function check_schema($cfg,$rfc2307bis = FALSE)
2217   $messages= array();
2219   /* Get objectclasses */
2220   $ldap = new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']);
2221   $objectclasses = $ldap->get_objectclasses();
2222   if(count($objectclasses) == 0){
2223     print_red(_("Can't get schema information from server. No schema check possible!"));
2224   }
2226   /* This is the default block used for each entry.
2227    *  to avoid unset indexes.
2228    */
2229   $def_check = array("REQUIRED_VERSION" => "0",
2230       "SCHEMA_FILES"     => array(),
2231       "CLASSES_REQUIRED" => array(),
2232       "STATUS"           => FALSE,
2233       "IS_MUST_HAVE"     => FALSE,
2234       "MSG"              => "",
2235       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2237   /* The gosa base schema */
2238   $checks['gosaObject'] = $def_check;
2239   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2240   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2241   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2242   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2244   /* GOsa Account class */
2245   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2246   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2247   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2248   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2249   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2251   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2252   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2253   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2254   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2255   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2256   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2258   /* Some other checks */
2259   foreach(array(
2260         "gosaCacheEntry"        => array("version" => "2.4"),
2261         "gosaDepartment"        => array("version" => "2.4"),
2262         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2263         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2264         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2265         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2266         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2267         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2268         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2269         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2270         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2271         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2272         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2273         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2274         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2275         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2276         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2277         "goLdapServer"          => array("version" => "2.4"),
2278         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2279         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2280         "goKrbServer"           => array("version" => "2.4"),
2281         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2282         ) as $name => $values){
2284           $checks[$name] = $def_check;
2285           if(isset($values['version'])){
2286             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2287           }
2288           if(isset($values['file'])){
2289             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2290           }
2291           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2292         }
2293   foreach($checks as $name => $value){
2294     foreach($value['CLASSES_REQUIRED'] as $class){
2296       if(!isset($objectclasses[$name])){
2297         $checks[$name]['STATUS'] = FALSE;
2298         if($value['IS_MUST_HAVE']){
2299           $checks[$name]['MSG']    = sprintf(_("The required objectClass '%s' is not present in your schema setup"),$class);
2300         }else{
2301           $checks[$name]['MSG']    = sprintf(_("The optional objectClass '%s' is not present in your schema setup"),$class);
2302         }
2303       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2304         $checks[$name]['STATUS'] = FALSE;
2306         if($value['IS_MUST_HAVE']){
2307           $checks[$name]['MSG'] = sprintf(_("The required objectclass '%s' does not have version %s"), $class,                           $value['REQUIRED_VERSION']);
2308         }else{
2309           $checks[$name]['MSG'] = sprintf(_("The optional objectclass '%s' does not have version %s"), $class,                           $value['REQUIRED_VERSION']);
2310         }
2311       }else{
2312         $checks[$name]['STATUS'] = TRUE;
2313         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2314       }
2315     }
2316   }
2318   $tmp = $objectclasses;
2320   /* The gosa base schema */
2321   $checks['posixGroup'] = $def_check;
2322   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2323   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2324   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2325   $checks['posixGroup']['STATUS']           = TRUE;
2326   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2327   $checks['posixGroup']['MSG']              = "";
2328   $checks['posixGroup']['INFO']             = "";
2330   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2331   if(isset($tmp['posixGroup'])){
2333     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2334       $checks['posixGroup']['STATUS']           = FALSE;
2335       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2336       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2337     }
2338     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2339       $checks['posixGroup']['STATUS']           = FALSE;
2340       $checks['posixGroup']['MSG']              = _("You have disabled the rfc2307bis option on the 'ldap setup' step, but your schema   configuration do not support this option.");
2341       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2342     }
2343   }
2345   return($checks);
2348 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2349 ?>