2022-09-20 19:59:52 +00:00
< ? php
namespace App\Jobs\Form ;
use App\Events\Forms\FormSubmitted ;
use App\Http\Controllers\Forms\PublicFormController ;
2023-10-20 09:00:35 +00:00
use App\Http\Controllers\Forms\FormController ;
2022-09-20 19:59:52 +00:00
use App\Http\Requests\AnswerFormRequest ;
use App\Models\Forms\Form ;
2023-01-10 13:52:14 +00:00
use App\Models\Forms\FormSubmission ;
2023-11-28 10:31:57 +00:00
use App\Service\Forms\FormLogicPropertyResolver ;
2022-09-20 19:59:52 +00:00
use App\Service\Storage\StorageFileNameParser ;
use Illuminate\Bus\Queueable ;
use Illuminate\Contracts\Filesystem\Filesystem ;
use Illuminate\Contracts\Queue\ShouldQueue ;
use Illuminate\Foundation\Bus\Dispatchable ;
use Illuminate\Queue\InteractsWithQueue ;
use Illuminate\Queue\SerializesModels ;
use Illuminate\Support\Facades\Storage ;
use Illuminate\Support\Str ;
2023-01-10 13:52:14 +00:00
use Vinkla\Hashids\Facades\Hashids ;
2022-09-20 19:59:52 +00:00
class StoreFormSubmissionJob implements ShouldQueue
{
use Dispatchable , InteractsWithQueue , Queueable , SerializesModels ;
2023-01-10 13:52:14 +00:00
public ? string $submissionId = null ;
2022-09-20 19:59:52 +00:00
/**
* Create a new job instance .
*
* @ return void
*/
public function __construct ( public Form $form , public array $submissionData )
{
}
/**
* Execute the job .
*
* @ return void
*/
public function handle ()
{
$formData = $this -> getFormData ();
$this -> addHiddenPrefills ( $formData );
2023-01-10 13:52:14 +00:00
$this -> storeSubmission ( $formData );
2022-09-20 19:59:52 +00:00
2023-02-19 12:12:13 +00:00
$formData [ " submission_id " ] = $this -> submissionId ;
2022-09-20 19:59:52 +00:00
FormSubmitted :: dispatch ( $this -> form , $formData );
}
2023-01-10 13:52:14 +00:00
public function getSubmissionId ()
{
return $this -> submissionId ;
}
private function storeSubmission ( array $formData )
{
// Create or update record
if ( $previousSubmission = $this -> submissionToUpdate ()) {
$previousSubmission -> data = $formData ;
$previousSubmission -> save ();
$this -> submissionId = $previousSubmission -> id ;
} else {
$response = $this -> form -> submissions () -> create ([
'data' => $formData ,
]);
$this -> submissionId = $response -> id ;
}
}
/**
* Search for Submission record to update and returns it
*/
private function submissionToUpdate () : ? FormSubmission
{
if ( $this -> form -> editable_submissions && isset ( $this -> submissionData [ 'submission_id' ]) && $this -> submissionData [ 'submission_id' ]) {
$submissionId = $this -> submissionData [ 'submission_id' ] ? Hashids :: decode ( $this -> submissionData [ 'submission_id' ]) : false ;
$submissionId = $submissionId [ 0 ] ? ? null ;
return $this -> form -> submissions () -> findOrFail ( $submissionId );
}
return null ;
}
2022-09-20 19:59:52 +00:00
/**
* Retrieve data from request object , and pre - format it if needed .
* - Replace notionforms id with notion field ids
* - Clean \ in select id values
* - Stores file and replace value with url
* - Generate auto increment id & unique id features for rich text field
*/
private function getFormData ()
{
$data = $this -> submissionData ;
$finalData = [];
$properties = collect ( $this -> form -> properties );
// Do required transformation per type (e.g. file uploads)
foreach ( $data as $answerKey => $answerValue ) {
$field = $properties -> where ( 'id' , $answerKey ) -> first ();
if ( ! $field ) {
continue ;
}
if (
( $field [ 'type' ] == 'url' && isset ( $field [ 'file_upload' ]) && $field [ 'file_upload' ])
|| $field [ 'type' ] == 'files' ) {
if ( is_array ( $answerValue )) {
$finalData [ $field [ 'id' ]] = [];
foreach ( $answerValue as $file ) {
$finalData [ $field [ 'id' ]][] = $this -> storeFile ( $file );
}
} else {
$finalData [ $field [ 'id' ]] = $this -> storeFile ( $answerValue );
}
} else {
if ( $field [ 'type' ] == 'text' && isset ( $field [ 'generates_uuid' ]) && $field [ 'generates_uuid' ]) {
$finalData [ $field [ 'id' ]] = ( $this -> form -> is_pro ) ? Str :: uuid () : " Please upgrade your OpenForm subscription to use our ID generation features " ;
} else {
if ( $field [ 'type' ] == 'text' && isset ( $field [ 'generates_auto_increment_id' ]) && $field [ 'generates_auto_increment_id' ]) {
$finalData [ $field [ 'id' ]] = ( $this -> form -> is_pro ) ? ( string ) ( $this -> form -> submissions_count + 1 ) : " Please upgrade your OpenForm subscription to use our ID generation features " ;
} else {
$finalData [ $field [ 'id' ]] = $answerValue ;
}
}
}
2022-12-22 10:53:33 +00:00
// For Singrature
if ( $this -> form -> is_pro && $field [ 'type' ] == 'signature' ) {
$finalData [ $field [ 'id' ]] = $this -> storeSignature ( $answerValue );
}
2023-10-03 15:50:46 +00:00
// For Phone
if ( $field [ 'type' ] == 'phone_number' && $answerValue && ctype_alpha ( substr ( $answerValue , 0 , 2 )) && ( ! isset ( $field [ 'use_simple_text_input' ]) || ! $field [ 'use_simple_text_input' ])) {
$finalData [ $field [ 'id' ]] = substr ( $answerValue , 2 );
}
2022-09-20 19:59:52 +00:00
}
return $finalData ;
}
2023-04-26 15:05:02 +00:00
// This is use when updating a record, and file uploads aren't changed.
private function isSkipForUpload ( $value )
{
$newPath = Str :: of ( PublicFormController :: FILE_UPLOAD_PATH ) -> replace ( '?' , $this -> form -> id );
2023-08-16 08:59:07 +00:00
return Storage :: exists ( $newPath . '/' . $value );
2023-04-26 15:05:02 +00:00
}
2022-09-20 19:59:52 +00:00
/**
* Custom Back - end Value formatting . Use case :
* - File uploads ( move file from tmp storage to persistent )
*
* File can have 2 formats :
* - file_name - { uuid } . { ext }
* - { uuid }
*/
private function storeFile ( ? string $value )
{
if ( $value == null ) {
return null ;
}
2023-10-20 09:00:35 +00:00
if ( filter_var ( $value , FILTER_VALIDATE_URL ) !== FALSE && str_contains ( $value , parse_url ( config ( 'app.url' ))[ 'host' ])) { // In case of prefill we have full url so convert to s3
$fileName = basename ( $value );
$path = FormController :: ASSETS_UPLOAD_PATH . '/' . $fileName ;
$newPath = Str :: of ( PublicFormController :: FILE_UPLOAD_PATH ) -> replace ( '?' , $this -> form -> id );
Storage :: move ( $path , $newPath . '/' . $fileName );
return $fileName ;
}
2023-04-26 15:05:02 +00:00
if ( $this -> isSkipForUpload ( $value )) {
return $value ;
}
2022-09-20 19:59:52 +00:00
$fileNameParser = StorageFileNameParser :: parse ( $value );
// Make sure we retrieve the file in tmp storage, move it to persistent
$fileName = PublicFormController :: TMP_FILE_UPLOAD_PATH . '/' . $fileNameParser -> uuid ;
2023-08-16 08:59:07 +00:00
if ( ! Storage :: exists ( $fileName )) {
2022-09-20 19:59:52 +00:00
// File not found, we skip
return null ;
}
$newPath = Str :: of ( PublicFormController :: FILE_UPLOAD_PATH ) -> replace ( '?' , $this -> form -> id );
$completeNewFilename = $newPath . '/' . $fileNameParser -> getMovedFileName ();
\Log :: debug ( 'Moving file to permanent storage.' , [
'uuid' => $fileNameParser -> uuid ,
'destination' => $completeNewFilename ,
'form_id' => $this -> form -> id ,
'form_slug' => $this -> form -> slug ,
]);
2023-08-16 08:59:07 +00:00
Storage :: move ( $fileName , $completeNewFilename );
2022-09-20 19:59:52 +00:00
return $fileNameParser -> getMovedFileName ();
}
2022-12-22 10:53:33 +00:00
private function storeSignature ( ? string $value )
{
if ( $value == null || ! isset ( explode ( ',' , $value )[ 1 ])) {
return null ;
}
$fileName = 'sign_' . ( string ) Str :: uuid () . '.png' ;
$newPath = Str :: of ( PublicFormController :: FILE_UPLOAD_PATH ) -> replace ( '?' , $this -> form -> id );
$completeNewFilename = $newPath . '/' . $fileName ;
2023-08-16 08:59:07 +00:00
Storage :: put ( $completeNewFilename , base64_decode ( explode ( ',' , $value )[ 1 ]));
2023-01-10 13:52:14 +00:00
2022-12-22 10:53:33 +00:00
return $fileName ;
}
2022-09-20 19:59:52 +00:00
/**
* Adds prefill from hidden fields
*
* @ param array $formData
* @ param AnswerFormRequest $request
*/
private function addHiddenPrefills ( array & $formData ) : void
{
// Find hidden properties with prefill, set values
collect ( $this -> form -> properties ) -> filter ( function ( $property ) {
return isset ( $property [ 'hidden' ])
&& isset ( $property [ 'prefill' ])
2023-11-28 10:31:57 +00:00
&& FormLogicPropertyResolver :: isHidden ( $property , $this -> submissionData )
&& ! is_null ( $property [ 'prefill' ])
&& ! in_array ( $property [ 'type' ], [ 'files' ])
&& ! ( $property [ 'type' ] == 'url' && isset ( $property [ 'file_upload' ]) && $property [ 'file_upload' ]);
2022-09-20 19:59:52 +00:00
}) -> each ( function ( array $property ) use ( & $formData ) {
if ( $property [ 'type' ] === 'date' && isset ( $property [ 'prefill_today' ]) && $property [ 'prefill_today' ]) {
2023-06-30 13:52:50 +00:00
$formData [ $property [ 'id' ]] = now () -> format (( isset ( $property [ 'with_time' ]) && $property [ 'with_time' ]) ? 'Y-m-d H:i' : 'Y-m-d' );
2022-09-20 19:59:52 +00:00
} else {
$formData [ $property [ 'id' ]] = $property [ 'prefill' ];
}
});
}
}