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 $initially_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']['SERVERSERVICE'] 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->initially_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", "");
 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       if ($this->autonet){
 160         $smarty->assign("autonet", "true");
 161       } else {
 162         $smarty->assign("autonet", "");
 163       }
 164       $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
 165       return($display);
 166     }else{
 167       $smarty->assign("DNS_is_account",true);
 168     }
 169
 170     /* Add new empty array to our record list */
 171     if(isset($_POST['AddNewRecord'])){
 172       $this->dnsEntry['RECORDS'][]  =array("type"=>"aRecord","value"=>"");
 173     }
 174
 175     /* Handle all posts */
 176     $only_once =true;
 177     foreach($_POST as $name => $value){
 178
 179       /* Check if we have to delete a record entry */
 180       if((preg_match("/RemoveRecord_/",$name))&&($only_once)) {
 181
 182         /* Avoid performing this once again */
 183         $only_once = false;
 184
 185         /* Extract id for specified entry */
 186         $id = preg_replace("/RemoveRecord_/","",$name);
 187         $id = preg_replace("/_.*$/","",$id);
 188
 189         /* Delete this record, mark edited entries to be able to delete them */
 190         if(isset($this->dnsEntry['RECORDS'][$id])){
 191           unset($this->dnsEntry['RECORDS'][$id]);
 192         }
 193       }
 194     }
 195
 196     /* Assign smarty all non DNs attributes */
 197     foreach($this->attributes as $attr){
 198       $smarty->assign($attr,$this->$attr);
 199     }
 200
 201     /* Assign smarty all DNS attributes */
 202     foreach($this->DNSattributes as $attr){
 203       $smarty->assign($attr,$this->dnsEntry[$attr]);
 204     }
 205
 206     /* Assign all needed vars */
 207     $smarty->assign("DNSAccount",$this->DNS_is_account);
 208     $smarty->assign("Zones",$this->Zones);
 209     $smarty->assign("ZoneKeys",($this->Zones));
 210     $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
 211
 212     $tmp = $this->generateRecordsList();
 213
 214     $changeStateForRecords = $tmp['changeStateForRecords'];
 215
 216     $smarty->assign("records",$tmp['str']);
 217     $smarty->assign("changeStateForRecords",$changeStateForRecords);
 218     $smarty->assign("staticAddress","<font class=\"must\">*</font>");
 219
 220     $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
 221     return($display);
 222   }
 223
 224   function remove_from_parent()
 225   {
 226     /*
 227     $ldap = $this->config->get_ldap_link();
 228     $ldap->cd($this->orig_dn);
 229     $ldap->search("(&(objectClass=dNSZone)(zoneName=*)(!(relativeDomainName=@)))",array("relativeDomainName","zoneName"));
 230     while($attr = $ldap->fetch()){
 231       $ldap->cd($attr['dn']);
 232       $ldap->rmDir($attr['dn']);
 233       show_ldap_error($ldap->get_error(), sprintf(_("Removing of terminal/dns acoount with dn '%s' failed."),$this->dn));
 234     }
 235     */
 236   }
 237
 238   /* Save data to object */
 239   function save_object()
 240   {
 241     /* Save all posted vars */
 242     plugin::save_object();
 243
 244     /* Ge all non dns attributes (IP/MAC)*/
 245     foreach($this->attributes as $attr){
 246       if(isset($_POST[$attr])){
 247         $this->$attr = $_POST[$attr];
 248       }
 249     }
 250
 251     /* Get dns attributes */
 252     if(($this->DNSenabled) && (isset($_POST['network_tpl_posted']))){
 253
 254       /* Check for posted record changes */
 255       if(is_array($this->dnsEntry['RECORDS'])){
 256         foreach($this->dnsEntry['RECORDS'] as $key => $value){
 257
 258           /* Check if type has changed */
 259           if(isset($_POST['RecordTypeSelectedFor_'.$key])){
 260             $this->dnsEntry['RECORDS'][$key]['type'] = $_POST['RecordTypeSelectedFor_'.$key];
 261           }
 262           /* Check if value has changed */
 263           if(isset($_POST['RecordValue_'.$key])){
 264             $this->dnsEntry['RECORDS'][$key]['value'] = $_POST['RecordValue_'.$key];
 265           }
 266         }
 267       }
 268       /* Get all basic DNS attributes (TTL, Clas ..)*/
 269       foreach($this->DNSattributes as $attr){
 270         if(isset($_POST[$attr])){
 271           $this->dnsEntry[$attr] = $_POST[$attr];
 272         }
 273       }
 274
 275       /* Enable diable DNS */
 276       if(isset($_POST['enableDNS'])){
 277         $this->DNS_is_account = true;
 278       }else{
 279         $this->DNS_is_account = false;
 280       }
 281     }
 282   }
 283
 284
 285   /* Check supplied data */
 286   function check()
 287   {
 288     /* Call common method to give check the hook */
 289     $message= plugin::check();
 290
 291     /* Check if ip must be given
 292      */
 293     if(($this->IPisMust)||($this->DNS_is_account)){
 294
 295       /* Check if ip is empty
 296        */
 297       if ($this->ipHostNumber == "" && chkacl ($this->acl, "ipHostNumber") == ""){
 298         $message[]= _("The required field 'IP-address' is not set.");
 299       }
 300
 301       /* check if given ip is valid ipi
 302        */
 303       $num="(\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])";
 304       if (!preg_match("/^$num\\.$num\\.$num\\.$num$/", $this->ipHostNumber)){
 305         $message[]= _("Wrong IP format in field IP-address.");
 306       }
 307     }
 308
 309     /* Check if mac is empty
 310      */
 311     if ($this->macAddress == "" && chkacl ($this->acl, "macAddress") == ""){
 312       $message[]= _("The required field 'MAC-address' is not set.");
 313     }
 314
 315     /* Check if given mac is valid mac
 316      */
 317     $tr = count(split(":",$this->macAddress));
 318     if($tr!=6){
 319       $message[]=(_("The given macaddress is invalid. There must be 6 2byte segments seperated by ':'."));
 320     }
 321
 322     /* only perfrom this checks if this is a valid DNS account */
 323     if($this->DNS_is_account){
 324
 325       $checkArray = array();
 326       $onlyOnce   = array();
 327
 328       $onlyOnce['cNAMERecord'] = 0;
 329
 330       /* Walk through all entries and detect duplicates or mismatches
 331        */
 332       foreach($this->dnsEntry['RECORDS'] as $name => $values){
 333
 334         /* Count record values, to detect duplicate entries for a specific record
 335          */
 336         if(!isset($checkArray[$values['type']][$values['value']])){
 337           $checkArray[$values['type']][$values['value']] = 0;
 338         }else{
 339           $message[] = sprintf(_("Found duplicate value for record type '%s'."),$values['type']);
 340         }
 341
 342         /* Check if given entries in $onlyOnce are used more than once
 343          */
 344         if(isset($onlyOnce[$values['type']])){
 345           $onlyOnce[$values['type']] ++;
 346           if($onlyOnce[$values['type']] > 1){
 347             $message[] = sprintf(_("Found more than one entry for the uniqe record type '%s'."),$values['type']);
 348           }
 349         }
 350
 351         /* Skip txt record ...
 352          */
 353         if($values['type'] == "tXTRecord") continue;
 354
 355         /* Check if there is an aRecord defined which uses the same IP as used in IPhostAddress
 356          */
 357         if(($values['type'] == "aRecord")&&($values['value'] == $this->ipHostNumber)){
 358           $message[]=sprintf(_("The device IP '%s' is added as 'A Record', this will be done automatically, please remove the record."),
 359                $this->ipHostNumber);
 360         }
 361
 362         /* only lower-case is allowed in record entries ...
 363          */
 364         if($values['value'] != strtolower($values['value'])){
 365           $message[] = sprintf(_("Only lowercase is allowed, please check your '%ss'."),$values['type']);
 366         }
 367       }
 368     }
 369     return ($message);
 370   }
 371
 372
 373   /* Save to LDAP */
 374   function save($dn)
 375   {
 376     $ldap= $this->config->get_ldap_link();
 377
 378     /*******************/
 379     /* IP-MAC HANDLING */
 380     /*******************/
 381
 382     /* $dn was posted as parameter */
 383     $this->dn = $dn;
 384
 385     /* Save DNS setting & ip/Mac*/
 386     plugin::save();
 387
 388     /* Write back to ldap */
 389     $ldap->cd($this->dn);
 390     $this->cleanup();
 391     $ldap->modify ($this->attrs);
 392
 393     /****************/
 394     /* DNS HANDLING */
 395     /****************/
 396
 397     /* If isn't DNS account but initially was DNS account
 398        remove all DNS entries
 399      */
 400     if(!$this->DNSenabled){
 401       return;
 402     }else{
 403
 404       /* Add ipHostNumber to aRecords
 405        */
 406       $this->dnsEntry['RECORDS'][] = array("type"=>"aRecord","value"=>$this->ipHostNumber);
 407
 408       /* Create diff and follow instructions
 409        * If Account was disabled, remove account by setting exists to false
 410        */
 411       if((!$this->DNS_is_account)&&($this->initially_was_account)){
 412         $this->dnsEntry['exists'] = false;
 413         $tmp = getDNSHostEntriesDiff($this->config,$this->OrigCn,$this->dnsEntry,$this->cn);
 414       }else{
 415         $this->dnsEntry['exists'] = $this->DNS_is_account;
 416         $tmp = getDNSHostEntriesDiff($this->config,$this->OrigCn,$this->dnsEntry,$this->cn);
 417       }
 418
 419       /* move follwoing entries
 420        */
 421       foreach($tmp['move'] as $src => $dst){
 422         $this->recursive_move($src,$dst);
 423       }
 424
 425       /* Delete dns */
 426       foreach($tmp['del'] as $dn => $del){
 427         $ldap->cd($dn);
 428         $ldap->rmdir_recursive($dn);
 429       }
 430
 431       /* Add || Update new DNS entries
 432        */
 433       foreach($tmp['add'] as $dn => $attrs){
 434         $ldap->cd($dn);
 435         $ldap->cat($dn, array('dn'));
 436         if(count($ldap->fetch())){
 437           $ldap->cd($dn);
 438           $ldap->modify ($attrs);
 439         }else{
 440           $ldap->cd($dn);
 441           $ldap->add($attrs);
 442         }
 443       }
 444
 445       /* Display errors
 446        */
 447       if($ldap->get_error() != "Success"){
 448         show_ldap_error($ldap->get_error(), sprintf(_("Saving of terminal/dns account with dn '%s' failed."),$this->dn));
 449       }
 450     }
 451   }
 452
 453   /*  Create html table with all used record types
 454    */
 455   function generateRecordsList()
 456   {
 457     $changeStateForRecords = "";
 458
 459     if(!$this->DNS_is_account) {
 460       $str = "<input type='submit' value='"._("Add")."' name='AddNewRecord' id='AddNewRecord' disabled='disabled'>";
 461       return $str;
 462     }
 463
 464     $str = "<table summary='' width='100%'>";
 465     foreach($this->dnsEntry['RECORDS'] as $key => $entry){
 466
 467         $changeStateForRecords.= "changeState('RecordTypeSelectedFor_".$key."');\n";
 468         $changeStateForRecords.= "changeState('RecordValue_".$key."');\n";
 469         $changeStateForRecords.= "changeState('RemoveRecord_".$key."');\n";
 470
 471         $str.=" <tr>".
 472           "   <td>".$this->generateRecordListBox($entry['type'],"RecordTypeSelectedFor_".$key)."</td>".
 473           "   <td><input type='text' value='".$entry['value']."' name='RecordValue_".$key."' id='RecordValue_".$key."'></td>".
 474           "   <td><input type='submit' name='RemoveRecord_".$key."' value='"._("Delete")."' id='RemoveRecord_".$key."'></td>".
 475           "</tr>";
 476     }
 477
 478     $str.= "  <tr>".
 479            "    <td colspan=2 width='50%'></td><td>".
 480            "      <input type='submit' value='"._("Add")."' name='AddNewRecord'>".
 481            "    </td>".
 482            "  </tr>".
 483            "</table>";
 484      $ret =  array("str" => $str, "changeStateForRecords" => $changeStateForRecords);
 485     return($ret);
 486   }
 487
 488
 489   /* Create a html select box which allows us to select different types of records
 490    */
 491   function generateRecordListBox($selected,$name)
 492   {
 493     $str = "<select name='".$name."' id='".$name."'>";
 494     foreach($this->RecordTypes as $type => $value){
 495       $use = "";
 496       if($type == $selected){
 497         $use = " selected ";
 498       }
 499       $str.="\n <option value='".$type."' ".$use.">".strtoupper(preg_replace("/record/i","",$type))."</option>";
 500     }
 501     $str.="</select>";
 502     return($str);
 503   }
 504
 505
 506   /* Return plugin informations for acl handling  */
 507   function plInfo()
 508   {
 509     return (array(
 510           "plShortName"   => _("DNS"),
 511           "plDescription" => _("DNS settings"),
 512           "plSelfModify"  => FALSE,
 513           "plDepends"     => array(),
 514           "plPriority"    => 0,
 515           "plSection"     => array("administration"),
 516           "plCategory"    => array("workstation","terminal","phone","server","component","printer"),
 517
 518           "plProvidedAcls"=> array(
 519             "Records"       => _("DNS records"),
 520             "zoneName"      => _("Zone name"),
 521             "dNSTTL"        => _("TTL"),
 522             "ipHostNumber"  => _("IP address"),
 523             "macAddress"    => _("MAC address"))
 524           ));
 525   }
 526 }
 527
 528 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 529 ?>