Badcow\DNS\Rdata\SOA

Complexity

Total Complexity

32

Size/Duplication

Total Lines	263
Duplicated Lines	0 %

Test Coverage

Coverage

96.7%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getRefresh()	0	3	1
A	getMname()	0	3	1
A	fromWire()	0	13	1
A	getExpire()	0	3	1
A	getRetry()	0	3	1
B	toText()	0	21	8
A	setRname()	0	3	1
A	setRefresh()	0	3	1
A	setSerial()	0	3	1
B	toWire()	0	22	8
A	getMinimum()	0	3	1
A	setRetry()	0	3	1
A	setMname()	0	3	1
A	getRname()	0	3	1
A	setMinimum()	0	3	1
A	fromText()	0	11	1
A	getSerial()	0	3	1
A	setExpire()	0	3	1

<?php

declare(strict_types=1);

/*
 * This file is part of Badcow DNS Library.
 *
 * (c) Samuel Williams <sam@badcow.co>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Badcow\DNS\Rdata;

use Badcow\DNS\Message;
use Badcow\DNS\Parser\TimeFormat;
use Badcow\DNS\Parser\Tokens;
use InvalidArgumentException;

/**
 * @see https://tools.ietf.org/html/rfc1035#section-3.3.13
 */
class SOA implements RdataInterface
{
    use RdataTrait;

    const TYPE = 'SOA';
    const TYPE_CODE = 6;

    /**
     * The <domain-name> of the name server that was the
     * original or primary source of data for this zone.
     *
     * @var string|null
     */
    private $mname;

    /**
     * A <domain-name> which specifies the mailbox of the
     * person responsible for this zone.
     *
     * @var string|null
     */
    private $rname;

    /**
     * The unsigned 32 bit version number of the original copy
     * of the zone.
     *
     * @var int|null
     */
    private $serial;

    /**
     * A 32 bit time interval before the zone should be
     * refreshed.
     *
     * @var int|null
     */
    private $refresh;

    /**
     * A 32 bit time interval that should elapse before a
     * failed refresh should be retried.
     *
     * @var int|null
     */
    private $retry;

    /**
     * A 32 bit time value that specifies the upper limit on
     * the time interval that can elapse before the zone is no
     * longer authoritative.
     *
     * @var int|null
     */
    private $expire;

    /**
     * The unsigned 32 bit minimum TTL field that should be
     * exported with any RR from this zone.
     *
     * @var int|null
     */
    private $minimum;

    /**
     * @param int $expire
     */
    public function setExpire(int $expire): void
    {
        $this->expire = $expire;
    }

    /**
     * @return int
     */
    public function getExpire(): ?int
    {
        return $this->expire;
    }

    /**
     * @param int $minimum
     */
    public function setMinimum(int $minimum): void
    {
        $this->minimum = $minimum;
    }

    /**
     * @return int
     */
    public function getMinimum(): ?int
    {
        return $this->minimum;
    }

    /**
     * @param string $mname
     */
    public function setMname(string $mname): void
    {
        $this->mname = $mname;
    }

    /**
     * @return string
     */
    public function getMname(): ?string
    {
        return $this->mname;
    }

    /**
     * @param int $refresh
     */
    public function setRefresh(int $refresh): void
    {
        $this->refresh = $refresh;
    }

    /**
     * @return int
     */
    public function getRefresh(): ?int
    {
        return $this->refresh;
    }

    /**
     * @param int $retry
     */
    public function setRetry(int $retry): void
    {
        $this->retry = (int) $retry;
    }

    /**
     * @return int
     */
    public function getRetry(): ?int
    {
        return $this->retry;
    }

    /**
     * @param string $rname
     */
    public function setRname(string $rname): void
    {
        $this->rname = $rname;
    }

    /**
     * @return string
     */
    public function getRname(): ?string
    {
        return $this->rname;
    }

    /**
     * @param int $serial
     */
    public function setSerial(int $serial): void
    {
        $this->serial = $serial;
    }

    /**
     * @return int
     */
    public function getSerial(): ?int
    {
        return $this->serial;
    }

    /**
     * {@inheritdoc}
     */
    public function toText(): string
    {
        if (!isset($this->mname) ||
            !isset($this->rname) ||
            !isset($this->serial) ||
            !isset($this->refresh) ||
            !isset($this->retry) ||
            !isset($this->expire) ||
            !isset($this->minimum)) {
            throw new InvalidArgumentException('All parameters of SOA must be set.');
        }

        return sprintf(
            '%s %s %s %s %s %s %s',
            $this->mname,
            $this->rname,
            $this->serial,
            $this->refresh,
            $this->retry,
            $this->expire,
            $this->minimum
        );
    }

    /**
     * {@inheritdoc}
     */
    public function toWire(): string
    {
        if (!isset($this->mname) ||
            !isset($this->rname) ||
            !isset($this->serial) ||
            !isset($this->refresh) ||
            !isset($this->retry) ||
            !isset($this->expire) ||
            !isset($this->minimum)) {
            throw new InvalidArgumentException('All parameters of SOA must be set.');
        }

        return
            Message::encodeName($this->mname).

It seems like $this->mname can also be of type null; however, parameter $name of Badcow\DNS\Message::encodeName() does only seem to accept string, maybe add an additional type check?

            Message::encodeName($this->rname).
            pack(
                'NNNNN',
                $this->serial,
                $this->refresh,
                $this->retry,
                $this->expire,
                $this->minimum
            );
    }

    /**
     * {@inheritdoc}
     */
    public function fromText(string $text): void
    {
        $rdata = explode(Tokens::SPACE, $text);

        $this->setMname($rdata[0]);
        $this->setRname($rdata[1]);
        $this->setSerial((int) $rdata[2]);
        $this->setRefresh(TimeFormat::toSeconds($rdata[3]));
        $this->setRetry(TimeFormat::toSeconds($rdata[4]));
        $this->setExpire(TimeFormat::toSeconds($rdata[5]));
        $this->setMinimum(TimeFormat::toSeconds($rdata[6]));
    }

    /**
     * {@inheritdoc}
     */
    public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
    {
        $this->setMname(Message::decodeName($rdata, $offset));
        $this->setRname(Message::decodeName($rdata, $offset));
        $parameters = unpack('Nserial/Nrefresh/Nretry/Nexpire/Nminimum', $rdata, $offset);

        $this->setSerial((int) $parameters['serial']);
        $this->setRefresh(TimeFormat::toSeconds($parameters['refresh']));
        $this->setRetry(TimeFormat::toSeconds($parameters['retry']));
        $this->setExpire(TimeFormat::toSeconds($parameters['expire']));
        $this->setMinimum(TimeFormat::toSeconds($parameters['minimum']));

        $offset += 20;
    }
}