a7310a89ff2f7a73fdc2113672af2b42983383c5
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 $autonet = false;
14 /* Basic informations
15 */
16 var $attributes = array("ipHostNumber","macAddress");
17 var $objectclasses = array("whatever");
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;
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;
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;
44 plugin::plugin ($config, $dn);
46 if(isset($this->attrs['cn'][0])){
47 $this->OrigCn = preg_replace("/\\\$\$/","",$this->attrs['cn'][0]);
48 $this->cn = preg_replace("/\\\$\$/","",$this->attrs['cn'][0]);
49 }
51 /* Do we have autonet support? */
52 if (isset($this->config->data['MAIN']['AUTO_NETWORK_HOOK'])){
53 $this->autonet= true;
54 }
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 }
69 if($this->DNSenabled){
71 /* Get Zones
72 */
73 $this->Zones = getAvailableZones($config);
75 /* Get Entry
76 */
77 $this->dnsEntry = getDNSHostEntries($config,$this->OrigCn);
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 }
87 /* Get Record types
88 */
89 $this->RecordTypes = getDnsRecordTypes();
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 }
99 }
101 /* Store initally account settings
102 */
103 $this->DNSinitially_was_account = $this->DNS_is_account;
104 }
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 }
117 function execute()
118 {
119 /* Call parent execute */
120 $smarty= get_smarty();
121 $display= "";
123 $smarty->assign("staticAddress", "");
124 $smarty->assign("autonet", $this->autonet);
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 }
145 /* There is no dns available
146 */
147 if($this->DNSenabled == false){
149 /* Is IP address must ? */
150 $smarty->assign("DNS_is_account",false);
151 $smarty->assign("IPisMust",(($this->IPisMust)||($this->DNS_is_account)));
153 /* Assign smarty all non DNs attributes */
154 foreach($this->attributes as $attr){
155 $smarty->assign($attr,$this->$attr);
156 $smarty->assign($attr."ACL",chkacl($this->acl,$attr));
157 }
158 $smarty->assign("staticAddress","<font class=\"must\">*</font>");
160 $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
161 return($display);
162 }else{
163 $smarty->assign("DNS_is_account",true);
164 }
166 /* Add new empty array to our record list */
167 if(isset($_POST['AddNewRecord'])){
168 $this->dnsEntry['RECORDS'][] =array("type"=>"aRecord","value"=>"");
169 }
171 /* Handle all posts */
172 $only_once =true;
173 foreach($_POST as $name => $value){
175 /* Check if we have to delete a record entry */
176 if((preg_match("/RemoveRecord_/",$name))&&($only_once)) {
178 /* Avoid performing this once again */
179 $only_once = false;
181 /* Extract id for specified entry */
182 $id = preg_replace("/RemoveRecord_/","",$name);
183 $id = preg_replace("/_.*$/","",$id);
185 /* Delete this record, mark edited entries to be able to delete them */
186 if(isset($this->dnsEntry['RECORDS'][$id])){
187 unset($this->dnsEntry['RECORDS'][$id]);
188 }
189 }
190 }
192 /* Assign smarty all non DNs attributes */
193 foreach($this->attributes as $attr){
194 $smarty->assign($attr,$this->$attr);
195 $smarty->assign($attr."ACL",chkacl($this->acl,$attr));
196 }
198 /* Assign smarty all DNS attributes */
199 foreach($this->DNSattributes as $attr){
200 $smarty->assign($attr,$this->dnsEntry[$attr]);
201 $smarty->assign($attr."ACL",chkacl($this->acl,$attr));
202 }
204 /* Assign all needed vars */
205 $smarty->assign("DNSaccountACL",chkacl($this->acl,"termDNS"));
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)));
212 $tmp = $this->generateRecordsList();
214 $changeStateForRecords = $tmp['changeStateForRecords'];
216 $smarty->assign("records",$tmp['str']);
217 $smarty->assign("changeStateForRecords",$changeStateForRecords);
218 $smarty->assign("staticAddress","<font class=\"must\">*</font>");
220 $display.= $smarty->fetch(get_template_path('network.tpl', TRUE));
221 return($display);
222 }
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("Record:".$ldap->get_error(), _("Removing terminal from DNS object failed"));
234 }
235 */
236 }
238 /* Save data to object */
239 function save_object()
240 {
241 /* Save all posted vars */
242 plugin::save_object();
244 /* Get dns attributes */
245 if(($this->DNSenabled) && (isset($_POST['network_tpl_posted'])) && chkacl($this->acl,"termDNS") == ""){
247 /* Check for posted record changes */
248 if(is_array($this->dnsEntry['RECORDS'])){
249 foreach($this->dnsEntry['RECORDS'] as $key => $value){
251 /* Check if type has changed */
252 if(isset($_POST['RecordTypeSelectedFor_'.$key])){
253 $this->dnsEntry['RECORDS'][$key]['type'] = $_POST['RecordTypeSelectedFor_'.$key];
254 }
255 /* Check if value has changed */
256 if(isset($_POST['RecordValue_'.$key])){
257 $this->dnsEntry['RECORDS'][$key]['value'] = $_POST['RecordValue_'.$key];
258 }
259 }
260 }
261 /* Get all basic DNS attributes (TTL, Clas ..)*/
262 foreach($this->DNSattributes as $attr){
263 if(isset($_POST[$attr])){
264 $this->dnsEntry[$attr] = $_POST[$attr];
265 }
266 }
268 /* Enable diable DNS */
269 if(isset($_POST['enableDNS'])){
270 $this->DNS_is_account = true;
271 }else{
272 $this->DNS_is_account = false;
273 }
274 }
275 }
278 /* Check supplied data */
279 function check()
280 {
281 /* Call common method to give check the hook */
282 $message= plugin::check();
284 /* Check if ip must be given
285 */
286 if(($this->IPisMust)||($this->DNS_is_account)){
288 /* Check if ip is empty
289 */
290 if ($this->ipHostNumber == "" && chkacl ($this->acl, "ipHostNumber") == ""){
291 $message[]= _("The required field 'IP-address' is not set.");
292 }
294 }
296 /* check if given ip is valid ip */
297 if ($this->ipHostNumber != "" && !is_ip($this->ipHostNumber)){
298 $message[]= _("Wrong IP format in field IP-address.");
299 }
301 /* Check if mac is empty
302 */
303 if ($this->macAddress == "" && chkacl ($this->acl, "macAddress") == ""){
304 $message[]= _("The required field 'MAC-address' is not set.");
305 }
307 /* Check if given mac is valid mac
308 */
309 if(!is_mac($this->macAddress)){
310 $message[]=(_("The given macaddress is invalid. There must be 6 2byte segments seperated by ':'."));
311 }
313 /* only perfrom this checks if this is a valid DNS account */
314 if($this->DNS_is_account){
316 $checkArray = array();
317 $onlyOnce = array();
319 // There can be many CNAME records
320 //$onlyOnce['cNAMERecord'] = 0;
322 /* Walk through all entries and detect duplicates or mismatches
323 */
324 foreach($this->dnsEntry['RECORDS'] as $name => $values){
326 /* Count record values, to detect duplicate entries for a specific record
327 */
328 if(!isset($checkArray[$values['type']][$values['value']])){
329 $checkArray[$values['type']][$values['value']] = 0;
330 }else{
331 $message[] = sprintf(_("Found duplicate value for record type '%s'."),$values['type']);
332 }
334 /* Check if given entries in $onlyOnce are used more than once
335 */
336 if(isset($onlyOnce[$values['type']])){
337 $onlyOnce[$values['type']] ++;
338 if($onlyOnce[$values['type']] > 1){
339 $message[] = sprintf(_("Found more than one entry for the uniqe record type '%s'."),$values['type']);
340 }
341 }
343 /* Skip txt record ...
344 */
345 if($values['type'] == "tXTRecord") continue;
347 /* Check if there is an aRecord defined which uses the same IP as used in IPhostAddress
348 */
349 if(($values['type'] == "aRecord")&&($values['value'] == $this->ipHostNumber)){
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 */
356 if($values['value'] != strtolower($values['value'])){
357 $message[] = sprintf(_("Only lowercase is allowed, please check your '%ss'."),$values['type']);
358 }
359 }
360 }
361 return ($message);
362 }
365 /* Save to LDAP */
366 function save($dn)
367 {
368 $ldap= $this->config->get_ldap_link();
370 /*******************/
371 /* IP-MAC HANDLING */
372 /*******************/
374 /* $dn was posted as parameter */
375 $this->dn = $dn;
377 /* Save DNS setting & ip/Mac*/
378 plugin::save();
380 /* Write back to ldap */
381 $ldap->cd($this->dn);
382 $this->cleanup();
383 $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->DNSenabled) || (!$this->DNS_is_account && !$this->DNSinitially_was_account)){
393 return;
394 }else{
396 /* Add ipHostNumber to aRecords
397 */
398 if(!empty($this->ipHostNumber)){
399 $this->dnsEntry['RECORDS'][] = array("type"=>"aRecord","value"=>$this->ipHostNumber);
400 }
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 }
413 /* move follwoing entries
414 */
415 foreach($tmp['move'] as $src => $dst){
416 $this->recursive_move($src,$dst);
417 }
419 /* Delete dns */
420 foreach($tmp['del'] as $dn => $del){
421 $ldap->cd($dn);
422 $ldap->rmdir_recursive($dn);
423 }
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 }
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 }
447 /* Create html table with all used record types
448 */
449 function generateRecordsList()
450 {
451 $changeStateForRecords = "";
453 if(!$this->DNS_is_account) {
454 $str = "<input type='submit' value='"._("Add")."' name='AddNewRecord' id='AddNewRecord' disabled='disabled'>";
455 return $str;
456 }
458 $str = "<table summary='' width='100%'>";
459 foreach($this->dnsEntry['RECORDS'] as $key => $entry){
461 $changeStateForRecords.= "changeState('RecordTypeSelectedFor_".$key."');\n";
462 $changeStateForRecords.= "changeState('RecordValue_".$key."');\n";
463 $changeStateForRecords.= "changeState('RemoveRecord_".$key."');\n";
465 $str.=" <tr>".
466 " <td>".$this->generateRecordListBox($entry['type'],"RecordTypeSelectedFor_".$key)."</td>".
467 " <td><input ".chkacl($this->acl,"termDNS")." type='text' value='".$entry['value']."' name='RecordValue_".$key."' id='RecordValue_".$key."'></td>".
468 " <td><input ".chkacl($this->acl,"termDNS")." type='submit' name='RemoveRecord_".$key."' value='"._("Delete")."' id='RemoveRecord_".$key."'></td>".
469 "</tr>";
470 }
472 $str.= " <tr>".
473 " <td colspan=2 width='50%'></td><td>".
474 " <input type='submit' value='"._("Add")."' name='AddNewRecord' ".chkacl($this->acl,"termDNS")." >".
475 " </td>".
476 " </tr>".
477 "</table>";
478 $ret = array("str" => $str, "changeStateForRecords" => $changeStateForRecords);
479 return($ret);
480 }
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 ".chkacl($this->acl,"termDNS")." 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 }
500 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
501 ?>