Code

Fixed undefined index goExportEntry /gosa/include/class_config.inc 597
[gosa.git] / include / class_config.inc
1 <?php
2 /*
3  * This code is part of GOsa (https://gosa.gonicus.de)
4  * Copyright (C) 2003-2006 - Cajus Pollmeier <pollmeier@gonicus.de>
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 class config  {
23   /* XML parser */
24   var $parser;
25   var $config_found= FALSE;
26   var $tags= array();
27   var $level= 0;
28   var $gpc= 0;
29   var $section= "";
30   var $currentLocation= "";
32   /* Selected connection */
33   var $current= array();
35   /* Link to LDAP-server */
36   var $ldap= NULL;
37   var $referrals= array();
39   /* Configuration data */
40   var $data= array( 'TABS' => array(), 'LOCATIONS' => array(), 'SERVERS' => array(),
41       'MAIN' => array( 'LANGUAGES' => array(), 'FAXFORMATS' => array() ),
42       'MENU' => array(), 'SERVICE' => array());
43   var $basedir= "";
45   /* Keep a copy of the current deparment list */
46   var $departments= array();
47   var $idepartments= array();
49   function config($filename, $basedir= "")
50   {
51     $this->parser = xml_parser_create();
52     $this->basedir= $basedir;
54     xml_set_object($this->parser, $this);
55     xml_set_element_handler($this->parser, "tag_open", "tag_close");
57     /* Parse config file directly? */
58     if ($filename != ""){
59       $this->parse($filename);
60     }
61   }
63   function parse($filename)
64   { 
65     $fh= fopen($filename, "r"); 
66     $xmldata= fread($fh, 100000);
67     fclose($fh); 
68     if(!xml_parse($this->parser, chop($xmldata))){
69       print_red(sprintf(_("XML error in gosa.conf: %s at line %d"),
70             xml_error_string(xml_get_error_code($this->parser)),
71             xml_get_current_line_number($this->parser)));
72       echo $_SESSION['errors'];
73       exit;
74     }
75   }
77   function tag_open($parser, $tag, $attrs)
78   { 
79     /* Save last and current tag for reference */
80     $this->tags[$this->level]= $tag;
81     $this->level++;
83     /* Trigger on CONF section */
84     if ($tag == 'CONF'){
85       $this->config_found= TRUE;
86     }
88     /* Return if we're not in config section */
89     if (!$this->config_found){
90       return;
91     }
93     /* Look through attributes */
94     switch ($this->tags[$this->level-1]){
96       /* Handle tab section */
97       case 'TAB':       $name= $this->tags[$this->level-2];
99                   /* Create new array? */
100                   if (!isset($this->data['TABS'][$name])){
101                     $this->data['TABS'][$name]= array();
102                   }
104                   /* Add elements */
105                   $this->data['TABS'][$name][]= $attrs;
106                   break;
108                   /* Handle location */
109       case 'LOCATION':
110                   if ($this->tags[$this->level-2] == 'MAIN'){
111                     $name= $attrs['NAME'];
112                     $this->currentLocation= $name;
114                     /* Add location elements */
115                     $this->data['LOCATIONS'][$name]= $attrs;
116                   }
117                   break;
119                   /* Handle referral tags */
120       case 'REFERRAL':
121                   if ($this->tags[$this->level-2] == 'LOCATION'){
122                     $url= $attrs['URL'];
123                     $server= preg_replace('!^([^:]+://[^/]+)/.*$!', '\\1', $url);
125                     /* Add location elements */
126                     if (!isset($this->data['LOCATIONS'][$this->currentLocation]['REFERRAL'])){
127                       $this->data['LOCATIONS'][$this->currentLocation]['REFERRAL']= array();
128                     }
130                     $this->data['LOCATIONS'][$this->currentLocation]['REFERRAL'][$server]= $attrs;
131                   }
132                   break;
134                   /* Handle language */
135       case 'LANGUAGE':
136                   if ($this->tags[$this->level-2] == 'MAIN'){
137                     /* Add languages */
138                     $this->data['MAIN']['LANGUAGES'][$attrs['NAME']]= 
139                       $attrs['TAG'];
140                   }
141                   break;
143                   /* Handle faxformat */
144       case 'FAXFORMAT': 
145                   if ($this->tags[$this->level-2] == 'MAIN'){
146                     /* Add fax formats */
147                     $this->data['MAIN']['FAXFORMATS'][]= $attrs['TYPE'];
148                   }
149                   break;
151                   /* Load main parameters */
152       case 'MAIN':
153                   $this->data['MAIN']= array_merge ($this->data['MAIN'], $attrs);
154                   break;
156                   /* Load menu */
157       case 'SECTION':
158                   if ($this->tags[$this->level-2] == 'MENU'){
159                     $this->section= $attrs['NAME'];
160                     $this->data['MENU'][$this->section]= array(); ;
161                   }
162                   break;
164                   /* Inser plugins */
165       case 'PLUGIN':
166                   if ($this->tags[$this->level-3] == 'MENU' &&
167                       $this->tags[$this->level-2] == 'SECTION'){
169                     $this->data['MENU'][$this->section][$this->gpc++]= $attrs;
170                   }
171                   if ($this->tags[$this->level-2] == 'SERVICEMENU'){
172                     $this->data['SERVICE'][$attrs['CLASS']]= $attrs;
173                   }
174                   break;
175     }
176   }
178   function tag_close($parser, $tag)
179   {
180     /* Close config section */
181     if ($tag == 'CONF'){
182       $this->config_found= FALSE;
183     }
184     $this->level--;
185   }
187   function get_ldap_link($sizelimit= FALSE)
188   {
189     /* Build new connection */
190     $this->ldap= ldap_init ($this->current['SERVER'], $this->current['BASE'],
191         $this->current['ADMIN'], $this->current['PASSWORD']);
193     /* Check for connection */
194     if (is_null($this->ldap) || (is_int($this->ldap) && $this->ldap == 0)){
195       print_red (_("Can't bind to LDAP. Please contact the system administrator."));
196       echo $_SESSION['errors'];
197       exit;
198     }
200     if (!isset($_SESSION['size_limit'])){
201       $_SESSION['size_limit']= $this->current['SIZELIMIT'];
202       $_SESSION['size_ignore']= $this->current['SIZEIGNORE'];
203     }
205     if ($sizelimit){
206       $this->ldap->set_size_limit($_SESSION['size_limit']);
207     } else {
208       $this->ldap->set_size_limit(0);
209     }
211     /* Move referrals */
212     if (!isset($this->current['REFERRAL'])){
213       $this->ldap->referrals= array();
214     } else {
215       $this->ldap->referrals= $this->current['REFERRAL'];
216     }
218     return ($this->ldap);
219   }
221   function set_current($name)
222   {
223     $this->current= $this->data['LOCATIONS'][$name];
224     if (!isset($this->current['PEOPLE'])){
225       $this->current['PEOPLE']= "ou=people";
226     }
227     if (!isset($this->current['GROUPS'])){
228       $this->current['GROUPS']= "ou=groups";
229     }
230     if (!isset($this->current['WINSTATIONS'])){
231       $this->current['WINSTATIONS']= "ou=winstations,ou=systems";
232     }
233     if (!isset($this->current['HASH'])){
234       $this->current['HASH']= "crypt";
235     }
236     if (!isset($this->current['DNMODE'])){
237       $this->current['DNMODE']= "cn";
238     }
239     if (!isset($this->current['MINID'])){
240       $this->current['MINID']= 100;
241     }
242     if (!isset($this->current['SIZELIMIT'])){
243       $this->current['SIZELIMIT']= 200;
244     }
245     if (!isset($this->current['SIZEINGORE'])){
246       $this->current['SIZEIGNORE']= TRUE;
247     } else {
248       if (preg_match("/true/i", $this->current['SIZEIGNORE'])){
249         $this->current['SIZEIGNORE']= TRUE;
250       } else {
251         $this->current['SIZEIGNORE']= FALSE;
252       }
253     }
255     /* Sort referrals, if present */
256     if (isset ($this->current['REFERRAL'])){
257       $bases= array();
258       $servers= array();
259       foreach ($this->current['REFERRAL'] as $ref){
260         $server= preg_replace('%^(.*)/[^/]+$%', '\\1', $ref['URL']);
261         $base= preg_replace('%^.*/([^/]+)$%', '\\1', $ref['URL']);
262         $bases[$base]= strlen($base);
263         $servers[$base]= $server;
264       }
265       asort($bases);
266       reset($bases);
267     }
269     /* SERVER not defined? Load the one with the shortest base */
270     if (!isset($this->current['SERVER'])){
271       $this->current['SERVER']= $servers[key($bases)];
272     }
274     /* BASE not defined? Load the one with the shortest base */
275     if (!isset($this->current['BASE'])){
276       $this->current['BASE']= key($bases);
277     }
279     /* Convert BASE to have escaped special characters */
280     $this->current['BASE']= @LDAP::convert($this->current['BASE']);
282     /* Parse LDAP referral informations */
283     if (!isset($this->current['ADMIN']) || !isset($this->current['PASSWORD'])){
284       $url= $this->current['SERVER'];
285       $referral= $this->current['REFERRAL'][$url];
286       $this->current['ADMIN']= $referral['ADMIN'];
287       $this->current['PASSWORD']= $referral['PASSWORD'];
288     }
290     /* Load server informations */
291     $this->load_servers();
292   }
294   function load_servers ()
295   {
296     /* Only perform actions if current is set */
297     if ($this->current == NULL){
298       return;
299     }
301     /* Fill imap servers */
302     $ldap= $this->get_ldap_link();
303     $ldap->cd ($this->current['BASE']);
304     $ldap->search ("(objectClass=goImapServer)");
306     $this->data['SERVERS']['IMAP']= array();
307     error_reporting(0);
308     while ($attrs= $ldap->fetch()){
309       $name= $attrs['goImapName'][0];
310       $this->data['SERVERS']['IMAP'][$name]= array( "connect" => $attrs['goImapConnect'][0],
311           "admin" => $attrs['goImapAdmin'][0],
312           "password" => $attrs['goImapPassword'][0],
313           "sieve_server" => $attrs['goImapSieveServer'][0],
314           "sieve_port" => $attrs['goImapSievePort'][0]);
315     }
316     error_reporting(E_ALL);
318     /* Get kerberos server. FIXME: only one is supported currently */
319     $ldap->cd ($this->current['BASE']);
320     $ldap->search ("(objectClass=goKrbServer)");
321     if ($ldap->count()){
322       $attrs= $ldap->fetch();
323       $this->data['SERVERS']['KERBEROS']= array( 'SERVER' => $attrs['cn'][0],
324           'REALM' => $attrs['goKrbRealm'][0],
325           'ADMIN' => $attrs['goKrbAdmin'][0],
326           'PASSWORD' => $attrs['goKrbPassword'][0]);
327     }
329     /* Get cups server. FIXME: only one is supported currently */
330     $ldap->cd ($this->current['BASE']);
331     $ldap->search ("(objectClass=goCupsServer)");
332     if ($ldap->count()){
333       $attrs= $ldap->fetch();
334       $this->data['SERVERS']['CUPS']= $attrs['cn'][0];  
335     }
337     /* Get fax server. FIXME: only one is supported currently */
338     $ldap->cd ($this->current['BASE']);
339     $ldap->search ("(objectClass=goFaxServer)");
340     if ($ldap->count()){
341       $attrs= $ldap->fetch();
342       $this->data['SERVERS']['FAX']= array( 'SERVER' => $attrs['cn'][0],
343           'LOGIN' => $attrs['goFaxAdmin'][0],
344           'PASSWORD' => $attrs['goFaxPassword'][0]);
345     }
347     /* Get asterisk servers */
348     $ldap->cd ($this->current['BASE']);
349     $ldap->search ("(objectClass=goFonServer)");
350     if ($ldap->count()){
351       $attrs= $ldap->fetch();
352       $this->data['SERVERS']['FON']= array( 
353           'SERVER'      => $attrs['cn'][0],
354           'LOGIN'       => $attrs['goFonAdmin'][0],
355           'PASSWORD'    => $attrs['goFonPassword'][0],
356           'DB'          => "gophone",
357           'SIP_TABLE'           => "sip_users",
358           'EXT_TABLE'   => "extensions",
359           'VOICE_TABLE' => "voicemail_users",
360           'QUEUE_TABLE' => "queues",
361           'QUEUE_MEMBER_TABLE'  => "queue_members");
362     }
364     /* Get asterisk servers */
365     $ldap->cd ($this->current['BASE']);
366     $ldap->search ("(objectClass=goGlpiServer)");
367     if ($ldap->count()){
368       $attrs= $ldap->fetch();
369       $this->data['SERVERS']['GLPI']= array( 
370           'SERVER'      => $attrs['cn'][0],
371           'LOGIN'       => $attrs['goGlpiAdmin'][0],
372           'PASSWORD'    => $attrs['goGlpiPassword'][0],
373           'DB'          => $attrs['goGlpiDatabase'][0]);
374     }
375     /* Get logdb server */
376     $ldap->cd ($this->current['BASE']);
377     $ldap->search ("(objectClass=goLogDBServer)");
378     if ($ldap->count()){
379       $attrs= $ldap->fetch();
380       $this->data['SERVERS']['LOG']= array( 'SERVER' => $attrs['cn'][0],
381           'LOGIN' => $attrs['goLogAdmin'][0],
382           'PASSWORD' => $attrs['goLogPassword'][0]);
383     }
385     /* Get NFS server lists */
386     $tmp= array("default");
387     $ldap->cd ($this->current['BASE']);
388     $ldap->search ("(&(objectClass=goShareServer)(goExportEntry=*))");
389     while ($attrs= $ldap->fetch()){
390       for ($i= 0; $i<$attrs["goExportEntry"]["count"]; $i++){
391         $path= preg_replace ("/\s.*$/", "", $attrs["goExportEntry"][$i]);
392         $tmp[]= $attrs["cn"][0].":$path";
393       }
394     }
395     $this->data['SERVERS']['NFS']= $tmp;
398     /* Load Terminalservers */
399     $ldap->cd ($this->current['BASE']);
400     $ldap->search ("(objectClass=goTerminalServer)");
401     $this->data['SERVERS']['TERMINAL']= array();
402     $this->data['SERVERS']['TERMINAL'][]= "default";
404     $this->data['SERVERS']['FONT']= array();
405     $this->data['SERVERS']['FONT'][]= "default";
406     while ($attrs= $ldap->fetch()){
407       $this->data['SERVERS']['TERMINAL'][]= $attrs["cn"][0];
408       for ($i= 0; $i<$attrs["goFontPath"]["count"]; $i++){
409         $this->data['SERVERS']['FONT'][]= $attrs["goFontPath"][$i];
410       }
411     }
413     /* Ldap Server */
414     $this->data['SERVERS']['LDAP']= array("default");
415     $ldap->cd ($this->current['BASE']);
416     $ldap->search ("(objectClass=goLdapServer)");
417     while ($attrs= $ldap->fetch()){
418       if (isset($attrs["goLdapBase"])){
419         for ($i= 0; $i<$attrs["goLdapBase"]["count"]; $i++){
420           $this->data['SERVERS']['LDAP'][]= $attrs["cn"][0].":".$attrs["goLdapBase"][$i];
421         }
422       }
423     }
425     /* Get misc server lists */
426     $this->data['SERVERS']['SYSLOG']= array("default");
427     $this->data['SERVERS']['NTP']= array("default");
428     $ldap->cd ($this->current['BASE']);
429     $ldap->search ("(objectClass=goNtpServer)");
430     while ($attrs= $ldap->fetch()){
431       $this->data['SERVERS']['NTP'][]= $attrs["cn"][0];
432     }
433     $ldap->cd ($this->current['BASE']);
434     $ldap->search ("(objectClass=goSyslogServer)");
435     while ($attrs= $ldap->fetch()){
436       $this->data['SERVERS']['SYSLOG'][]= $attrs["cn"][0];
437     }
439     /* Get samba servers from LDAP, in case of samba3 */
440     if ($this->current['SAMBAVERSION'] == 3){
441       $this->data['SERVERS']['SAMBA']= array();
442       $ldap->cd ($this->current['BASE']);
443       $ldap->search ("(objectClass=sambaDomain)");
444       while ($attrs= $ldap->fetch()){
445         $this->data['SERVERS']['SAMBA'][$attrs['sambaDomainName'][0]]= array(
446             "SID" => $attrs["sambaSID"][0],
447             "RIDBASE" => $attrs["sambaAlgorithmicRidBase"][0]);
448       }
450       /* If no samba servers are found, look for configured sid/ridbase */
451       if (count($this->data['SERVERS']['SAMBA']) == 0){
452         if (!isset($this->current["SID"]) || !isset($this->current["RIDBASE"])){
453           print_red(_("SID and/or RIDBASE missing in your configuration!"));
454           echo $_SESSION['errors'];
455           exit;
456         } else {
457           $this->data['SERVERS']['SAMBA']['DEFAULT']= array(
458               "SID" => $this->current["SID"],
459               "RIDBASE" => $this->current["RIDBASE"]);
460         }
461       }
462     }
463   }
465   function make_idepartments($max_size= 28)
466   {
467     global $config;
468     $base = $config->current['BASE'];
470     $arr = array();
472     $this->idepartments= array();
474     /* Create multidimensional array, with all departments. */
475     foreach ($this->departments as $key => $val){
477       /* remove base from dn */
478       $val2 = str_replace($base,"",$val);
480       /* Get every single ou */
481       $str = preg_replace("/ou=/","|ou=",$val2);        
482       $elements = array_reverse(split("\|",$str));              
484       /* Save last array position */
485       $last = &$arr;
487       /* Get array depth  */
488       $cnt = count($elements);
490       /* Add last ou element of current dn to our array */
491       foreach($elements as $key => $ele){
493         /* skip enpty */
494         if(empty($ele)) continue;
496         /* Extract department name */           
497         $elestr = preg_replace("/^ou=/","", $ele);
498         $elestr = preg_replace("/,$/","",$elestr);      
500         /* Add to array */      
501         if($key == ($cnt-2)){
502           $last[$elestr]['ENTRY'] = $val;
503         }
505         /* Set next array appending position */
506         $last = &$last[$elestr]['SUB'];
507       }
508     }
510     /* Add base entry */
511     $ret["/"]["ENTRY"]  = $base;
512     $ret["/"]["SUB"]    = $arr;
514     $this->idepartments= $this->generateDepartmentArray($ret,-1,$max_size);
515   }
518   /* Creates display friendly output from make_idepartments */
519   function generateDepartmentArray($arr,$depth = -1,$max_size){
520     $ret = array();
521     $depth ++;
523     /* Walk through array */    
524     foreach($arr as $name => $entries){
526       /* If this department is the last in the current tree position 
527        * remove it, to avoid generating output for it */
528       if(count($entries['SUB'])==0){
529         unset($entries['SUB']);
530       }
532       /* Fix name, if it contains a replace tag */
533       $name= @LDAP::fix($name);
535       /* Check if current name is too long, then cut it */
536       if(mb_strlen($name, 'UTF-8')> $max_size){
537         $name = mb_substr($name,0,($max_size-3), 'UTF-8')." ...";
538       }
540       /* Append the name to the list */ 
541       if(isset($entries['ENTRY'])){
542         $a = "";
543         for($i = 0 ; $i < $depth ; $i ++){
544           $a.="&nbsp;";
545         }
546         $ret[$entries['ENTRY']]=$a."&nbsp;".$name;
547       } 
549       /* recursive add of subdepartments */
550       if(isset($entries['SUB'])){
551         $ret = array_merge($ret,$this->generateDepartmentArray($entries['SUB'],$depth,$max_size));
552       }
553     }
555     return($ret);
556   }
558   /* This function returns all available Shares defined in this ldap
559    * There are two ways to call this function, if listboxEntry is true
560    *  only name and path are attached to the array, in it is false, the whole
561    *  entry will be parsed an atached to the result.
562    */
563   function getShareList($listboxEntry = false)
564   {
565     $ldap= $this->get_ldap_link();
566     $a_res = $ldap->search("(objectClass=goShareServer)",array("goExportEntry","cn"));
567     $return= array();
568     while($entry = $ldap->fetch($a_res)){
569       if(isset($entry['goExportEntry']['count'])){
570         unset($entry['goExportEntry']['count']);
571       }
572       foreach($entry['goExportEntry'] as $export){
573         $shareAttrs = split("\|",$export);
574         if($listboxEntry) {
575           $return[$shareAttrs[0]."|".$entry['cn'][0]] = $shareAttrs[0]." - ".$entry['cn'][0];
576         }else{
577           $return[$shareAttrs[0]."|".$entry['cn'][0]]['server']       = $entry['cn'][0];
578           $return[$shareAttrs[0]."|".$entry['cn'][0]]['name']         = $shareAttrs[0];
579           $return[$shareAttrs[0]."|".$entry['cn'][0]]['description']  = $shareAttrs[1];
580           $return[$shareAttrs[0]."|".$entry['cn'][0]]['type']         = $shareAttrs[2];
581           $return[$shareAttrs[0]."|".$entry['cn'][0]]['charset']      = $shareAttrs[3];
582           $return[$shareAttrs[0]."|".$entry['cn'][0]]['path']         = $shareAttrs[4];
583           $return[$shareAttrs[0]."|".$entry['cn'][0]]['option']       = $shareAttrs[5];
584         }
585       }
586     }
587     return($return);
588   }
590   /* This function returns all available ShareServer */
591   function getShareServerList()
592   {
593     $ldap= $this->get_ldap_link();
594     $a_res = $ldap->search("(objectClass=goShareServer)",array("goExportEntry","cn"));
595     $return= array();
596     while($entry = $ldap->fetch($a_res)){
597       if(isset($entry['goExportEntry']['count'])){
598         unset($entry['goExportEntry']['count']);
599       }
600       foreach($entry['goExportEntry'] as $share){
601         $a_share = split("\|",$share);
602         $sharename = $a_share[0];
603         $return[$entry['cn'][0]."|".$sharename] = $entry['cn'][0]." [".$sharename."]";
604       }
605     }
606     return($return);
607   }
609   /* Check if there's the specified bool value set in the configuration */
610   function boolValueIsTrue($section, $value)
611   {
612     $section= strtoupper($section);
613     $value= strtoupper($value);
614     if (isset($this->data[$section][$value])){
615     
616       $data= $this->data[$section][$value];
617       if (preg_match("/^true$/i", $data) || preg_match("/yes/i", $data)){
618         return TRUE;
619       }
621     }
623     return FALSE;
624   }
628 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
629 ?>