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 $autonet        = false;
  13
  14   /* Basic informations
  15    */
  16   var $attributes     = array("ipHostNumber","macAddress");
  17   var $objectclasses  = array("whatever");
  18
  19   var $ipHostNumber   = "";    // IP address
  20   var $macAddress     = "";    // Mac address
  21   var $cn             = "";    // CN of currently edited device
  22   var $OrigCn         = "";    // Initial cn
  23   var $IPisMust       = false;
  24   var $MACisMust      = false;
  25
  26   /* DNS attributes
  27    */
  28   var $DNSattributes            = array("dNSClass","zoneName","dNSTTL");
  29   var $DNS_is_Account           = false;
  30   var $DNSinitially_was_account = false;
  31   var $dnsEntry                 = array();
  32   var $DNSenabled               = false;
  33
  34   /*  Terminal dns
  35    */
  36   function termDNS ($config, $dn,$objectClasses,$IPisMust = false)
  37   {
  38     /* We need to know which objectClasses are used, to store the ip/mac
  39      * Because of different type of devices
  40      */
  41     $this->objectclasses  =  $objectClasses;
  42     $this->IPisMust       = $IPisMust;
  43
  44     plugin::plugin ($config, $dn);
  45
  46     if(isset($this->attrs['cn'][0])){
  47       $this->OrigCn = $this->attrs['cn'][0];
  48       $this->cn = $this->attrs['cn'][0];
  49     }
  50
  51     /* Do we have autonet support? */
  52     if (isset($this->config->data['MAIN']['AUTO_NETWORK_HOOK'])){
  53       $this->autonet= true;
  54     }
  55
  56     /* Hide all dns specific code, if dns is not available
  57      */
  58     $DNSenabled = false;
  59     foreach($this->config->data['TABS']['SERVTABS'] as $tab){
  60       if(preg_match("/^servdns$/",$tab['CLASS'])){
  61         $this->DNSenabled = true;
  62       }
  63     }
  64     if(!$this->DNSenabled){
  65       $this->DNS_is_account = false;
  66       return;
  67     }
  68
  69     if($this->DNSenabled){
  70
  71       /* Get Zones
  72        */
  73       $this->Zones        = getAvailableZones($config);
  74
  75       /* Get Entry
  76        */
  77       $this->dnsEntry     = getDNSHostEntries($config,$this->OrigCn);
  78
  79       /* Remove A record which equals $this->ipHostNumber
  80        */
  81       foreach($this->dnsEntry['RECORDS'] as $key => $rec){
  82         if(($rec['type'] == "aRecord") && ($rec['value'] == $this->ipHostNumber)){
  83           unset($this->dnsEntry['RECORDS'][$key]);
  84         }
  85       }
  86
  87       /* Get Record types
  88        */
  89       $this->RecordTypes  = getDnsRecordTypes();
  90
  91       /* If there is at least one entry in this -> types, we have DNS enabled
  92        */
  93       if($this->dnsEntry['exists']){
  94         $this->DNS_is_account = true;
  95       }else{
  96         $this->DNS_is_account = false;
  97       }
  98
  99     }
 100
 101     /* Store initally account settings
 102      */
 103     $this->DNSinitially_was_account = $this->DNS_is_account;
 104   }
 105
 106
 107   function getVarsForSaving($attrs)
 108   {
 109     foreach($this->attributes as $attr){
 110       if(!empty($this->$attr)){
 111         $attrs[$attr] = $this->$attr;
 112       }
 113     }
 114     return($attrs);
 115   }
 116
 117   function execute()
 118   {
 119           /* Call parent execute */
 120     $smarty= get_smarty();
 121     $display= "";
 122
 123     $smarty->assign("staticAddress", "");
 124     $smarty->assign("autonet", $this->autonet);
 125
 126     /* Check for autonet button */
 127     if ($this->autonet && isset($_POST['autonet'])){
 128       $cmd= $this->config->data['MAIN']['AUTO_NETWORK_HOOK'];
 129       if(!empty($cmd) && $this->cn != ""){
 130         $res = shell_exec($cmd." ".$this->cn);
 131         if(!$res){
 132           print_red(sprintf(_("Can't execute specified AUTO_NETWORK_HOOK '%s'. Please check your gosa.conf."),$cmd));
 133         } else {
 134           $res= split(';', trim($res));
 135           if (isset($res[0]) && $res[0] != ""){
 136             $this->ipHostNumber= $res[0];
 137           }
 138           if (isset($res[1]) && $res[1] != ""){
 139             $this->macAddress= $res[1];
 140           }
 141         }
 142       }
 143     }
 144
 145     /* There is no dns available
 146      */
 147     if($this->DNSenabled == false){
 148
 149       /* Is IP address must ? */
 150       $smarty->assign("DNS_is_account",false);
 151       $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
 152
 153       /* Assign smarty all non DNs attributes */
 154       foreach($this->attributes as $attr){
 155         $smarty->assign($attr,$this->$attr);
 156       }
 157       $smarty->assign("staticAddress","<font class=\"must\">*</font>");
 158
 159       $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
 160       return($display);
 161     }else{
 162       $smarty->assign("DNS_is_account",true);
 163     }
 164
 165     /* Add new empty array to our record list */
 166     if(isset($_POST['AddNewRecord'])){
 167       $this->dnsEntry['RECORDS'][]  =array("type"=>"aRecord","value"=>"");
 168     }
 169
 170     /* Handle all posts */
 171     $only_once =true;
 172     foreach($_POST as $name => $value){
 173
 174       /* Check if we have to delete a record entry */
 175       if((preg_match("/RemoveRecord_/",$name))&&($only_once)) {
 176
 177         /* Avoid performing this once again */
 178         $only_once = false;
 179
 180         /* Extract id for specified entry */
 181         $id = preg_replace("/RemoveRecord_/","",$name);
 182         $id = preg_replace("/_.*$/","",$id);
 183
 184         /* Delete this record, mark edited entries to be able to delete them */
 185         if(isset($this->dnsEntry['RECORDS'][$id])){
 186           unset($this->dnsEntry['RECORDS'][$id]);
 187         }
 188       }
 189     }
 190
 191     /* Assign smarty all non DNs attributes */
 192     foreach($this->attributes as $attr){
 193       $smarty->assign($attr,$this->$attr);
 194     }
 195
 196     /* Assign smarty all DNS attributes */
 197     foreach($this->DNSattributes as $attr){
 198       $smarty->assign($attr,$this->dnsEntry[$attr]);
 199     }
 200
 201     /* Assign all needed vars */
 202     $smarty->assign("DNSAccount",$this->DNS_is_account);
 203     $smarty->assign("Zones",$this->Zones);
 204     $smarty->assign("ZoneKeys",($this->Zones));
 205     $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
 206
 207     $tmp = $this->generateRecordsList();
 208
 209     $changeStateForRecords = $tmp['changeStateForRecords'];
 210
 211     $smarty->assign("records",$tmp['str']);
 212     $smarty->assign("changeStateForRecords",$changeStateForRecords);
 213     $smarty->assign("staticAddress","<font class=\"must\">*</font>");
 214
 215     $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
 216     return($display);
 217   }
 218
 219   function remove_from_parent()
 220   {
 221     /*
 222     $ldap = $this->config->get_ldap_link();
 223     $ldap->cd($this->orig_dn);
 224     $ldap->search("(&(objectClass=dNSZone)(zoneName=*)(!(relativeDomainName=@)))",array("relativeDomainName","zoneName"));
 225     while($attr = $ldap->fetch()){
 226       $ldap->cd($attr['dn']);
 227       $ldap->rmDir($attr['dn']);
 228       show_ldap_error("Record:".$ldap->get_error(), _("Removing terminal from DNS object failed"));
 229     }
 230     */
 231   }
 232
 233   /* Save data to object */
 234   function save_object()
 235   {
 236     /* Save all posted vars */
 237     plugin::save_object();
 238
 239     /* Ge all non dns attributes (IP/MAC)*/
 240     foreach($this->attributes as $attr){
 241       if(isset($_POST[$attr])){
 242         $this->$attr = $_POST[$attr];
 243       }
 244     }
 245
 246     /* Get dns attributes */
 247     if(($this->DNSenabled) && (isset($_POST['network_tpl_posted']))){
 248
 249       /* Check for posted record changes */
 250       if(is_array($this->dnsEntry['RECORDS'])){
 251         foreach($this->dnsEntry['RECORDS'] as $key => $value){
 252
 253           /* Check if type has changed */
 254           if(isset($_POST['RecordTypeSelectedFor_'.$key])){
 255             $this->dnsEntry['RECORDS'][$key]['type'] = $_POST['RecordTypeSelectedFor_'.$key];
 256           }
 257           /* Check if value has changed */
 258           if(isset($_POST['RecordValue_'.$key])){
 259             $this->dnsEntry['RECORDS'][$key]['value'] = $_POST['RecordValue_'.$key];
 260           }
 261         }
 262       }
 263       /* Get all basic DNS attributes (TTL, Clas ..)*/
 264       foreach($this->DNSattributes as $attr){
 265         if(isset($_POST[$attr])){
 266           $this->dnsEntry[$attr] = $_POST[$attr];
 267         }
 268       }
 269
 270       /* Enable diable DNS */
 271       if(isset($_POST['enableDNS'])){
 272         $this->DNS_is_account = true;
 273       }else{
 274         $this->DNS_is_account = false;
 275       }
 276     }
 277   }
 278
 279
 280   /* Check supplied data */
 281   function check()
 282   {
 283     /* Call common method to give check the hook */
 284     $message= plugin::check();
 285
 286     /* Check if ip must be given
 287      */
 288     if(($this->IPisMust)||($this->DNS_is_account)){
 289
 290       /* Check if ip is empty
 291        */
 292       if ($this->ipHostNumber == "" && chkacl ($this->acl, "ipHostNumber") == ""){
 293         $message[]= _("The required field 'IP-address' is not set.");
 294       }
 295
 296     }
 297
 298     /* check if given ip is valid ip */
 299     if ($this->ipHostNumber != "" && !is_ip($this->ipHostNumber)){
 300       $message[]= _("Wrong IP format in field IP-address.");
 301     }
 302
 303     /* Check if mac is empty
 304      */
 305     if ($this->macAddress == "" && chkacl ($this->acl, "macAddress") == ""){
 306       $message[]= _("The required field 'MAC-address' is not set.");
 307     }
 308
 309     /* Check if given mac is valid mac
 310      */
 311     if(!is_mac($this->macAddress)){
 312       $message[]=(_("The given macaddress is invalid. There must be 6 2byte segments seperated by ':'."));
 313     }
 314
 315     /* only perfrom this checks if this is a valid DNS account */
 316     if($this->DNS_is_account){
 317
 318       $checkArray = array();
 319       $onlyOnce   = array();
 320
 321                         // There can be many CNAME records
 322       //$onlyOnce['cNAMERecord'] = 0;
 323
 324       /* Walk through all entries and detect duplicates or mismatches
 325        */
 326       foreach($this->dnsEntry['RECORDS'] as $name => $values){
 327
 328         /* Count record values, to detect duplicate entries for a specific record
 329          */
 330         if(!isset($checkArray[$values['type']][$values['value']])){
 331           $checkArray[$values['type']][$values['value']] = 0;
 332         }else{
 333           $message[] = sprintf(_("Found duplicate value for record type '%s'."),$values['type']);
 334         }
 335
 336         /* Check if given entries in $onlyOnce are used more than once
 337          */
 338         if(isset($onlyOnce[$values['type']])){
 339           $onlyOnce[$values['type']] ++;
 340           if($onlyOnce[$values['type']] > 1){
 341             $message[] = sprintf(_("Found more than one entry for the uniqe record type '%s'."),$values['type']);
 342           }
 343         }
 344
 345         /* Skip txt record ...
 346          */
 347         if($values['type'] == "tXTRecord") continue;
 348
 349         /* Check if there is an aRecord defined which uses the same IP as used in IPhostAddress
 350          */
 351         if(($values['type'] == "aRecord")&&($values['value'] == $this->ipHostNumber)){
 352           $message[]=sprintf(_("The device IP '%s' is added as 'A Record', this will be done automatically, please remove the record."),
 353                $this->ipHostNumber);
 354         }
 355
 356         /* only lower-case is allowed in record entries ...
 357          */
 358         if($values['value'] != strtolower($values['value'])){
 359           $message[] = sprintf(_("Only lowercase is allowed, please check your '%ss'."),$values['type']);
 360         }
 361       }
 362     }
 363     return ($message);
 364   }
 365
 366
 367   /* Save to LDAP */
 368   function save($dn)
 369   {
 370     $ldap= $this->config->get_ldap_link();
 371
 372     /*******************/
 373     /* IP-MAC HANDLING */
 374     /*******************/
 375
 376     /* $dn was posted as parameter */
 377     $this->dn = $dn;
 378
 379     /* Save DNS setting & ip/Mac*/
 380     plugin::save();
 381
 382     /* Write back to ldap */
 383     $ldap->cd($this->dn);
 384     $this->cleanup();
 385     $ldap->modify ($this->attrs);
 386
 387     /****************/
 388     /* DNS HANDLING */
 389     /****************/
 390
 391     /* If isn't DNS account but initially was DNS account
 392        remove all DNS entries
 393      */
 394     if(!$this->DNSenabled){
 395       return;
 396     }else{
 397
 398       /* Add ipHostNumber to aRecords
 399        */
 400       $this->dnsEntry['RECORDS'][] = array("type"=>"aRecord","value"=>$this->ipHostNumber);
 401
 402       /* Create diff and follow instructions
 403        * If Account was disabled, remove account by setting exists to false
 404        */
 405       if((!$this->DNS_is_account)&&($this->DNSinitially_was_account)){
 406         $this->dnsEntry['exists'] = false;
 407         $tmp = getDNSHostEntriesDiff($this->config,$this->OrigCn,$this->dnsEntry,$this->cn);
 408       }else{
 409         $this->dnsEntry['exists'] = $this->DNS_is_account;
 410         $tmp = getDNSHostEntriesDiff($this->config,$this->OrigCn,$this->dnsEntry,$this->cn);
 411       }
 412
 413       /* move follwoing entries
 414        */
 415       foreach($tmp['move'] as $src => $dst){
 416         $this->recursive_move($src,$dst);
 417       }
 418
 419       /* Delete dns */
 420       foreach($tmp['del'] as $dn => $del){
 421         $ldap->cd($dn);
 422         $ldap->rmdir_recursive($dn);
 423       }
 424
 425       /* Add || Update new DNS entries
 426        */
 427       foreach($tmp['add'] as $dn => $attrs){
 428         $ldap->cd($dn);
 429         $ldap->cat($dn, array('dn'));
 430         if(count($ldap->fetch())){
 431           $ldap->cd($dn);
 432           $ldap->modify ($attrs);
 433         }else{
 434           $ldap->cd($dn);
 435           $ldap->add($attrs);
 436         }
 437       }
 438
 439       /* Display errors
 440        */
 441       if($ldap->get_error() != "Success"){
 442         show_ldap_error("Record:".$ldap->get_error(), _("Saving terminal to DNS object failed"));
 443       }
 444     }
 445   }
 446
 447   /*  Create html table with all used record types
 448    */
 449   function generateRecordsList()
 450   {
 451     $changeStateForRecords = "";
 452
 453     if(!$this->DNS_is_account) {
 454       $str = "<input type='submit' value='"._("Add")."' name='AddNewRecord' id='AddNewRecord' disabled='disabled'>";
 455       return $str;
 456     }
 457
 458     $str = "<table summary='' width='100%'>";
 459     foreach($this->dnsEntry['RECORDS'] as $key => $entry){
 460
 461         $changeStateForRecords.= "changeState('RecordTypeSelectedFor_".$key."');\n";
 462         $changeStateForRecords.= "changeState('RecordValue_".$key."');\n";
 463         $changeStateForRecords.= "changeState('RemoveRecord_".$key."');\n";
 464
 465         $str.=" <tr>".
 466           "   <td>".$this->generateRecordListBox($entry['type'],"RecordTypeSelectedFor_".$key)."</td>".
 467           "   <td><input type='text' value='".$entry['value']."' name='RecordValue_".$key."' id='RecordValue_".$key."'></td>".
 468           "   <td><input type='submit' name='RemoveRecord_".$key."' value='"._("Delete")."' id='RemoveRecord_".$key."'></td>".
 469           "</tr>";
 470     }
 471
 472     $str.= "  <tr>".
 473            "    <td colspan=2 width='50%'></td><td>".
 474            "      <input type='submit' value='"._("Add")."' name='AddNewRecord'>".
 475            "    </td>".
 476            "  </tr>".
 477            "</table>";
 478      $ret =  array("str" => $str, "changeStateForRecords" => $changeStateForRecords);
 479     return($ret);
 480   }
 481
 482
 483   /* Create a html select box which allows us to select different types of records
 484    */
 485   function generateRecordListBox($selected,$name)
 486   {
 487     $str = "<select name='".$name."' id='".$name."'>";
 488     foreach($this->RecordTypes as $type => $value){
 489       $use = "";
 490       if($type == $selected){
 491         $use = " selected ";
 492       }
 493       $str.="\n <option value='".$type."' ".$use.">".strtoupper(preg_replace("/record/i","",$type))."</option>";
 494     }
 495     $str.="</select>";
 496     return($str);
 497   }
 498 }
 499
 500 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 501 ?>