-
Notifications
You must be signed in to change notification settings - Fork 97
/
SubmissionService.php
485 lines (427 loc) Β· 16 KB
/
SubmissionService.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
<?php
/**
* @copyright Copyright (c) 2021 Jonas Rittershofer <jotoeri@users.noreply.github.com>
*
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
* @author Jonas Rittershofer <jotoeri@users.noreply.github.com>
*
* @license AGPL-3.0-or-later
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Forms\Service;
use DateTime;
use DateTimeZone;
use OCA\Forms\Constants;
use OCA\Forms\Db\Answer;
use OCA\Forms\Db\AnswerMapper;
use OCA\Forms\Db\Form;
use OCA\Forms\Db\Question;
use OCA\Forms\Db\QuestionMapper;
use OCA\Forms\Db\SubmissionMapper;
use OCA\Forms\Db\UploadedFileMapper;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\OCS\OCSException;
use OCP\Files\File;
use OCP\Files\IRootFolder;
use OCP\Files\NotPermittedException;
use OCP\IConfig;
use OCP\IL10N;
use OCP\ITempManager;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\Mail\IMailer;
use PhpOffice\PhpSpreadsheet\IOFactory;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Writer\Csv;
use Psr\Log\LoggerInterface;
class SubmissionService {
private ?IUser $currentUser;
public function __construct(
private QuestionMapper $questionMapper,
private SubmissionMapper $submissionMapper,
private AnswerMapper $answerMapper,
private UploadedFileMapper $uploadedFileMapper,
private IRootFolder $rootFolder,
private IConfig $config,
private IL10N $l10n,
private LoggerInterface $logger,
private IUserManager $userManager,
IUserSession $userSession,
private IMailer $mailer,
private ITempManager $tempManager,
private FormsService $formsService,
private IUrlGenerator $urlGenerator,
) {
$this->currentUser = $userSession->getUser();
}
/**
* Get all the answers of a given submission
*
* @param int $submissionId the submission id
* @return array
*/
private function getAnswers(int $submissionId): array {
$answerList = [];
try {
$answerEntities = $this->answerMapper->findBySubmission($submissionId);
foreach ($answerEntities as $answerEntity) {
$answerList[] = $answerEntity->read();
}
} catch (DoesNotExistException $e) {
//Just ignore, if no Data. Returns empty Answers-Array
} finally {
return $answerList;
}
}
/**
* Get all submissions of a form
*
* @param int $formId the form id
* @return array
*/
public function getSubmissions(int $formId): array {
$submissionList = [];
try {
$submissionEntities = $this->submissionMapper->findByForm($formId);
foreach ($submissionEntities as $submissionEntity) {
$submission = $submissionEntity->read();
$submission['answers'] = $this->getAnswers($submission['id']);
$submissionList[] = $submission;
}
} catch (DoesNotExistException $e) {
// Just ignore, if no Data. Returns empty Submissions-Array
} finally {
return $submissionList;
}
}
/**
* Export Submissions to Cloud-Filesystem
*
* @param Form $form the form
* @param string $path The Cloud-Path to export to
* @param string $fileFormat Format to export to
* @param string $ownerId of the form creator
* @return File The written file
* @throws NotPermittedException
*/
public function writeFileToCloud(Form $form, string $path, string $fileFormat, ?string $ownerId = null): File {
if (!isset(Constants::SUPPORTED_EXPORT_FORMATS[$fileFormat])) {
throw new \InvalidArgumentException('Invalid file format');
}
$this->logger->debug('Export submissions for form: {hash} to Cloud at: /{path} in format {fileFormat}', [
'hash' => $form->getHash(),
'path' => $path,
'fileFormat' => $fileFormat,
]);
$fileName = $this->formsService->getFileName($form, $fileFormat);
/** @var \OCP\Files\Folder|File $node */
if ($ownerId) {
$node = $this->rootFolder->getUserFolder($ownerId)->get($path);
} else {
$node = $this->rootFolder->getUserFolder($this->currentUser->getUID())->get($path);
}
// If chosen path is a file with expected extension - overwrite it and use parent folder otherwise.
if ($node instanceof File) {
if ($node->getExtension() === $fileFormat) {
$fileName = $node->getName();
}
/** @var \OCP\Files\Folder $node */
$node = $node->getParent();
}
// Check if file exists, create otherwise.
try {
/** @var File $file */
$file = $node->get($fileName);
} catch (\OCP\Files\NotFoundException $e) {
$node->newFile($fileName);
/** @var File $file */
$file = $node->get($fileName);
}
// Get Data
$submissionsData = $this->getSubmissionsData($form, $fileFormat, $file);
// Write the data to file
try {
$file->putContent($submissionsData);
} catch (NotPermittedException $e) {
$this->logger->warning('Failed to export Submissions: Not allowed to write to file');
throw new OCSException('Not allowed to write to file.', previous: $e);
}
return $file;
}
/**
* Create/update file from Submissions to form
*
* @param Form $form Form to export
* @param string $fileFormat Format to export to
* @param File|null $file File with already exported submissions to append to
* @return string File content
*/
public function getSubmissionsData(Form $form, string $fileFormat, ?File $file = null): string {
if (!isset(Constants::SUPPORTED_EXPORT_FORMATS[$fileFormat])) {
throw new \InvalidArgumentException('Invalid file format');
}
try {
$submissionEntities = $this->submissionMapper->findByForm($form->getId());
} catch (DoesNotExistException $e) {
// Just ignore, if no Data. Returns empty Submissions-Array
}
// Oldest first
$submissionEntities = array_reverse($submissionEntities);
$questions = $this->questionMapper->findByForm($form->getId());
$defaultTimeZone = date_default_timezone_get();
if (!$this->currentUser) {
$userTimezone = $this->config->getUserValue($form->getOwnerId(), 'core', 'timezone', $defaultTimeZone);
} else {
$userTimezone = $this->config->getUserValue($this->currentUser->getUID(), 'core', 'timezone', $defaultTimeZone);
}
// Process initial header
$header = [];
$header[] = $this->l10n->t('User ID');
$header[] = $this->l10n->t('User display name');
$header[] = $this->l10n->t('Timestamp');
/** @var array<int, Question> $questionPerQuestionId */
$questionPerQuestionId = [];
foreach ($questions as $question) {
$header[] = $question->getText();
$questionPerQuestionId[$question->getId()] = $question;
}
// Init dataset
$data = [];
// Process each answers
foreach ($submissionEntities as $submission) {
$row = [];
// User
$user = $this->userManager->get($submission->getUserId());
if ($user === null) {
// Give empty userId
$row[] = '';
// TRANSLATORS Shown on export if no Display-Name is available.
$row[] = $this->l10n->t('Anonymous user');
} else {
$row[] = $user->getUID();
$row[] = $user->getDisplayName();
}
// Date
$row[] = date_format(date_timestamp_set(new DateTime(), $submission->getTimestamp())->setTimezone(new DateTimeZone($userTimezone)), 'c');
// Answers, make sure we keep the question order
$answers = array_reduce($this->answerMapper->findBySubmission($submission->getId()),
function (array $carry, Answer $answer) use ($questionPerQuestionId) {
$questionId = $answer->getQuestionId();
if (isset($questionPerQuestionId[$questionId]) &&
$questionPerQuestionId[$questionId]->getType() === Constants::ANSWER_TYPE_FILE) {
if (array_key_exists($questionId, $carry)) {
$carry[$questionId]['label'] .= "; \n" . $answer->getText();
} else {
$carry[$questionId] = [
'label' => $answer->getText(),
'url' => $this->urlGenerator->linkToRouteAbsolute('files.View.showFile', ['fileid' => $answer->getFileId()])
];
}
} else {
if (array_key_exists($questionId, $carry)) {
$carry[$questionId] .= '; ' . $answer->getText();
} else {
$carry[$questionId] = $answer->getText();
}
}
return $carry;
}, []);
foreach ($questions as $question) {
$row[] = $answers[$question->getId()] ?? null;
}
$data[] = $row;
}
return $this->exportData($header, $data, $fileFormat, $file);
}
/**
* @param array<int, string> $header
* @param array<int, array<int, string>|non-empty-list<array{label: string, url: string}>> $data
*/
private function exportData(array $header, array $data, string $fileFormat, ?File $file = null): string {
if ($file && $file->getContent()) {
$existentFile = $this->tempManager->getTemporaryFile($fileFormat);
file_put_contents($existentFile, $file->getContent());
$spreadsheet = IOFactory::load($existentFile);
} else {
$spreadsheet = new Spreadsheet();
}
$activeWorksheet = $spreadsheet->getSheet(0);
foreach ($header as $columnIndex => $value) {
$activeWorksheet->setCellValue([$columnIndex + 1, 1], $value);
}
foreach ($data as $rowIndex => $rowData) {
foreach ($rowData as $columnIndex => $value) {
$column = $columnIndex + 1;
$row = $rowIndex + 2;
if (is_array($value)) {
$activeWorksheet->getCell([$column, $row])
->setValueExplicit($value['label'])
->getHyperlink()
->setUrl($value['url']);
$activeWorksheet->getStyle([$column, $row])
->getAlignment()
->setWrapText(true);
} else {
$activeWorksheet->setCellValue([$column, $row], $value);
}
}
}
$exportedFile = $this->tempManager->getTemporaryFile($fileFormat);
$writer = IOFactory::createWriter($spreadsheet, ucfirst($fileFormat));
if ($writer instanceof Csv) {
$writer->setUseBOM(true);
}
$writer->save($exportedFile);
return file_get_contents($exportedFile);
}
/**
* Validate all answers against the questions
* @param array $questions Array of the questions of the form
* @param array $answers Array of the submitted answers
* @param string $formOwnerId Owner of the form
* @return boolean|string True for valid submission, false or error message for invalid
*/
public function validateSubmission(array $questions, array $answers, string $formOwnerId): bool|string {
// Check by questions
foreach ($questions as $question) {
$questionId = $question['id'];
$questionAnswered = array_key_exists($questionId, $answers);
// Check if all required questions have an answer
if ($question['isRequired'] &&
(!$questionAnswered ||
!array_filter($answers[$questionId], function (string|array $value): bool {
// file type
if (is_array($value)) {
return !empty($value['uploadedFileId']);
}
return $value !== '';
}) ||
(!empty($question['extraSettings']['allowOtherAnswer']) && !array_filter($answers[$questionId], fn ($value) => $value !== Constants::QUESTION_EXTRASETTINGS_OTHER_PREFIX)))
) {
return false;
}
// Perform further checks only for answered questions
if (!$questionAnswered) {
continue;
}
// Check number of answers
$answersCount = count($answers[$questionId]);
if ($question['type'] === Constants::ANSWER_TYPE_MULTIPLE) {
$minOptions = $question['extraSettings']['optionsLimitMin'] ?? -1;
$maxOptions = $question['extraSettings']['optionsLimitMax'] ?? -1;
// If number of answers is limited check the limits
if (($minOptions > 0 && $answersCount < $minOptions)
|| ($maxOptions > 0 && $answersCount > $maxOptions)) {
return false;
}
} elseif ($answersCount > 1 && $question['type'] !== Constants::ANSWER_TYPE_FILE) {
// Check if non-multiple questions have not more than one answer
return false;
}
/*
* Check if date questions have valid answers
* $answers[$questionId][0] -> date/time questions can only have one answer
*/
if (in_array($question['type'], Constants::ANSWER_TYPES_DATETIME) &&
!$this->validateDateTime($answers[$questionId][0], Constants::ANSWER_PHPDATETIME_FORMAT[$question['type']])) {
return false;
}
// Check if all answers are within the possible options
if (in_array($question['type'], Constants::ANSWER_TYPES_PREDEFINED) && empty($question['extraSettings']['allowOtherAnswer'])) {
foreach ($answers[$questionId] as $answer) {
// Search corresponding option, return false if non-existent
if (array_search($answer, array_column($question['options'], 'id')) === false) {
return false;
}
}
}
// Handle custom validation of short answers
if ($question['type'] === Constants::ANSWER_TYPE_SHORT && !$this->validateShortQuestion($question, $answers[$questionId][0])) {
return false;
}
if ($question['type'] === Constants::ANSWER_TYPE_FILE) {
$maxAllowedFilesCount = $question['extraSettings']['maxAllowedFilesCount'] ?? 0;
if ($maxAllowedFilesCount > 0 && count($answers[$questionId]) > $maxAllowedFilesCount) {
return sprintf('Too many files uploaded for question "%s". Maximum allowed: %d', $question['text'], $maxAllowedFilesCount);
}
foreach ($answers[$questionId] as $answer) {
$uploadedFile = $this->uploadedFileMapper->findByUploadedFileId($answer['uploadedFileId']);
if (!$uploadedFile) {
return sprintf('File "%s" for question "%s" not exists anymore. Please delete and re-upload the file.', $answer['fileName'] ?? $answer['uploadedFileId'], $question['text']);
}
$nodes = $this->rootFolder->getUserFolder($formOwnerId)->getById($uploadedFile->getFileId());
if (empty($nodes)) {
return sprintf('File "%s" for question "%s" not exists anymore. Please delete and re-upload the file.', $answer['fileName'] ?? $answer['uploadedFileId'], $question['text']);
}
}
}
}
// Check for excess answers
foreach ($answers as $id => $answerArray) {
// Search corresponding question, return false if not found
$questionIndex = array_search($id, array_column($questions, 'id'));
if ($questionIndex === false) {
return false;
}
}
return true;
}
/**
* Validate correct date/time formats
* @param string $dateStr String with date from answer
* @param string $format String with the format to validate
* @return boolean If the submitted date/time is valid
*/
private function validateDateTime(string $dateStr, string $format) {
$d = DateTime::createFromFormat($format, $dateStr);
return $d && $d->format($format) === $dateStr;
}
/**
* Validate short question answers if special validation types are set
*/
private function validateShortQuestion(array $question, string $data): bool {
if (!isset($question['extraSettings']) || !isset($question['extraSettings']['validationType'])) {
// No type defined, so fallback to 'text' => no special handling
return true;
}
switch ($question['extraSettings']['validationType']) {
case 'email':
return $this->mailer->validateMailAddress($data);
case 'number':
return is_numeric($data);
case 'phone':
// some special characters are used (depending on the locale)
$sanitized = str_replace([' ', '(', ')', '.', '/', '-', 'x'], '', $data);
// allow leading + for international numbers
if (str_starts_with($sanitized, '+')) {
$sanitized = substr($sanitized, 1);
}
return preg_match('/^[0-9]{3,}$/', $sanitized) === 1;
case 'regex':
// empty regex matches everything
if (!isset($question['extraSettings']['validationRegex'])) {
return true;
}
return preg_match($question['extraSettings']['validationRegex'], $data) === 1;
default:
$this->logger->error('Invalid input type for question detected, please report this issue!', ['validationType' => $question['extraSettings']['validationType']]);
// The result is just a non-validated text on the results, but not a fully declined submission. So no need to throw but simply return false here.
return false;
}
}
}