PartialUserFormController::uploadFile() - Code Metrics - Inspection of "Solves #15 Safe files to partial submissions" - Firesphere/silverstripe-partial-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Simon

created 2019-08-22 05:34 UTC

PartialUserFormController::uploadFile() A

↳ Parent: PartialUserFormController

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	9.536
c	0
b	0
f	0
cc	4
nc	4
nop	2

<?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 = [

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

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

        '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();


            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);
        }
    }
}


1			<?php
2
3			namespace Firesphere\PartialUserforms\Controllers;
4
5			use Exception;
6			use Firesphere\PartialUserforms\Models\PartialFieldSubmission;
7			use Firesphere\PartialUserforms\Models\PartialFileFieldSubmission;
8			use Firesphere\PartialUserforms\Models\PartialFormSubmission;
9			use SilverStripe\Assets\File;
10			use SilverStripe\Assets\Upload;
11			use SilverStripe\CMS\Controllers\ContentController;
12			use SilverStripe\Control\Controller;
13			use SilverStripe\Control\HTTPRequest;
14			use SilverStripe\Control\HTTPResponse_Exception;
15			use SilverStripe\ORM\DataObject;
16			use SilverStripe\ORM\FieldType\DBHTMLText;
17			use SilverStripe\ORM\ValidationException;
18			use SilverStripe\ORM\ValidationResult;
19			use SilverStripe\UserForms\Control\UserDefinedFormController;
20			use SilverStripe\UserForms\Model\EditableFormField;
21			use SilverStripe\View\Requirements;
22
23			/**
24			* Class PartialUserFormController
25			*
26			* @package Firesphere\PartialUserforms\Controllers
27			*/
28			class PartialUserFormController extends ContentController
29			{
30			/**
31			* Session key name
32			*/
33			const SESSION_KEY = 'PartialSubmissionID';
34
35			/**
36			* @var array
37			*/
38			private static $url_handlers = [
			0 ignored issues – show Comprehensibility introduced 2018-05-08 23:26 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
39			'save' => 'savePartialSubmission',
40			'$Key/$Token' => 'partial',
41			];
42
43			/**
44			* @var array
45			*/
46			private static $allowed_actions = [
			0 ignored issues – show Comprehensibility introduced 2018-05-08 23:26 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
47			'savePartialSubmission',
48			'partial',
49			];
50
51			/**
52			* @param HTTPRequest $request
53			* @return int\|mixed\|void
54			* @throws ValidationException
55			* @throws HTTPResponse_Exception
56			*/
57			public function savePartialSubmission(HTTPRequest $request)
58			{
59			if (!$request->isPOST()) {
60			return $this->httpError(404);
61			}
62
63			$postVars = $request->postVars();
64			$editableField = null;
65
66			// We don't want SecurityID and/or the process Action stored as a thing
67			unset($postVars['SecurityID'], $postVars['action_process']);
68			$submissionID = $request->getSession()->get(self::SESSION_KEY);
69
70			/** @var PartialFormSubmission $partialSubmission */
71			$partialSubmission = PartialFormSubmission::get()->byID($submissionID);
72
73			if (!$submissionID \|\| !$partialSubmission) {
74			$partialSubmission = PartialFormSubmission::create();
75			$submissionID = $partialSubmission->write();
76			}
77			$request->getSession()->set(self::SESSION_KEY, $submissionID);
78			foreach ($postVars as $field => $value) {
79			/** @var EditableFormField $editableField */
80			$editableField = $this->createOrUpdateSubmission([
81			'Name' => $field,
82			'Value' => $value,
83			'SubmittedFormID' => $submissionID
84			]);
85			}
86
87			if ($editableField instanceof EditableFormField && !$partialSubmission->UserDefinedFormID) {
88			$partialSubmission->update([
89			'UserDefinedFormID' => $editableField->Parent()->ID,
90			'ParentID' => $editableField->Parent()->ID,
91			'ParentClass' => $editableField->Parent()->ClassName,
92			'UserDefinedFormClass' => $editableField->Parent()->ClassName
93			]);
94			$partialSubmission->write();
95			}
96
97			return $submissionID;
98			}
99
100			/**
101			* @param $formData
102			* @return DataObject\|EditableFormField
103			* @throws ValidationException
104			*/
105			protected function createOrUpdateSubmission($formData)
106			{
107			$filter = [
108			'Name' => $formData['Name'],
109			'SubmittedFormID' => $formData['SubmittedFormID'],
110			];
111
112			// Set the title
113			/** @var EditableFormField $editableField */
114			$editableField = EditableFormField::get()->filter(['Name' => $formData['Name']])->first();
115			if ($editableField instanceof EditableFormField\EditableFileField) {
116			$this->savePartialFile($formData, $filter, $editableField);
117			} elseif ($editableField instanceof EditableFormField) {
118			$this->savePartialField($formData, $filter, $editableField);
119			}
120
121			// Return the ParentID to link the PartialSubmission to it's proper thingy
122			return $editableField;
123			}
124
125			/**
126			* @param $formData
127			* @param array $filter
128			* @param EditableFormField\EditableFileField $editableField
129			* @throws ValidationException
130			* @throws Exception
131			*/
132			protected function savePartialFile($formData, array $filter, EditableFormField\EditableFileField $editableField)
133			{
134			$partialFileSubmission = PartialFileFieldSubmission::get()->filter($filter)->first();
135			$partialData = [];
136			// Don't overwrite existing uploads
137			if (!$partialFileSubmission) {
138			if ($editableField) {
139			$partialData['Title'] = $editableField->Title;
140			$partialData['ParentClass'] = $editableField->Parent()->ClassName;
141			}
142			}
143			if (is_array($formData['Value']) && !$partialFileSubmission->UploadedFileID) {
144			$file = $this->uploadFile($partialData, $editableField);
145			$formData['UploadedFileID'] = $file->ID ?? 0;
146			$partialFileSubmission = PartialFileFieldSubmission::create($partialData);
147			}
148			$partialFileSubmission->write();
149			}
150
151			/**
152			* @param array $formData
153			* @param EditableFormField\EditableFileField $field
154			* @return File\|void
155			* @throws Exception
156			*/
157			protected function uploadFile($formData, $field)
158			{
159			if (!empty($formData['Value']['name'])) {
160			$foldername = $field->getFormField()->getFolderName();
161
162			// create the file from post data
163			$upload = Upload::create();
164			$file = File::create();
165			$file->ShowInSearch = 0;
166			try {
167			$upload->loadIntoFile($formData['Value'], $file, $foldername);
168			} catch (ValidationException $e) {
169			$validationResult = $e->getResult();
170			foreach ($validationResult->getMessages() as $message) {
171			$field->Parent()->sessionMessage($message['message'], ValidationResult::TYPE_ERROR);
172			}
173			Controller::curr()->redirectBack();
174
175			return;
176			}
177
178			return $file;
179			}
180			}
181
182			/**
183			* @param $formData
184			* @param array $filter
185			* @param EditableFormField $editableField
186			* @throws ValidationException
187			*/
188			protected function savePartialField($formData, array $filter, EditableFormField $editableField)
189			{
190			$exists = PartialFieldSubmission::get()->filter($filter)->first();
191			if (is_array($formData['Value'])) {
192			$formData['Value'] = implode(', ', $formData['Value']);
193			}
194			if ($editableField) {
195			$formData['Title'] = $editableField->Title;
196			$formData['ParentClass'] = $editableField->Parent()->ClassName;
197			}
198			if (!$exists) {
199			$exists = PartialFieldSubmission::create($formData);
200			} else {
201			$exists->update($formData);
202			}
203			$exists->write();
204			}
205
206			/**
207			* Partial form
208			*
209			* @param HTTPRequest $request
210			* @return DBHTMLText\|void
211			* @throws HTTPResponse_Exception
212			*/
213			public function partial(HTTPRequest $request)
214			{
215			$key = $request->param('Key');
216			$token = $request->param('Token');
217
218			$partial = PartialFormSubmission::get()->find('Token', $token);
219			if (!$token \|\| !$partial \|\| !$partial->UserDefinedFormID) {
220			return $this->httpError(404);
221			}
222
223			if ($partial->generateKey($token) === $key) {
224			// Set the session if the last session has expired
225			if (!$request->getSession()->get(self::SESSION_KEY)) {
226			$request->getSession()->set(self::SESSION_KEY, $partial->ID);
227			}
228
229			// TODO: Recognize visitor with the password
230			// TODO: Populate form values
231
232			$record = DataObject::get_by_id($partial->UserDefinedFormClass, $partial->UserDefinedFormID);
233			$controller = new UserDefinedFormController($record);
234			$controller->init();
			0 ignored issues – show Bug introduced 2019-08-21 04:51 UTC by Report Bug Copy Issue Report The method `init()` cannot be called from this context as it is declared protected in class `SilverStripe\UserForms\C...erDefinedFormController`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history...
235
236			Requirements::javascript('firesphere/partialuserforms:client/dist/main.js');
237
238			return $this->customise([
239			'Title' => $record->Title,
240			'Breadcrumbs' => $record->Breadcrumbs(),
241			'Content' => $this->obj('Content'),
242			'Form' => $controller->Form(),
243			'Link' => $partial->getPartialLink()
244			])->renderWith(['PartialUserForm', 'Page']);
245			} else {
246			return $this->httpError(404);
247			}
248			}
249			}
250

Firesphere / silverstripe-partial-userforms

Pull Request — master (#16)

PartialUserFormController::uploadFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like