Code

d7d43acf769ce3f150001bb686689234a61f87f4
[gosa.git] / plugins / admin / systems / class_termDNS.inc
1 <?php
3 class termDNS extends plugin
4 {
5   /* CLI vars */
6   var $cli_summary= "Manage server basic objects";
7   var $cli_description= "Some longer text\nfor help";
8   var $cli_parameters= array("eins" => "Eins ist toll", "zwei" => "Zwei ist noch besser");
10   /* attribute list for save action */
11   var $ignore_account= TRUE;
12   var $DNSattributes   = array("dNSClass","zoneName","dNSTTL");
13   var $attributes= array("ipHostNumber","macAddress");
14   var $objectclasses= array("whatever");
16   var $ipHostNumber ="";    // IP address 
17   var $macAddress   ="";    // Mac address 
18   var $cn           ="";    // CN of currently edited device 
20   var $Zones      = array();      // All Available Zones like array("3.2.1"=>"MyServer.de")
21   var $RecordTypes= array();      // Possible record types 
22     
23   var $dNSClass   = "IN";         // dNSClass name 
24   var $zoneName   = "";           // Used ZoneName 
25   var $dNSTTL     = 7200;         // TTL settings for the created entries 
27   /* Used records */
28   var $types = array();
29   var $DNSinitially_was_account = false;
31   var $orig_dn     ="";
33   var $IPisMust = false;
34   var $MACisMust= false;
36   var $found = false;
38   function termDNS ($config, $dn,$objectClasses,$IPisMust = false)
39   {
40     /* We need to know which objectClasses are used, to store the ip/mac*/
41     $this->objectclasses= $objectClasses;
42     plugin::plugin ($config, $dn);
44     $this->orig_dn= $dn;
45  
46     $this->IPisMust = $IPisMust;
48     /* Hide all dns specific code, if dns is not available 
49      */
50     $found = false;
51     foreach($this->config->data['TABS']['SERVTABS'] as $tab){
52       if(preg_match("/^servdns$/",$tab['CLASS'])){
53         $found = true;
54       }
55     }
56     $this->found = $found;
57     if(!$this->found){
58       $this->DNS_is_account = false;
59       return;
60     }
62  
63     /* All types with required attrs */
64     $this->RecordTypes['aRecord']       = "aRecord";           // ok
65     $this->RecordTypes['mDRecord']      = "mDRecord";          // ok
66     $this->RecordTypes['mXRecord']      = "mXRecord";          // ok
67     $this->RecordTypes['nSRecord']      = "nSRecord";          // ok 
68     $this->RecordTypes['pTRRecord']     = "relativeDomainName";// ok
69     $this->RecordTypes['hInfoRecord']   = "hInfoRecord";       // ok
70     $this->RecordTypes['mInfoRecord']   = "mInfoRecord";       // ok
71     $this->RecordTypes['cNAMERecord']   = "relativeDomainName";// ok
72     $this->RecordTypes['tXTRecord']     = "tXTRecord";         // ok
73     $this->RecordTypes['aFSDBRecord']   = "aFSDBRecord";       // ok
74     $this->RecordTypes['SigRecord']     = "SigRecord";         // ok
75     $this->RecordTypes['KeyRecord']     = "KeyRecord";         // ok 
76     $this->RecordTypes['aAAARecord']    = "aAAARecord";        // ok
77     $this->RecordTypes['LocRecord']     = "LocRecord";         // ok 
78     $this->RecordTypes['nXTRecord']     = "nXTRecord";         // ok
79     $this->RecordTypes['sRVRecord']     = "sRVRecord";         // ok
80     $this->RecordTypes['nAPTRRecord']   = "nAPTRRecord";       // ok
81     $this->RecordTypes['kXRecord']      = "kXRecord";          // ok
82     $this->RecordTypes['certRecord']    = "certRecord";        // ok
83     $this->RecordTypes['a6Record']      = "a6Record";          // ok
84     $this->RecordTypes['dSRecord']      = "dSRecord";          // ok
85     $this->RecordTypes['sSHFPRecord']   = "sSHFPRecord";       // ok
86     $this->RecordTypes['rRSIGRecord']   = "rRSIGRecord";       // ok
87     $this->RecordTypes['nSECRecord']    = "nSECRecord";        // ok 
89     /* Get all available zones */
90     if(empty($this->cn)&&(isset($this->attrs['cn'][0]))){ 
91       $this->cn = $this->attrs['cn'][0];
92     }
93     $this->Zones = $this->get_Zones();
94     $types = array();
96     /* Get all records */
97     $ldap = $this->config->get_ldap_link();
98     $ldap->cd($this->dn); 
99     $ldap->ls("(&(objectClass=dNSZone)(zoneName=*)(!(relativeDomainName=@)))",$this->dn,array("*"));
101     $found = false;
103     while($attrs = $ldap->fetch()){
104       /* If relative domainname == cn 
105        * Try to read dnsclass / TTl / zone 
106        */
108       if($attrs['relativeDomainName'][0] == $this->cn){
109         /* Get class */
110         if(isset($attrs['dNSClass'][0])){
111           $this->dNSClass = $attrs['dNSClass'][0];
112           $found  = true;
113         }
114         /* Get Zone*/
115         if(isset($attrs['zoneName'][0])){
116           $this->zoneName = $attrs['zoneName'][0];
117           $found  = true;
118         }
119         /* Get ttl */
120         if(isset($attrs['dNSTTL'][0])){
121           $this->dNSTTL   = $attrs['dNSTTL'][0];
122           $found  = true;
123         }
124       }
126       /* Create list with all used records */
127       foreach($this->RecordTypes as $name => $value){
128     
129         /* If there is a record attribute  */
130         if(isset($attrs[$name])){
131   
132  
133           /* get all entries */
134           for($i = 0 ; $i < $attrs[$value]['count']; $i ++){
135             if(($value == "aRecord")&&($this->ipHostNumber==$attrs[$value][$i])){
136              continue; 
137             }
138             $types[] =array("type"=>$name,"inittype"=>$name,"value"=>$attrs[$value][$i],"status"=>"edited","dn"=>$attrs['dn']);
139           }
140         }
141       }
142     }
144     /* If there is at least one entry in this -> types, we have DNS enabled */
145     $this->types = $types;
146     if((count($this->types) == 0) &&($found == false)){
147       $this->DNS_is_account = false;
148     }else{
149       $this->DNS_is_account = true;
150     }
151     
152     /* Store initally account settings */
153     $this->DNSinitially_was_account = $this->DNS_is_account;
154   }
156   function execute()
157   {
158           /* Call parent execute */
159     $smarty= get_smarty();
160     $display= "";
162     $smarty->assign("staticAddress", ""); 
163  
164     /* There is no dns available 
165      */
166     if($this->found == false){
167         
168       $smarty->assign("DNS_is_account",false);  
169       $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
170     
171       /* Assign smarty all non DNs attributes */
172       foreach($this->attributes as $attr){
173         $smarty->assign($attr,$this->$attr);
174       }
175       $smarty->assign("staticAddress", "");
176       $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
177       return($display);
178     }else{
179       $smarty->assign("DNS_is_account",true); 
180     }
181  
182     /* Add new empty array with status new, to our record list */
183     if(isset($_POST['AddNewRecord'])){
184       $this->types[]  =array("type"=>"aRecord","value"=>"","status"=>"new");
185     }
186    
187     /* Handle all posts */ 
188     $only_once =true;
189     foreach($_POST as $name => $value){
191       /* Check if we have to delete a record entry */
192       if((preg_match("/RemoveRecord_/",$name))&&($only_once)) {
193       
194         /* Avoid performing this once again */
195         $only_once = false;
197         /* Extract id for specified entry */
198         $id = preg_replace("/RemoveRecord_/","",$name);
199         $id = preg_replace("/_.*$/","",$id);
200     
201         /* Delete this record, mark edited entries to be able to delete them */
202         if(isset($this->types[$id])){
203           if($this->types[$id]['status'] == "edited"){
204             $this->types[$id]['status'] = "deleted";
205           }else{    
206             unset($this->types[$id]);
207           }
208         }
209       }
210     }
212     /* Assign smarty all non DNs attributes */
213     foreach($this->attributes as $attr){
214       $smarty->assign($attr,$this->$attr);
215     }
217     /* Assign smarty all DNS attributes */
218     foreach($this->DNSattributes as $attr){
219       $smarty->assign($attr,$this->$attr);
220     }
221     
222     /* Assign all needed vars */
223     $smarty->assign("DNSAccount",$this->DNS_is_account);
224     $smarty->assign("Zones",$this->Zones);
225     $smarty->assign("ZoneKeys",($this->Zones));
226     $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
227   
228     $tmp = $this->generateRecordsList();
229     $changeStateForRecords = $tmp['changeStateForRecords'];
230     $smarty->assign("records",$tmp['str']);
231     $smarty->assign("changeStateForRecords",$changeStateForRecords);
232     $smarty->assign("staticAddress","<font class=\"must\">*</font>");
233     $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
234     return($display);
235   }
237   function remove_from_parent()
238   {
239     $ldap = $this->config->get_ldap_link();
240     $ldap->cd($this->orig_dn);
241     $ldap->search("(&(objectClass=dNSZone)(zoneName=*)(!(relativeDomainName=@)))",array("relativeDomainName","zoneName"));
242     while($attr = $ldap->fetch()){  
243       $ldap->cd($attr['dn']);
244       $ldap->rmDir($attr['dn']);
245     }
246   }
248   /* Save data to object */
249   function save_object()
250   {
251     /* Save all posted vars */
252     plugin::save_object();
253     
254     /* Ge all non dns attributes (IP/MAC)*/
255     foreach($this->attributes as $attr){
256       if(isset($_POST[$attr])){
257         $this->$attr = $_POST[$attr];
258       }
259     }
261     /* Get dns attributes */
262     if(isset($_POST['network_tpl_posted'])){
264       /* Check for posted record changes */
265       foreach($this->types as $key => $value){
266       
267         /* Check if type has changed */
268         if(isset($_POST['RecordTypeSelectedFor_'.$key])){
269           $this->types[$key]['type'] = $_POST['RecordTypeSelectedFor_'.$key];
270         }
271         /* Check if value has changed */
272         if(isset($_POST['RecordValue_'.$key])){
273           $this->types[$key]['value'] = $_POST['RecordValue_'.$key];
274         }
275       }
276       
277       /* Get all basic DNS attributes (TTL, Clas ..)*/
278       foreach($this->DNSattributes as $attr){
279         if(isset($_POST[$attr])){
280           $this->$attr = $_POST[$attr];
281         }
282       }
284       /* Enable diable DNS */
285       if(isset($_POST['enableDNS'])){
286         $this->DNS_is_account = true;
287       }else{
288         $this->DNS_is_account = false;
289       }
290     }
291   }
294   /* Check supplied data */
295   function check()
296   {
297     $message= array();
299     
300     if(($this->IPisMust)||($this->DNS_is_account)){
301       /* Check if ip is empty */
302       if ($this->ipHostNumber == "" && chkacl ($this->acl, "ipHostNumber") == ""){
303         $message[]= _("The required field 'IP-address' is not set.");
304       }
306       /* check if given ip is valid ip*/
307       $num="(\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])";
308       if (!preg_match("/^$num\\.$num\\.$num\\.$num$/", $this->ipHostNumber)){
309         $message[]= _("Wrong IP format in field IP-address.");
310       }
311     }
313     /* Check if mac is empty */
314     if ($this->macAddress == "" && chkacl ($this->acl, "macAddress") == ""){
315       $message[]= _("The required field 'MAC-address' is not set.");
316     }
318     /* Check if given mac is valid mac */
319     $tr = count(split(":",$this->macAddress));
320     if($tr!=6){
321       $message[]=(_("The given macaddress is invalid. There must be 6 1byte segments seperated by ':'."));
322     }
324     /* only perfrom this checks if this is a valid DNS account */
325     if($this->DNS_is_account){
327       $checkArray = array();
328       $onlyOnce   = array();
329       $onlyOnce['cNAMERecord'] = 0;
330   
331       foreach($this->types as $name => $values){
333         if(!isset($checkArray[$values['type']][$values['value']])){
334           $checkArray[$values['type']][$values['value']] = 0;
335         }else{
336           $message[] = sprintf(_("Found duplicate value for record type '%s'."),$values['type']);
337         }
339         if(isset($onlyOnce[$values['type']])){
340           $onlyOnce[$values['type']] ++;
341           if($onlyOnce[$values['type']] > 1){
342             $message[] = sprintf(_("Found more than one entry for the uniqe record type '%s'."),$values['type']);
343           }
344         }
346         if($values['type'] == "tXTRecord") continue;
348         /* Check if there is an aRecord defined which uses the same IP as used in IPhostAddress */
349         if(($values['type'] == "aRecord")&&($values['value'] == $this->ipHostNumber)&&($values['status']!="deleted")){
350           $message[]=sprintf(_("The device IP '%s' is added as 'A Record', this will be done automatically, please remove the record."), 
351                $this->ipHostNumber);
352         }
354         /* only lower-case is allowed in record entries ... */
355         if($values['value'] != strtolower($values['value'])){
356           $message[] = sprintf(_("Only lowercase is allowed, please check your '%ss'."),$values['type']);
357         }
358       }
359     }
360     return ($message);
361   }
364   /* Save to LDAP */
365   function save($dn)
366   {
367     $ldap= $this->config->get_ldap_link();
368    
369     /*******************/ 
370     /* IP-MAC HANDLING */
371     /*******************/ 
373     /* $dn was posted as parameter */
374     $this->dn = $dn;
375     
376     /* Save DNS setting & ip/Mac*/
377     plugin::save();
379     /* Write back to ldap */
380     $ldap->cd($this->dn);
381     $this->cleanup();
382 $ldap->modify ($this->attrs); 
385     /****************/ 
386     /* DNS HANDLING */
387     /****************/ 
389     /* If isn't DNS account but initially was DNS account 
390        remove all DNS entries 
391      */ 
392     if(!$this->DNS_is_account){
393       if($this->DNSinitially_was_account){
394         $tmp = array();
396         $ldap->ls("(&(objectClass=dNSZone)(!(relativeDomainName=@)))",$this->dn,array("relativeDomainName"));
397         while($attrs = $ldap->fetch()){
398           $dn=$attrs['dn'];
399           $ldap->cd($dn);
400           $ldap->rmdir_recursive($dn);
401         }
402       }
403     }else{
404     
405       /* DNS is enabled, check what we have to do */
406       $delete = array();
407   
408       /* Generate a list of new ldap entries, 
409           & $delete contains all dns which should be deleted 
410        */
411       $tmp = $this->generate_LDAP_entries();      
413       $entries  = $tmp['entries'];
414       $delete   = $tmp['delete'];
416       /* Delete dns */
417       foreach($delete as $dn => $del){
418         $ldap->cd($dn);
419         $ldap->rmDir($dn);
420       }
422       /* Add || Update new DNS entries */
423       foreach($entries as $dn => $attrs){
424         $ldap->cd($dn);
425         $ldap->cat($dn);
426         
427         if(count($ldap->fetch())){
428           $ldap->cd($dn);
429 //          $this->cleanup();
430           $ldap->modify ($attrs); 
432         }else{
433           $ldap->cd($dn);
434           $ldap->add($attrs);
435         }
436       }
437     }
438     if($ldap->get_error() != "Success"){
439       show_ldap_error($ldap->get_error()); 
440     }
441     
442   }
444   /*  Create html table with all used record types
445    */
446   function generateRecordsList()
447   {
448     $changeStateForRecords = "";
449     
450     if(!$this->DNS_is_account) {
451       $str = "<input type='submit' value='"._("Add")."' name='AddNewRecord' id='AddNewRecord' disabled>";
452       return $str;
453     }
454  
455     $str = "<table summary='' width='100%'>";
456     foreach($this->types as $key => $entry){
457         if($entry['status'] == "deleted") continue;
459         $changeStateForRecords.= "changeState('RecordTypeSelectedFor_".$key."');\n";
460         $changeStateForRecords.= "changeState('RecordValue_".$key."');\n";
461         $changeStateForRecords.= "changeState('RemoveRecord_".$key."');\n";
463         $str.=" <tr>".
464           "   <td>".$this->generateRecordListBox($entry['type'],"RecordTypeSelectedFor_".$key)."</td>".
465           "   <td><input type='text' value='".$entry['value']."' name='RecordValue_".$key."' id='RecordValue_".$key."'></td>".
466           "   <td><input type='submit' name='RemoveRecord_".$key."' value='"._("Delete")."' id='RemoveRecord_".$key."'></td>".
467           "</tr>";
468     }
470     $str.= "  <tr>".
471            "    <td colspan=2 width='50%'></td><td>".
472            "      <input type='submit' value='"._("Add")."' name='AddNewRecord'>".
473            "    </td>".
474            "  </tr>".
475            "</table>";
476      $ret =  array("str" => $str, "changeStateForRecords" => $changeStateForRecords);
477     return($ret);
478   }
480   /* Create a html select box which allows us to select different types of records */
481   function generateRecordListBox($selected,$name)
482   {
483     $str = "<select name='".$name."' id='".$name."'>";
484     foreach($this->RecordTypes as $type => $value){
485       $use = "";
486       if($type == $selected){
487         $use = " selected ";
488       }
489       $str.="\n <option value='".$type."' ".$use.">".strtoupper(preg_replace("/record/i","",$type))."</option>";
490     }
491     $str.="</select>";
492     return($str); 
493   }
495   /* return all Zone names */
496   function get_Zones()
497   {
498     $ret = array();
499     $ldap = $this->config->get_ldap_link();
500     $ldap-> cd ($this->config->current['BASE']);
501     $ldap->search("(&(objectClass=dNSZone)(sOARecord=*))",array("*"));
502     
503     while($at = $ldap->fetch()){
504       if(preg_match("/\.in\-addr\.arpa/",$at['zoneName'][0])){
505         $name = preg_replace("/^zoneName=/","",$at['tXTRecord'][0]);
506         $ret[$name]['addr']= $at['zoneName'][0];
507       }else{
508         $name = $at['zoneName'][0];
509         $ret[$name]['name']= $at['zoneName'][0];
510       }
511     }
513     $tmp  =array();
514     foreach($ret as $name => $entry){
515       if((isset($entry['addr']))&&(isset($entry['name']))){
516         $tmp[$entry['addr']]=$entry['name'];
517       }
518     }
519     $ret = $tmp;
520     return($ret); 
521   } 
523   /* this is used to generate ldap friendly output of our 
524      dns configuration
525   */
526   function generate_LDAP_entries()
527   {
528     $entries = array();    
529     $delete  = array();
531     /* Generate Main Entry */
532     $dn = "relativeDomainName=".$this->cn.",".$this->dn;
533     $entries[$dn]['dNSClass']           = $this->dNSClass;      
534     $entries[$dn]['zoneName']           = $this->zoneName;      
535     $entries[$dn]['dNSTTL']             = $this->dNSTTL;      
536     $entries[$dn]['relativeDomainName'] = $this->cn;      
538     /* Generate cNAMERecord */
539     $aRecords = array();
540     foreach($this->types as $type){
541       if($type['type'] == "cNAMERecord"){
542           
543         $Cdn = "relativeDomainName=".$type['value'].",".$this->dn;
544         if($type['status']=="deleted"){
545           $delete [$type['dn']] = $Cdn;
546         }else{
547           $entries[$Cdn] = $entries[$dn];
548           $entries[$Cdn]['relativeDomainName']  = $type['value'];
549           $entries[$Cdn]['cNAMERecord']         = $this->cn.".".$this->zoneName;
550         }
551       }
552     }
554     /* Generate tXTRecord */
555     $aRecords = array();
556     foreach($this->types as $type){
557       if(($type['type'] == "tXTRecord")&&($type['status']!="deleted")){
558         $entries[$dn]['tXTRecord'][] = $type['value'];
559       }
560     }
562     /* Generate mDRecord */
563     $aRecords = array();
564     foreach($this->types as $type){
565       if(($type['type'] == "mDRecord")&&($type['status']!="deleted")){
566         $entries[$dn]['mDRecord'][] = $type['value'];
567       }
568     }
570     /* Generate mXRecord */
571     $aRecords = array();
572     foreach($this->types as $type){
573       if(($type['type'] == "mXRecord")&&($type['status']!="deleted")){
574         $entries[$dn]['mXRecord'][] = $type['value'];
575       }
576     }
577  
578     /* Generate hInfoRecord */
579     $aRecords = array();
580     foreach($this->types as $type){
581       if(($type['type'] == "hInfoRecord")&&($type['status']!="deleted")){
582         $entries[$dn]['hInfoRecord'][] = $type['value'];
583       }
584     }
586     /* Generate mInfoRecord */
587     $aRecords = array();
588     foreach($this->types as $type){
589       if(($type['type'] == "mInfoRecord")&&($type['status']!="deleted")){
590         $entries[$dn]['mInfoRecord'][] = $type['value'];
591       }
592     }
593  
594     /* Generate aFSDBRecord */
595     $aRecords = array();
596     foreach($this->types as $type){
597       if(($type['type'] == "aFSDBRecord")&&($type['status']!="deleted")){
598         $entries[$dn]['aFSDBRecord'][] = $type['value'];
599       }
600     }
601  
602     /* Generate some attrs  */
603     $arr = array("SigRecord","KeyRecord","aAAARecord","nSRecord",
604         "LocRecord","nXTRecord","sRVRecord","nAPTRRecord","kXRecord","certRecord","a6Record","dSRecord","sSHFPRecord","rRSIGRecord","nSECRecord");
605     $aRecords = array();
606     foreach($arr as $ar){
607       foreach($this->types as $type){
608         if(($type['type'] == $ar)&&($type['status']!="deleted")){
609           $entries[$dn][$ar][] = $type['value'];
610         }
611       }
612     }
613  
614  
615     /* Generate A Records (IP Address relation) */
616     $aRecords = array();
617     foreach($this->types as $type){
618       if(($type['type'] == "aRecord")&&($type['status']!="deleted")){
619         $aRecords[] = $type['value'];
620       }
621     }
622     if(count($aRecords)){
623       
624       /* Add ipHostNumber as default aRecord */
625       $aRecords[] = $this->ipHostNumber;
627       $dn = "relativeDomainName=".$this->cn.",".$this->dn;
628       foreach($aRecords as $rec){
629         $entries[$dn]['aRecord'][] = $rec;      
630       }
631     }
633     /* Generate pTRRecord Records */
634     foreach($this->types as $type){
635       if($type['type'] == "pTRRecord"){
636         $PTRdn= "relativeDomainName=".$type['value'].",".$this->dn;
637         if($type['status']=="deleted"){        
638           $delete [$type['dn']] = $PTRdn;
639         }else{
640           $zones = array_flip($this->Zones);
641           $zone = $zones[$this->zoneName];  
642           $entries[$PTRdn]['relativeDomainName'] = $type['value'];
643           $entries[$PTRdn]['pTRRecord']         = $this->cn.".".$this->zoneName;
644           $entries[$PTRdn]['zoneName']            =  $zone;
645         }
646       }
647     }
649     /* add ObjectClasses */
650     foreach($entries as $key => $entry ){
651       $entries[$key]['objectClass']=array("top","dNSZone");
652       $entries[$key] = array_reverse($entries[$key]);
653     }
655     /* Check if record type has changed, and if we need to delete this record attribute from ldap entry */
656     foreach($this->types as $type){
657       if(isset($type['inittype'])){
658         if(!isset($entries[$dn][$type['inittype']])){
659           $entries[$dn][$type['inittype']] = array();
660         }
661       }
662     }
664     $ret = array("entries"=> $entries,"delete"=>$delete);
665     return($ret); 
666   }
669 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
670 ?>