Firesphere\PartialUserforms\Controllers\PartialUserFormController

Complexity

Total Complexity

29

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	17

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	savePartialSubmission()	0	42	7
A	createOrUpdateSubmission()	0	19	3
A	savePartialFile()	0	18	5
A	uploadFile()	0	24	4
A	savePartialField()	0	17	4
B	partial()	0	36	6

<?php

namespace Firesphere\PartialUserforms\Controllers;

use Exception;
use Firesphere\PartialUserforms\Models\PartialFieldSubmission;
use Firesphere\PartialUserforms\Models\PartialFileFieldSubmission;
use Firesphere\PartialUserforms\Models\PartialFormSubmission;
use SilverStripe\Assets\File;
use SilverStripe\Assets\Upload;
use SilverStripe\CMS\Controllers\ContentController;
use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse_Exception;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBHTMLText;
use SilverStripe\ORM\ValidationException;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\UserForms\Control\UserDefinedFormController;
use SilverStripe\UserForms\Model\EditableFormField;
use SilverStripe\View\Requirements;

/**
 * Class PartialUserFormController
 *
 * @package Firesphere\PartialUserforms\Controllers
 */
class PartialUserFormController extends ContentController
{
    /**
     * Session key name
     */
    const SESSION_KEY = 'PartialSubmissionID';

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

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

        'save'        => 'savePartialSubmission',
        '$Key/$Token' => 'partial',
    ];

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

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

        'savePartialSubmission',
        'partial',
    ];

    /**
     * @param HTTPRequest $request
     * @return int|mixed|void
     * @throws ValidationException
     * @throws HTTPResponse_Exception
     */
    public function savePartialSubmission(HTTPRequest $request)
    {
        if (!$request->isPOST()) {
            return $this->httpError(404);
        }

        $postVars = $request->postVars();
        $editableField = null;

        // We don't want SecurityID and/or the process Action stored as a thing
        unset($postVars['SecurityID'], $postVars['action_process']);
        $submissionID = $request->getSession()->get(self::SESSION_KEY);

        /** @var PartialFormSubmission $partialSubmission */
        $partialSubmission = PartialFormSubmission::get()->byID($submissionID);

        if (!$submissionID || !$partialSubmission) {
            $partialSubmission = PartialFormSubmission::create();
            $submissionID = $partialSubmission->write();
        }
        $request->getSession()->set(self::SESSION_KEY, $submissionID);
        foreach ($postVars as $field => $value) {
            /** @var EditableFormField $editableField */
            $editableField = $this->createOrUpdateSubmission([
                'Name'            => $field,
                'Value'           => $value,
                'SubmittedFormID' => $submissionID
            ]);
        }

        if ($editableField instanceof EditableFormField && !$partialSubmission->UserDefinedFormID) {
            $partialSubmission->update([
                'UserDefinedFormID'    => $editableField->Parent()->ID,
                'ParentID'             => $editableField->Parent()->ID,
                'ParentClass'          => $editableField->Parent()->ClassName,
                'UserDefinedFormClass' => $editableField->Parent()->ClassName
            ]);
            $partialSubmission->write();
        }

        return $submissionID;
    }

    /**
     * @param $formData
     * @return DataObject|EditableFormField
     * @throws ValidationException
     */
    protected function createOrUpdateSubmission($formData)
    {
        $filter = [
            'Name'            => $formData['Name'],
            'SubmittedFormID' => $formData['SubmittedFormID'],
        ];

        // Set the title
        /** @var EditableFormField $editableField */
        $editableField = EditableFormField::get()->filter(['Name' => $formData['Name']])->first();
        if ($editableField instanceof EditableFormField\EditableFileField) {
            $this->savePartialFile($formData, $filter, $editableField);
        } elseif ($editableField instanceof EditableFormField) {
            $this->savePartialField($formData, $filter, $editableField);
        }

        // Return the ParentID to link the PartialSubmission to it's proper thingy
        return $editableField;
    }

    /**
     * @param $formData
     * @param array $filter
     * @param EditableFormField\EditableFileField $editableField
     * @throws ValidationException
     * @throws Exception
     */
    protected function savePartialFile($formData, array $filter, EditableFormField\EditableFileField $editableField)
    {
        $partialFileSubmission = PartialFileFieldSubmission::get()->filter($filter)->first();
        $partialData = [];
        // Don't overwrite existing uploads
        if (!$partialFileSubmission) {
            if ($editableField) {
                $partialData['Title'] = $editableField->Title;
                $partialData['ParentClass'] = $editableField->Parent()->ClassName;
            }
        }
        if (is_array($formData['Value']) && !$partialFileSubmission->UploadedFileID) {
            $file = $this->uploadFile($partialData, $editableField);
            $formData['UploadedFileID'] = $file->ID ?? 0;
            $partialFileSubmission = PartialFileFieldSubmission::create($partialData);
        }
        $partialFileSubmission->write();
    }

    /**
     * @param array $formData
     * @param EditableFormField\EditableFileField $field
     * @return File|void
     * @throws Exception
     */
    protected function uploadFile($formData, $field)
    {
        if (!empty($formData['Value']['name'])) {
            $foldername = $field->getFormField()->getFolderName();

            // create the file from post data
            $upload = Upload::create();
            $file = File::create();
            $file->ShowInSearch = 0;
            try {
                $upload->loadIntoFile($formData['Value'], $file, $foldername);
            } catch (ValidationException $e) {
                $validationResult = $e->getResult();
                foreach ($validationResult->getMessages() as $message) {
                    $field->Parent()->sessionMessage($message['message'], ValidationResult::TYPE_ERROR);
                }
                Controller::curr()->redirectBack();

                return;
            }

            return $file;
        }
    }

    /**
     * @param $formData
     * @param array $filter
     * @param EditableFormField $editableField
     * @throws ValidationException
     */
    protected function savePartialField($formData, array $filter, EditableFormField $editableField)
    {
        $exists = PartialFieldSubmission::get()->filter($filter)->first();
        if (is_array($formData['Value'])) {
            $formData['Value'] = implode(', ', $formData['Value']);
        }
        if ($editableField) {
            $formData['Title'] = $editableField->Title;
            $formData['ParentClass'] = $editableField->Parent()->ClassName;
        }
        if (!$exists) {
            $exists = PartialFieldSubmission::create($formData);
        } else {
            $exists->update($formData);
        }
        $exists->write();
    }

    /**
     * Partial form
     *
     * @param HTTPRequest $request
     * @return DBHTMLText|void
     * @throws HTTPResponse_Exception
     */
    public function partial(HTTPRequest $request)
    {
        $key = $request->param('Key');
        $token = $request->param('Token');

        $partial = PartialFormSubmission::get()->find('Token', $token);
        if (!$token || !$partial || !$partial->UserDefinedFormID) {
            return $this->httpError(404);
        }

        if ($partial->generateKey($token) === $key) {
            // Set the session if the last session has expired
            if (!$request->getSession()->get(self::SESSION_KEY)) {
                $request->getSession()->set(self::SESSION_KEY, $partial->ID);
            }

            // TODO: Recognize visitor with the password
            // TODO: Populate form values

            $record = DataObject::get_by_id($partial->UserDefinedFormClass, $partial->UserDefinedFormID);
            $controller = new UserDefinedFormController($record);
            $controller->init();

The method init() cannot be called from this context as it is declared protected in class SilverStripe\UserForms\Control\UserDefinedFormController.

            Requirements::javascript('firesphere/partialuserforms:client/dist/main.js');

            return $this->customise([
                'Title'       => $record->Title,
                'Breadcrumbs' => $record->Breadcrumbs(),
                'Content'     => $this->obj('Content'),
                'Form'        => $controller->Form(),
                'Link'        => $partial->getPartialLink()
            ])->renderWith(['PartialUserForm', 'Page']);
        } else {
            return $this->httpError(404);
        }
    }
}