plugins/admin/systems/class_termDNS.inc

   1 <?php
   2
   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");
   9
  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");
  15
  16   var $ipHostNumber ="";    // IP address
  17   var $macAddress   ="";    // Mac address
  18   var $cn           ="";    // CN of currently edited device
  19
  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
  26
  27   /* Used records */
  28   var $types = array();
  29   var $DNSinitially_was_account = false;
  30
  31   var $orig_dn     ="";
  32
  33   var $IPisMust = false;
  34   var $MACisMust= false;
  35
  36   var $found = false;
  37
  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);
  43
  44     $this->orig_dn= $dn;
  45
  46     $this->IPisMust = $IPisMust;
  47
  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     }
  61
  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
  88
  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();
  95
  96     /* Get all records */
  97     $ldap = $this->config->get_ldap_link();
  98     $ldap->cd($this->dn);
  99     $ldap->search("(&(objectClass=dNSZone)(zoneName=*)(!(relativeDomainName=@)))",array("*"));
 100
 101     while($attrs = $ldap->fetch()){
 102       /* If relative domainname == cn
 103        * Try to read dnsclass / TTl / zone
 104        */
 105       if($attrs['relativeDomainName'][0] == $this->cn){
 106         /* Get class */
 107         if(isset($attrs['dNSClass'][0])){
 108           $this->dNSClass = $attrs['dNSClass'][0];
 109         }
 110         /* Get Zone*/
 111         if(isset($attrs['zoneName'][0])){
 112           $this->zoneName = $attrs['zoneName'][0];
 113         }
 114         /* Get ttl */
 115         if(isset($attrs['dNSTTL'][0])){
 116           $this->dNSTTL   = $attrs['dNSTTL'][0];
 117         }
 118       }
 119
 120       /* Create list with all used records */
 121       foreach($this->RecordTypes as $name => $value){
 122
 123         /* If there is a record attribute  */
 124         if(isset($attrs[$name])){
 125
 126
 127           /* get all entries */
 128           for($i = 0 ; $i < $attrs[$value]['count']; $i ++){
 129             if(($value == "aRecord")&&($this->ipHostNumber==$attrs[$value][$i])){
 130              continue;
 131             }
 132             $types[] =array("type"=>$name,"inittype"=>$name,"value"=>$attrs[$value][$i],"status"=>"edited","dn"=>$attrs['dn']);
 133           }
 134         }
 135       }
 136     }
 137
 138     /* If there is at least one entry in this -> types, we have DNS enabled */
 139     $this->types = $types;
 140     if(count($this->types) == 0){
 141       $this->DNS_is_account = false;
 142     }else{
 143       $this->DNS_is_account = true;
 144     }
 145
 146     /* Store initally account settings */
 147     $this->DNSinitially_was_account = $this->DNS_is_account;
 148   }
 149
 150   function execute()
 151   {
 152           /* Call parent execute */
 153     $smarty= get_smarty();
 154     $display= "";
 155
 156     $smarty->assign("staticAddress", "");
 157
 158     /* There is no dns available
 159      */
 160     if($this->found == false){
 161
 162       $smarty->assign("DNS_is_account",false);
 163       $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
 164
 165       /* Assign smarty all non DNs attributes */
 166       foreach($this->attributes as $attr){
 167         $smarty->assign($attr,$this->$attr);
 168       }
 169       $smarty->assign("staticAddress", "");
 170       $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
 171       return($display);
 172     }else{
 173       $smarty->assign("DNS_is_account",true);
 174     }
 175
 176     /* Add new empty array with status new, to our record list */
 177     if(isset($_POST['AddNewRecord'])){
 178       $this->types[]  =array("type"=>"aRecord","value"=>"","status"=>"new");
 179     }
 180
 181     /* Handle all posts */
 182     $only_once =true;
 183     foreach($_POST as $name => $value){
 184
 185       /* Check if we have to delete a record entry */
 186       if((preg_match("/RemoveRecord_/",$name))&&($only_once)) {
 187
 188         /* Avoid performing this once again */
 189         $only_once = false;
 190
 191         /* Extract id for specified entry */
 192         $id = preg_replace("/RemoveRecord_/","",$name);
 193         $id = preg_replace("/_.*$/","",$id);
 194
 195         /* Delete this record, mark edited entries to be able to delete them */
 196         if(isset($this->types[$id])){
 197           if($this->types[$id]['status'] == "edited"){
 198             $this->types[$id]['status'] = "deleted";
 199           }else{
 200             unset($this->types[$id]);
 201           }
 202         }
 203       }
 204     }
 205
 206     /* Assign smarty all non DNs attributes */
 207     foreach($this->attributes as $attr){
 208       $smarty->assign($attr,$this->$attr);
 209     }
 210
 211     /* Assign smarty all DNS attributes */
 212     foreach($this->DNSattributes as $attr){
 213       $smarty->assign($attr,$this->$attr);
 214     }
 215
 216     /* Assign all needed vars */
 217     $smarty->assign("DNSAccount",$this->DNS_is_account);
 218     $smarty->assign("Zones",$this->Zones);
 219     $smarty->assign("ZoneKeys",($this->Zones));
 220     $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
 221     $changeStateForRecords ="";
 222     $smarty->assign("records",$this->generateRecordsList(&$changeStateForRecords));
 223     $smarty->assign("changeStateForRecords",$changeStateForRecords);
 224 //    $smarty->assign("dNSClasses",array("IN"=>"IN"));
 225     $smarty->assign("staticAddress","<font class=\"must\">*</font>");
 226     $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
 227     return($display);
 228   }
 229
 230   function remove_from_parent()
 231   {
 232     $ldap = $this->config->get_ldap_link();
 233     $ldap->cd($this->orig_dn);
 234     $ldap->search("(&(objectClass=dNSZone)(zoneName=*)(!(relativeDomainName=@)))",array("relativeDomainName","zoneName"));
 235     while($attr = $ldap->fetch()){
 236       $ldap->cd($attr['dn']);
 237       $ldap->rmDir($attr['dn']);
 238     }
 239   }
 240
 241   /* Save data to object */
 242   function save_object()
 243   {
 244     /* Save all posted vars */
 245     plugin::save_object();
 246
 247     /* Ge all non dns attributes (IP/MAC)*/
 248     foreach($this->attributes as $attr){
 249       if(isset($_POST[$attr])){
 250         $this->$attr = $_POST[$attr];
 251       }
 252     }
 253
 254     /* Get dns attributes */
 255     if(isset($_POST['network_tpl_posted'])){
 256
 257       /* Check for posted record changes */
 258       foreach($this->types as $key => $value){
 259
 260         /* Check if type has changed */
 261         if(isset($_POST['RecordTypeSelectedFor_'.$key])){
 262           $this->types[$key]['type'] = $_POST['RecordTypeSelectedFor_'.$key];
 263         }
 264         /* Check if value has changed */
 265         if(isset($_POST['RecordValue_'.$key])){
 266           $this->types[$key]['value'] = $_POST['RecordValue_'.$key];
 267         }
 268       }
 269
 270       /* Get all basic DNS attributes (TTL, Clas ..)*/
 271       foreach($this->DNSattributes as $attr){
 272         if(isset($_POST[$attr])){
 273           $this->$attr = $_POST[$attr];
 274         }
 275       }
 276
 277       /* Enable diable DNS */
 278       if(isset($_POST['enableDNS'])){
 279         $this->DNS_is_account = true;
 280       }else{
 281         $this->DNS_is_account = false;
 282       }
 283     }
 284   }
 285
 286
 287   /* Check supplied data */
 288   function check()
 289   {
 290     $message= array();
 291
 292
 293     if(($this->IPisMust)||($this->DNS_is_account)){
 294       /* Check if ip is empty */
 295       if ($this->ipHostNumber == "" && chkacl ($this->acl, "ipHostNumber") == ""){
 296         $message[]= _("The required field 'IP-address' is not set.");
 297       }
 298
 299       /* check if given ip is valid ip*/
 300       $num="(\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])";
 301       if (!preg_match("/^$num\\.$num\\.$num\\.$num$/", $this->ipHostNumber)){
 302         $message[]= _("Wrong IP format in field IP-address.");
 303       }
 304     }
 305
 306     /* Check if mac is empty */
 307     if ($this->macAddress == "" && chkacl ($this->acl, "macAddress") == ""){
 308       $message[]= _("The required field 'MAC-address' is not set.");
 309     }
 310
 311     /* Check if given mac is valid mac */
 312     $tr = count(split(":",$this->macAddress));
 313     if($tr!=6){
 314       $message[]=(_("The given macaddress is invalid. There must be 6 1byte segments seperated by ':'."));
 315     }
 316
 317     /* only perfrom this checks if this is a valid DNS account */
 318     if($this->DNS_is_account){
 319       foreach($this->types as $name => $values){
 320
 321         /* Check if there is an aRecord defined which uses the same IP as used in IPhostAddress */
 322         if(($values['type'] == "aRecord")&&($values['value'] == $this->ipHostNumber)&&($values['status']!="deleted")){
 323           $message[]=sprintf(_("The device IP '%s' is added as 'A Record', this will be done automatically, please remove the record."),
 324                $this->ipHostNumber);
 325         }
 326
 327         /* only lower-case is allowed in record entries ... */
 328         if($values['value'] != strtolower($values['value'])){
 329           $message[] = sprintf(_("Only lowercase is allowed, please check your '%ss'."),$values['type']);
 330         }
 331       }
 332     }
 333
 334     return ($message);
 335   }
 336
 337
 338   /* Save to LDAP */
 339   function save($dn)
 340   {
 341     $ldap= $this->config->get_ldap_link();
 342
 343     /*******************/
 344     /* IP-MAC HANDLING */
 345     /*******************/
 346
 347     /* $dn was posted as parameter */
 348     $this->dn = $dn;
 349
 350     /* Save DNS setting & ip/Mac*/
 351     plugin::save();
 352
 353     /* Write back to ldap */
 354     $ldap->cd($this->dn);
 355     $this->cleanup();
 356 $ldap->modify ($this->attrs);
 357
 358
 359     /****************/
 360     /* DNS HANDLING */
 361     /****************/
 362
 363     /* If isn't DNS account but initially was DNS account
 364        remove all DNS entries
 365      */
 366     if(!$this->DNS_is_account){
 367       if($this->DNSinitially_was_account){
 368         $tmp = array();
 369         foreach($this->types as $type){
 370           $dn = $type['dn'];
 371           if(!isset($tmp[$dn])) {
 372             $ldap->cd($dn);
 373             $ldap->rmDir($dn);
 374           }
 375           $tmp[$dn]=$dn;
 376         }
 377       }
 378     }else{
 379
 380       /* DNS is enabled, check what we have to do */
 381       $delete = array();
 382
 383       /* Generate a list of new ldap entries,
 384           & $delete contains all dns which should be deleted
 385        */
 386       $entries = $this->generate_LDAP_entries(&$delete);
 387
 388       /* Delete dns */
 389       foreach($delete as $dn => $del){
 390         $ldap->cd($dn);
 391         $ldap->rmDir($dn);
 392       }
 393
 394       /* Add || Update new DNS entries */
 395       foreach($entries as $dn => $attrs){
 396         $ldap->cd($dn);
 397         $ldap->cat($dn);
 398
 399         if(count($ldap->fetch())){
 400           $ldap->cd($dn);
 401 //          $this->cleanup();
 402           $ldap->modify ($attrs);
 403
 404         }else{
 405           $ldap->cd($dn);
 406           $ldap->add($attrs);
 407         }
 408       }
 409     }
 410     if($ldap->get_error() != "Success"){
 411       show_ldap_error($ldap->get_error());
 412     }
 413
 414   }
 415
 416   /*  Create html table with all used record types
 417    */
 418   function generateRecordsList($changeStateForRecords)
 419   {
 420     $changeStateForRecords = "";
 421
 422     if(!$this->DNS_is_account) {
 423       $str = "<input type='submit' value='"._("Add")."' name='AddNewRecord' id='AddNewRecord' disabled>";
 424       return $str;
 425     }
 426
 427     $str = "<table summary='' width='100%'>";
 428     foreach($this->types as $key => $entry){
 429         if($entry['status'] == "deleted") continue;
 430
 431         $changeStateForRecords.= "changeState('RecordTypeSelectedFor_".$key."');\n";
 432         $changeStateForRecords.= "changeState('RecordValue_".$key."');\n";
 433         $changeStateForRecords.= "changeState('RemoveRecord_".$key."');\n";
 434
 435         $str.=" <tr>".
 436           "   <td>".$this->generateRecordListBox($entry['type'],"RecordTypeSelectedFor_".$key)."</td>".
 437           "   <td><input type='text' value='".$entry['value']."' name='RecordValue_".$key."' id='RecordValue_".$key."'></td>".
 438           "   <td><input type='submit' name='RemoveRecord_".$key."' value='"._("Delete")."' id='RemoveRecord_".$key."'></td>".
 439           "</tr>";
 440     }
 441
 442     $str.= "  <tr>".
 443            "    <td colspan=2 width='50%'></td><td>".
 444            "      <input type='submit' value='"._("Add")."' name='AddNewRecord'>".
 445            "    </td>".
 446            "  </tr>".
 447            "</table>";
 448     return($str);
 449   }
 450
 451   /* Create a html select box which allows us to select different types of records */
 452   function generateRecordListBox($selected,$name)
 453   {
 454     $str = "<select name='".$name."' id='".$name."'>";
 455     foreach($this->RecordTypes as $type => $value){
 456       $use = "";
 457       if($type == $selected){
 458         $use = " selected ";
 459       }
 460       $str.="\n <option value='".$type."' ".$use.">".strtoupper(preg_replace("/record/i","",$type))."</option>";
 461     }
 462     $str.="</select>";
 463     return($str);
 464   }
 465
 466   /* return all Zone names */
 467   function get_Zones()
 468   {
 469     $ret = array();
 470     $ldap = $this->config->get_ldap_link();
 471     $ldap-> cd ($this->config->current['BASE']);
 472     $ldap->search("(&(objectClass=dNSZone)(sOARecord=*))",array("*"));
 473
 474     while($at = $ldap->fetch()){
 475       if(preg_match("/\.in\-addr\.arpa/",$at['zoneName'][0])){
 476         $ret[$at['relativeDomainName'][0]]['addr']= $at['zoneName'][0];
 477       }else{
 478         $ret[$at['relativeDomainName'][0]]['name']= $at['zoneName'][0];
 479       }
 480     }
 481
 482     $tmp  =array();
 483     foreach($ret as $name => $entry){
 484       if((isset($entry['addr']))&&(isset($entry['name']))){
 485         $tmp[$entry['addr']]=$entry['name'];
 486       }
 487     }
 488     $ret = $tmp;
 489     return($ret);
 490   }
 491
 492   /* this is used to generate ldap friendly output of our
 493      dns configuration
 494   */
 495   function generate_LDAP_entries($delete)
 496   {
 497     $entries = array();
 498     $delete  = array();
 499
 500     /* Generate Main Entry */
 501     $dn = "relativeDomainName=".$this->cn.",".$this->dn;
 502     $entries[$dn]['dNSClass']           = $this->dNSClass;
 503     $entries[$dn]['zoneName']           = $this->zoneName;
 504     $entries[$dn]['dNSTTL']             = $this->dNSTTL;
 505     $entries[$dn]['relativeDomainName'] = $this->cn;
 506
 507     /* Generate cNAMERecord */
 508     $aRecords = array();
 509     foreach($this->types as $type){
 510       if($type['type'] == "cNAMERecord"){
 511
 512         $Cdn = "relativeDomainName=".$type['value'].",".$this->dn;
 513         if($type['status']=="deleted"){
 514           $delete [$type['dn']] = $Cdn;
 515         }else{
 516           $entries[$Cdn] = $entries[$dn];
 517           $entries[$Cdn]['relativeDomainName']  = $type['value'];
 518           $entries[$Cdn]['cNAMERecord']         = $this->cn.".".$this->zoneName;
 519         }
 520       }
 521     }
 522
 523     /* Generate tXTRecord */
 524     $aRecords = array();
 525     foreach($this->types as $type){
 526       if(($type['type'] == "tXTRecord")&&($type['status']!="deleted")){
 527         $entries[$dn]['tXTRecord'][] = $type['value'];
 528       }
 529     }
 530
 531     /* Generate mDRecord */
 532     $aRecords = array();
 533     foreach($this->types as $type){
 534       if(($type['type'] == "mDRecord")&&($type['status']!="deleted")){
 535         $entries[$dn]['mDRecord'][] = $type['value'];
 536       }
 537     }
 538
 539     /* Generate mXRecord */
 540     $aRecords = array();
 541     foreach($this->types as $type){
 542       if(($type['type'] == "mXRecord")&&($type['status']!="deleted")){
 543         $entries[$dn]['mXRecord'][] = $type['value'];
 544       }
 545     }
 546
 547     /* Generate hInfoRecord */
 548     $aRecords = array();
 549     foreach($this->types as $type){
 550       if(($type['type'] == "hInfoRecord")&&($type['status']!="deleted")){
 551         $entries[$dn]['hInfoRecord'][] = $type['value'];
 552       }
 553     }
 554
 555     /* Generate mInfoRecord */
 556     $aRecords = array();
 557     foreach($this->types as $type){
 558       if(($type['type'] == "mInfoRecord")&&($type['status']!="deleted")){
 559         $entries[$dn]['mInfoRecord'][] = $type['value'];
 560       }
 561     }
 562
 563     /* Generate aFSDBRecord */
 564     $aRecords = array();
 565     foreach($this->types as $type){
 566       if(($type['type'] == "aFSDBRecord")&&($type['status']!="deleted")){
 567         $entries[$dn]['aFSDBRecord'][] = $type['value'];
 568       }
 569     }
 570
 571     /* Generate some attrs  */
 572     $arr = array("SigRecord","KeyRecord","aAAARecord","nSRecord",
 573         "LocRecord","nXTRecord","sRVRecord","nAPTRRecord","kXRecord","certRecord","a6Record","dSRecord","sSHFPRecord","rRSIGRecord","nSECRecord");
 574     $aRecords = array();
 575     foreach($arr as $ar){
 576       foreach($this->types as $type){
 577         if(($type['type'] == $ar)&&($type['status']!="deleted")){
 578           $entries[$dn][$ar][] = $type['value'];
 579         }
 580       }
 581     }
 582
 583
 584     /* Generate A Records (IP Address relation) */
 585     $aRecords = array();
 586     foreach($this->types as $type){
 587       if(($type['type'] == "aRecord")&&($type['status']!="deleted")){
 588         $aRecords[] = $type['value'];
 589       }
 590     }
 591     if(count($aRecords)){
 592
 593       /* Add ipHostNumber as default aRecord */
 594       $aRecords[] = $this->ipHostNumber;
 595
 596       $dn = "relativeDomainName=".$this->cn.",".$this->dn;
 597       foreach($aRecords as $rec){
 598         $entries[$dn]['aRecord'][] = $rec;
 599       }
 600     }
 601
 602     /* Generate pTRRecord Records */
 603     foreach($this->types as $type){
 604       if($type['type'] == "pTRRecord"){
 605         $PTRdn= "relativeDomainName=".$type['value'].",".$this->dn;
 606         if($type['status']=="deleted"){
 607           $delete [$type['dn']] = $PTRdn;
 608         }else{
 609           $zones = array_flip($this->Zones);
 610           $zone = $zones[$this->zoneName];
 611           $entries[$PTRdn]['relativeDomainName'] = $type['value'];
 612           $entries[$PTRdn]['pTRRecord']         = $this->cn.".".$this->zoneName;
 613           $entries[$PTRdn]['zoneName']            =  $zone;
 614         }
 615       }
 616     }
 617
 618     /* add ObjectClasses */
 619     foreach($entries as $key => $entry ){
 620       $entries[$key]['objectClass']=array("top","dNSZone");
 621       $entries[$key] = array_reverse($entries[$key]);
 622     }
 623
 624     /* Check if record type has changed, and if we need to delete this record attribute from ldap entry */
 625     foreach($this->types as $type){
 626       if(isset($type['inittype'])){
 627         if(!isset($entries[$dn][$type['inittype']])){
 628           $entries[$dn][$type['inittype']] = array();
 629         }
 630       }
 631     }
 632
 633     return($entries);
 634   }
 635 }
 636
 637 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 638 ?>