m_bind Class Reference

Manages BIND 9+ zone management templates in AlternC 3.5+. More...

Public Member Functions
	hook_updatedomains_dns_pre ()
	Hook launched before any action by updatedomains initialize the reload/reconfig flags used by POST @NOTE launched as ROOT. More...
	hook_updatedomains_dns_add ($dominfo)
	Hook launched for each ZONE for which we want a zone update (or create) update the zone, create it if necessary, and ask for reload or reconfig of bind9 depending on what happened @NOTE launched as ROOT. More...
	hook_updatedomains_dns_del ($dominfo)
	Hook launched for each ZONE for which we want a zone DELETE remove the zone and its file, and if any action happened, ask for bind RECONFIG at posttime @NOTE launched as ROOT. More...
	hook_updatedomains_dns_post ()
	Hook function launched at the very end of updatedomains here, we just reload OR reconfig (or both) bind9 depending on what happened before. More...
	read_zone ($domain)
	read a zone file for $domain, More...
	conf_from_db ($domain)
	Return the part of the conf we got from the sub_domaines table. More...

Public Attributes
	$shouldreload
	$shouldreconfig
	$ZONE_TEMPLATE ="/etc/alternc/templates/bind/templates/zone.template"
	$NAMED_TEMPLATE ="/etc/alternc/templates/bind/templates/named.template"
	$NAMED_CONF ="/var/lib/alternc/bind/automatic.conf"
	$RNDC ="/usr/sbin/rndc"
	$zone_file_directory = '/var/lib/alternc/bind/zones'

Detailed Description

Manages BIND 9+ zone management templates in AlternC 3.5+.

Copyright

AlternC-Team 2000-2018 https://alternc.com/

Definition at line 26 of file m_bind.php.

Member Function Documentation

conf_from_db()

m_bind::conf_from_db

(

$domain

)

Return the part of the conf we got from the sub_domaines table.

Parameters

	global	m_mysql $db
string	$domain

Returns

string a zonefile excerpt

Definition at line 219 of file m_bind.php.

                                   {
        global $db;
        $db->query("
        SELECT 
          REPLACE(REPLACE(dt.entry,'%TARGET%',sd.valeur), '%SUB%', if(length(sd.sub)>0,sd.sub,'@')) AS ENTRY 
        FROM 
          sub_domaines sd,
          domaines_type dt 
        WHERE 
          sd.type=dt.name
          AND sd.enable IN ('ENABLE', 'ENABLED')
          AND sd.web_action NOT IN ('DELETE')
          AND sd.domaine = ?
        ORDER BY ENTRY ;", array($domain));
        $t="";
        while ($db->next_record()) {
            $t.= $db->f('ENTRY')."\n";
        }
        return $t;
    }

Referenced by hook_updatedomains_dns_add().

hook_updatedomains_dns_add()

m_bind::hook_updatedomains_dns_add

(

$dominfo

)

Hook launched for each ZONE for which we want a zone update (or create) update the zone, create it if necessary, and ask for reload or reconfig of bind9 depending on what happened @NOTE launched as ROOT.

Definition at line 56 of file m_bind.php.

                                                  {
        global $L_FQDN,$L_NS1_HOSTNAME,$L_NS2_HOSTNAME,$L_DEFAULT_MX,$L_DEFAULT_SECONDARY_MX,$L_PUBLIC_IP,$L_PUBLIC_IPV6;
 
        $domain = $dominfo["domaine"];
        $ttl = $dominfo["zonettl"];
 
        // does it already exist?
        if (file_exists($this->zone_file_directory."/".$domain)) {
            list($islocked,$serial,$more)=$this->read_zone($domain);
            $serial++; // only increment serial for new zones
        } else {
            $more="";
            $serial=date("Ymd")."00";
            $islocked=false;
        }
        if ($islocked) return 1;
 
        // Prepare a new zonefile from a template
        $zone = file_get_contents($this->ZONE_TEMPLATE);
 
        // add the SUBDOMAIN entries
        $zone .= $this->conf_from_db($domain);
 
        // substitute ALTERNC & domain variables
        $zone = strtr($zone, array(
            "%%fqdn%%" => "$L_FQDN",
            "%%ns1%%" => "$L_NS1_HOSTNAME",
            "%%ns2%%" => "$L_NS2_HOSTNAME",
            "%%DEFAULT_MX%%" => "$L_DEFAULT_MX",
            "%%DEFAULT_SECONDARY_MX%%" => "$L_DEFAULT_SECONDARY_MX",
            "@@fqdn@@" => "$L_FQDN",
            "@@ns1@@" => "$L_NS1_HOSTNAME",
            "@@ns2@@" => "$L_NS2_HOSTNAME",
            "@@DEFAULT_MX@@" => "$L_DEFAULT_MX",
            "@@DEFAULT_SECONDARY_MX@@" => "$L_DEFAULT_SECONDARY_MX",
            "@@DOMAINE@@" => $domain,
            "@@SERIAL@@" => $serial,
            "@@PUBLIC_IP@@" => "$L_PUBLIC_IP",
            "@@PUBLIC_IPV6@@" => "$L_PUBLIC_IPV6",
            "@@ZONETTL@@" => $ttl,
        ));
 
        // add the "END ALTERNC CONF line";
        $zone .= ";;; END ALTERNC AUTOGENERATE CONFIGURATION\n";
 
        // add the manually entered info:
        $zone .= $more;
        file_put_contents($this->zone_file_directory."/".$domain,$zone);
 
        // add the line into bind9 conf:
        if (add_line_to_file(
            $this->NAMED_CONF,
            trim(strtr(
                file_get_contents($this->NAMED_TEMPLATE),
                array(
                    "@@DOMAIN@@" => $domain,
                    "@@ZONE_FILE@@" => $this->zone_file_directory."/".$domain
                )
            )))
        ) {
            $this->shouldreconfig=true;
        } else {
            $this->shouldreload=true;
        }
        return 0;
    }

References conf_from_db(), and read_zone().

hook_updatedomains_dns_del()

m_bind::hook_updatedomains_dns_del

(

$dominfo

)

Hook launched for each ZONE for which we want a zone DELETE remove the zone and its file, and if any action happened, ask for bind RECONFIG at posttime @NOTE launched as ROOT.

Definition at line 131 of file m_bind.php.

                                                  {
        $domain = $dominfo["domaine"];
        if (del_line_from_file(
            $this->NAMED_CONF,
            trim(strtr(
                file_get_contents($this->NAMED_TEMPLATE),
                array(
                    "@@DOMAIN@@" => $domain,
                    "@@ZONE_FILE@@" => $this->zone_file_directory."/".$domain
                )
            )))
        ) {
            $this->shouldreconfig=true;
        } else {
            return 0;
        }
        @unlink($this->zone_file_directory."/".$domain);
        return 0;
    }

hook_updatedomains_dns_post()

m_bind::hook_updatedomains_dns_post

(

)

Hook function launched at the very end of updatedomains here, we just reload OR reconfig (or both) bind9 depending on what happened before.

@NOTE launched as ROOT

Definition at line 159 of file m_bind.php.

                                           {
        global $msg;
        if ($this->shouldreload) {
            $ret=0;
            exec($this->RNDC." reload 2>&1",$out,$ret);
            if ($ret!=0) {
                $msg->raise("ERROR","bind","Error while reloading bind, error code is $ret\n".implode("\n",$out));
            } else {
                $msg->raise("INFO","bind","Bind reloaded");
            }
        }
        if ($this->shouldreconfig) {
            $ret=0;
            exec($this->RNDC." reconfig 2>&1",$out,$ret);
            if ($ret!=0) {
                $msg->raise("ERROR","bind","Error while reconfiguring bind, error code is $ret\n".implode("\n",$out));
            } else {
                $msg->raise("INFO","bind","Bind reconfigured");
            }
        }
    }

hook_updatedomains_dns_pre()

m_bind::hook_updatedomains_dns_pre

(

)

Hook launched before any action by updatedomains initialize the reload/reconfig flags used by POST @NOTE launched as ROOT.

Definition at line 43 of file m_bind.php.

                                          {
        $this->shouldreload=false;
        $this->shouldreconfig=false;
    }

read_zone()

m_bind::read_zone

(

$domain

)

read a zone file for $domain,

Parameters

$domain

string the domain name

Returns

array with 3 informations: is the domain locked? (boolean), what's the current serial (integer), the data after alternc conf (string of lines)

Definition at line 189 of file m_bind.php.

                                {
        $f=fopen($this->zone_file_directory."/".$domain,"rb");
        $islocked=false;
        $more="";
        $serial=date("Ymd")."00";
        while ($s=fgets($f,4096)) {
            if (preg_match("#\;\s*LOCKED:YES#i",$s)) {
                $islocked=true;
            }
            if (preg_match("/\s*(\d{10})\s+\;\sserial\s?/", $s,$mat)) {
                $serial=$mat[1];
            }
            if (preg_match('/\;\s*END\sALTERNC\sAUTOGENERATE\sCONFIGURATION(.*)/s', $s)) {
                break;
            }
        }
        while ($s=fgets($f,4096)) {
            $more.=$s;
        }
        return array($islocked,$serial,$more);
    }

Referenced by hook_updatedomains_dns_add().

Member Data Documentation

$NAMED_CONF

m_bind::$NAMED_CONF ="/var/lib/alternc/bind/automatic.conf"

Definition at line 33 of file m_bind.php.

$NAMED_TEMPLATE

m_bind::$NAMED_TEMPLATE ="/etc/alternc/templates/bind/templates/named.template"

Definition at line 32 of file m_bind.php.

$RNDC

m_bind::$RNDC ="/usr/sbin/rndc"

Definition at line 34 of file m_bind.php.

$shouldreconfig

m_bind::$shouldreconfig

Definition at line 29 of file m_bind.php.

$shouldreload

m_bind::$shouldreload

Definition at line 28 of file m_bind.php.

$zone_file_directory

m_bind::$zone_file_directory = '/var/lib/alternc/bind/zones'

Definition at line 36 of file m_bind.php.

$ZONE_TEMPLATE

m_bind::$ZONE_TEMPLATE ="/etc/alternc/templates/bind/templates/zone.template"

Definition at line 31 of file m_bind.php.

---

The documentation for this class was generated from the following file:

• bureau/class/m_bind.php