Vanderlee\Comprehend\Library\Rfc4408

Complexity

Total Complexity

1

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	85	1

<?php /** @noinspection PhpUndefinedFieldInspection */


/**

 * RFC 4408 - Sender Policy Framework (SPF) for Authorizing Use of Domains in E-Mail, Version 1

 *

 * Updated by RFC 6652

 * Obsoleted by RFC 7208

 *

 * @see https://tools.ietf.org/html/rfc4408

 * @package Vanderlee\Comprehend\Library

 */


namespace Vanderlee\Comprehend\Library;


use Vanderlee\Comprehend\Builder\AbstractRuleset;

use Vanderlee\Comprehend\Parser\Parser;

use Vanderlee\Comprehend\Parser\Terminal\Integer;


require_once 'functions.php';


/**

 * Class Rfc4408

 *

 * ABNF in official RFC specs does not take into account left hand recursion issues.

 * Instances are fixed manually where appropriate.

 *

 * @property-read Parser record Complete SPF record

 * @property-read Parser version SPF version tag

 * @property-read Parser qnum Integer value between 0 and 255

 * @property-read Parser IP4 IPv4 address with optional CIDR range

 * @property-read Parser IP6 IPv6 address with optional CIDR range

 *

 * @package Vanderlee\Comprehend\Library

 */

class Rfc4408 extends AbstractRuleset

{

    protected static $name = 'Rfc4408';


    public function __construct($overwrites = [])

    {

        $abnf = new Rfc4234;


        $ipv6 = new Rfc3513;


        /*

         * Normal rules

         */

        $rules = [

            // 4.5. Selecting Records

            'record'           => [$this->version, $this->terms, $this->SP],

The property SP does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property terms does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'version'          => 'v=spf1',


            // 4.6.1. Term Evaluation

            'terms'            => star([plus($abnf->SP), c($this->directive, $this->modifier)]),

The property directive does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property modifier does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property SP does not exist on Vanderlee\Comprehend\Library\Rfc4234. Since you implemented __get, consider adding a @property annotation.

            'directive'        => [opt($this->qualifier), $this->mechanism],

The property mechanism does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property qualifier does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'qualifier'        => set('+-?~'),

            'mechanism'        => c($this->all, $this->include, $this->A, $this->MX, $this->PTR, $this->IP4, $this->IP6,

The property all does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property A does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property MX does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property PTR does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property include does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

                $this->exists), // @todo order?

The property exists does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'modifier'         => c($this->redirect, $this->explanation, $this->unknown_modifier),

The property redirect does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property explanation does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property unknown_modifier does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'unknown_modifier' => [$this->name, '=', $this->macro_string],

The property macro_string does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'name'             => [$abnf->ALPHA, star(c($abnf->ALPHA, $abnf->DIGIT, '-', '_', '.'))],


            // 5.1. "all"

            'all'              => 'all',


            // 5.2. "include"

            'include'          => ['include', ':', $this->domain_spec],

The property domain_spec does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            // 5.3. "a"

            'A'                => ['a', opt(s(':', $this->domain_spec)), opt($this->dual_cidr_length)],

The property dual_cidr_length does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            // 5.4. "mx"

            'MX'               => ['mx', opt(s(':', $this->domain_spec)), opt($this->dual_cidr_length)],


            // 5.5. "ptr"

            'PTR'              => ['ptr', ':', $this->domain_spec],


            // 5.6. "ip4" and "ip6"

            'IP4'              => ['ip4', ':', $this->ip4_network, opt($this->ip4_cidr_length)],

The property ip4_network does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property ip4_cidr_length does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'IP6'              => ['ip6', ':', $this->ip6_network, opt($this->ip6_cidr_length)],

The property ip6_network does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property ip6_cidr_length does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'ip4_cidr_length'  => ['/', plus($abnf->DIGIT)],

            'ip6_cidr_length'  => ['/', plus($abnf->DIGIT)],

            'dual_cidr_length' => [opt($this->ip4_cidr_length), opt(['/', $this->ip6_cidr_length])],

            'ip4_network'      => s($this->qnum, '.', $this->qnum, '.', $this->qnum, '.', $this->qnum),

            'qnum'             => new Integer(0, 255),

            'ip6_network'      => $ipv6->ipv6_address,


            // 5.7. "exists"

            'exists'           => ['exists', ':', $this->domain_spec],


            // 6.1. redirect: Redirected Query

            'redirect'         => ['redirect', '=', $this->domain_spec],


            // 6.2. exp: Explanation

            'explanation'      => ['exp', '=', $this->domain_spec],


            // 8. Macros

            'domain_spec'      => [$this->macro_string, $this->domain_end],

The property domain_end does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'domain_end'       => c(['.', $this->toplabel, opt('.')], $this->macro_expand),

The property toplabel does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property macro_expand does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'toplabel'         => c(

                [star($this->alphanum), $abnf->ALPHA, star($this->alphanum)],

The property alphanum does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

                [plus($this->alphanum), '=', star(c($this->alphanum, '-')), $this->alphanum]

            ), // LDH rule plus additional TLD restrictions (see [RFC3696], Section 2) @todo Read & implement

            'alphanum'         => c($abnf->ALPHA, $abnf->DIGIT),

            'explain_string'   => star(c($this->macro_string, $abnf->SP)),

            'macro_string'     => star(c($this->macro_expand, $this->macro_literal)),

The property macro_literal does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

            'macro_expand'     => c(

                ['%{', $this->macro_letter, $this->transformers, star($this->delimiter), '}'],

The property delimiter does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property transformers does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

The property macro_letter does not exist on Vanderlee\Comprehend\Library\Rfc4408. Since you implemented __get, consider adding a @property annotation.

                '%%', '%_', '%-'

            ),

            'macro_literal'    => c(range(0x21, 0x24), range(0x26, 0x7E)),

            'macro_letter'     => set('slodiphcrt'),

            'transformers'     => [star($abnf->DIGIT), opt('r')],

            'delimiter'        => set('.-+,/_='),


            // 7. The Received-SPF Header Field

            // Implement as separate ruleset?

            // Does it conflict with the record definition?


            self::ROOT => $this->record,

        ];


        parent::__construct(array_merge($rules, $overwrites));

    }

}