Firesphere\PartialUserforms\Models\PartialFormSubmission

Complexity

Total Complexity

18

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	16

Test Coverage

Coverage

96.72%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	49	1
A	getPartialLink()	0	15	2
A	generateKey()	0	4	1
A	onBeforeWrite()	0	8	2
A	getPartialToken()	0	9	2
A	generateToken()	0	6	1
A	generatePassword()	0	12	1
A	getParent()	0	4	1
A	canCreate()	0	4	1
A	canView()	0	8	2
A	canEdit()	0	8	2
A	canDelete()	0	8	2

<?php

namespace Firesphere\PartialUserforms\Models;

use Exception;
use Firesphere\PartialUserforms\Controllers\PartialUserFormVerifyController;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldButtonRow;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\Forms\GridField\GridFieldExportButton;
use SilverStripe\Forms\GridField\GridFieldPrintButton;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Member;
use SilverStripe\Security\RandomGenerator;
use SilverStripe\UserForms\Model\Submission\SubmittedForm;
use SilverStripe\UserForms\Model\UserDefinedForm;

/**
 * Class \Firesphere\PartialUserforms\Models\PartialFormSubmission
 *
 * @property boolean $IsSend
 * @property string $TokenSalt
 * @property string $Token
 * @property string $Password
 * @property int $UserDefinedFormID
 * @method DataObject UserDefinedForm()
 * @method DataList|PartialFieldSubmission[] PartialFields()
 * @method DataList|PartialFileFieldSubmission[] PartialUploads()
 */
class PartialFormSubmission extends SubmittedForm
{

    /**
     * @var string
     */
    private static $table_name = 'PartialFormSubmission';

Consider using a different property name as you override a private property of the parent class.

    /**
     * @var array
     */
    private static $db = [

Consider using a different property name as you override a private property of the parent class.

        'IsSend'    => 'Boolean(false)',
        'TokenSalt' => 'Varchar(16)',
        'Token'     => 'Varchar(16)',
        'Password'  => 'Varchar(64)',
    ];

    /**
     * @var array
     */
    private static $has_one = [

Consider using a different property name as you override a private property of the parent class.

        'UserDefinedForm' => DataObject::class
    ];

    /**
     * @var array
     */
    private static $has_many = [

Consider using a different property name as you override a private property of the parent class.

        'PartialFields'  => PartialFieldSubmission::class,
        'PartialUploads' => PartialFileFieldSubmission::class
    ];

    private static $cascade_deletes = [

Consider using a different property name as you override a private property of the parent class.

        'PartialFields'
    ];

    /**
     * @var array
     */
    private static $summary_fields = [

Consider using a different property name as you override a private property of the parent class.

        'ID'          => 'ID',
        'PartialLink' => 'Link',
        'Created'     => 'Created',
        'LastEdited'  => 'Last Edited',
    ];

    private static $special_characters = [
        '!',
        '@',
        '#',
        '$',
        '%',
        '^',
        '&',
        '*',
        '(',
        ')',
        '_',
        '-',
        '=',
        '+',
        ';',
        ':',
        ',',
        '.',
        '?'
    ];

    /**
     * @return FieldList
     * @throws Exception
     */
    public function getCMSFields()
    {
        /** @var FieldList $fields */
        $fields = parent::getCMSFields();
        $fields->removeByName([
            'Values',
            'IsSend',
            'PartialFields',
            'TokenSalt',
            'Token',
            'UserDefinedFormID',
            'Submitter',
            'PartialUploads'
        ]);

        $partialFields = $this->PartialFields();
        $fileFields = $this->PartialUploads();
        $list = ArrayList::create();
        $list->merge($partialFields);
        $list->merge($fileFields);

        $partialFields = GridField::create(
            'PartialFields',
            _t(static::class . '.PARTIALFIELDS', 'Partial fields'),
            $list->sort('Created', 'ASC')
        );

        $exportColumns = [
            'Title'       => 'Title',
            'ExportValue' => 'Value'
        ];

        $config = new GridFieldConfig();
        $config->addComponent(new GridFieldDataColumns());
        $config->addComponent(new GridFieldButtonRow('after'));
        $config->addComponent(new GridFieldExportButton('buttons-after-left', $exportColumns));
        $config->addComponent(new GridFieldPrintButton('buttons-after-left'));
        $partialFields->setConfig($config);

        $fields->addFieldsToTab(
            'Root.Main',
            [
                ReadonlyField::create('ReadonlyPartialLink', 'Partial Link', $this->getPartialLink()),
                $partialFields
            ]
        );

        return $fields;
    }

    /**
     * Get the share link of the form
     *
     * @return string
     * @throws Exception
     */
    public function getPartialLink()
    {
        if (!$this->isInDB()) {
            return '(none)';
        }

        $token = $this->Token;

        return Controller::join_links(
            Director::absoluteBaseURL(),
            'partial',
            $this->generateKey($token),

It seems like $token defined by $this->Token on line 172 can also be of type boolean; however, Firesphere\PartialUserforms\Models\PartialFormSubmission::generateKey() does only seem to accept string, maybe add an additional type check?

            $token
        );
    }

    /**
     * Generate a key based on the share token salt
     *
     * @param string $token
     * @return mixed
     */
    public function generateKey($token)
    {
        return hash_pbkdf2('sha256', $token, $this->TokenSalt, 1000, 16);
    }

    /**
     * Generate the partial tokens
     * If the submission is password protected, generate a password.
     * @throws Exception
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        $this->getPartialToken();
        if (!$this->Password) {
            $this->Password = $this->generatePassword();
        }
    }

    /**
     * Get the unique token for the share link
     *
     * @return bool|string|null
     * @throws Exception
     */
    protected function getPartialToken()
    {
        if (!$this->TokenSalt) {
            $this->TokenSalt = $this->generateToken();
            $this->Token = $this->generateToken();
        }

        return $this->Token;
    }

    /**
     * Generate a new token
     *
     * @return bool|string
     * @throws Exception
     */
    protected function generateToken()
    {
        $generator = new RandomGenerator();

        return substr($generator->randomToken('sha256'), 0, 16);
    }

    /**
     * @return string
     * @throws Exception
     */
    protected function generatePassword()
    {
        $chars = range('A', 'Z');
        $chars = array_merge($chars, range('a', 'z'));
        $chars = array_merge($chars, range(0, 9));
        $chars = array_merge($chars, self::$special_characters);
        shuffle($chars);
        $pwd = implode(array_slice($chars, 0, 10));
        Controller::curr()->getRequest()->getSession()->set(PartialUserFormVerifyController::PASSWORD_KEY, $pwd);

        return hash_pbkdf2('SHA256', $pwd, $this->TokenSalt, 1000);
    }

    /**
     * @return DataObject|UserDefinedForm
     */
    public function getParent()
    {
        return $this->UserDefinedForm();
    }

    /**
     * @param Member
     *
     * @return bool|string|null
     * @throws Exception
     */
    public function canCreate($member = null, $context = [])
    {
        return false;
    }

    /**
     * @param Member $member
     *
     * @return boolean|string
     */
    public function canView($member = null)
    {
        if ($this->UserDefinedForm()) {
            return $this->UserDefinedForm()->canView($member);

The expression $this->UserDefinedForm()->canView($member); of type boolean|string adds the type string to the return on line 280 which is incompatible with the return type of the parent method SilverStripe\UserForms\Model\Submission\SubmittedForm::canView of type boolean.

        }

        return parent::canView($member);
    }

    /**
     * @param Member $member
     *
     * @throws Exception
     * @return boolean|string
     */
    public function canEdit($member = null)
    {
        if ($this->UserDefinedForm()) {
            return $this->UserDefinedForm()->canEdit($member);

The expression $this->UserDefinedForm()->canEdit($member); of type boolean|string adds the type string to the return on line 295 which is incompatible with the return type of the parent method SilverStripe\UserForms\Model\Submission\SubmittedForm::canEdit of type boolean.

        }

        return parent::canEdit($member);
    }

    /**
     * @param Member $member
     *
     * @return boolean|string
     */
    public function canDelete($member = null)
    {
        if ($this->UserDefinedForm()) {
            return $this->UserDefinedForm()->canDelete($member);

The expression $this->UserDefinedForm()->canDelete($member); of type boolean|string adds the type string to the return on line 309 which is incompatible with the return type of the parent method SilverStripe\UserForms\Model\Submission\SubmittedForm::canDelete of type boolean.

        }

        return parent::canDelete($member);
    }
}