load submission

Signed-off-by: Christian Hartmann <[email protected]>

Author: Chartman123

docs/API_v3.md

@@ -822,6 +822,43 @@ Upload a file to an answer before form submission
 "data": {"uploadedFileId": integer, "fileName": "string"}
 ```
 
+### Get a specific submission
+
+Get all Submissions to a Form
+
+- Endpoint: `/api/v3/forms/{formId}/submissions/{submissionId}`
+- Method: `GET`
+- Url-Parameters:
+  | Parameter | Type | Description |
+  |-----------|---------|-------------|
+  | _formId_ | Integer | ID of the form to get the submissions for |
+  | _submissionId_ | Integer | ID of the submission to get |
+- Response: The submission
+
+```
+"data": {
+  "id": 6,
+  "formId": 3,
+  "userId": "jonas",
+  "timestamp": 1611274453,
+  "answers": [
+    {
+      "id": 8,
+      "submissionId": 6,
+      "questionId": 1,
+      "text": "Option 3"
+    },
+    {
+      "id": 9,
+      "submissionId": 6,
+      "questionId": 2,
+      "text": "One more."
+    },
+  ],
+  "userDisplayName": "jonas"
+}
+```
+
 ### Insert a Submission
 
 Store Submission to Database

lib/Controller/ApiController.php

@@ -62,6 +62,7 @@
  * @psalm-import-type FormsPartialForm from ResponseDefinitions
  * @psalm-import-type FormsQuestion from ResponseDefinitions
  * @psalm-import-type FormsQuestionType from ResponseDefinitions
+ * @paslm-import-type FormsSubmission from ResponseDefinitions
  * @psalm-import-type FormsSubmissions from ResponseDefinitions
  * @psalm-import-type FormsUploadedFile from ResponseDefinitions
  */
@@ -1200,6 +1201,52 @@ public function getSubmissions(int $formId, ?string $fileFormat = null): DataRes
 		return new DataResponse($response);
 	}
 
+	/**
+	 * Get a specific submission
+	 *
+	 * @param int $formId of the form
+	 * @param int $submissionId of the submission
+	 * @return DataResponse<Http::STATUS_OK, FormsSubmission, array{}>
+	 * @throws OCSNotFoundException Could not find form
+	 * @throws OCSForbiddenException The current user has no permission to get this submission
+	 *
+	 * 200: the submissions of the form
+	 */
+	#[CORS()]
+	#[NoAdminRequired()]
+	#[BruteForceProtection(action: 'form')]
+	#[ApiRoute(verb: 'GET', url: '/api/v3/forms/{formId}/submissions/{submissionId}')]
+	public function getSubmission(int $formId, int $submissionId): DataResponse|DataDownloadResponse {
+		$form = $this->getFormIfAllowed($formId, Constants::PERMISSION_RESULTS);
+
+		$submission = $this->submissionService->getSubmission($submissionId);
+		if ($submission === null) {
+			throw new OCSNotFoundException('Submission doesn\'t exist');
+		}
+
+		if ($submission['formId'] !== $formId) {
+			throw new OCSBadRequestException('Submission doesn\'t belong to given form');
+		}
+
+		// Append Display Names
+		if (substr($submission['userId'], 0, 10) === 'anon-user-') {
+			// Anonymous User
+			// TRANSLATORS On Results when listing the single Responses to the form, this text is shown as heading of the Response.
+			$submission['userDisplayName'] = $this->l10n->t('Anonymous response');
+		} else {
+			$userEntity = $this->userManager->get($submission['userId']);
+
+			if ($userEntity instanceof IUser) {
+				$submission['userDisplayName'] = $userEntity->getDisplayName();
+			} else {
+				// Fallback, should not occur regularly.
+				$submission['userDisplayName'] = $submission['userId'];
+			}
+		}
+
+		return new DataResponse($submission);
+	}
+
 	/**
 	 * Delete all submissions of a specified form
 	 *

lib/Controller/PageController.php

@@ -11,6 +11,8 @@
 use OCA\Forms\Db\Form;
 use OCA\Forms\Db\FormMapper;
 use OCA\Forms\Db\ShareMapper;
+use OCA\Forms\Db\Submission;
+use OCA\Forms\Db\SubmissionMapper;
 use OCA\Forms\Service\ConfigService;
 use OCA\Forms\Service\FormsService;
 
@@ -45,6 +47,7 @@ public function __construct(
 		IRequest $request,
 		private FormMapper $formMapper,
 		private ShareMapper $shareMapper,
+		private SubmissionMapper $submissionMapper,
 		private ConfigService $configService,
 		private FormsService $formsService,
 		private IAccountManager $accountManager,
@@ -63,7 +66,7 @@ public function __construct(
 	#[NoAdminRequired()]
 	#[NoCSRFRequired()]
 	#[FrontpageRoute(verb: 'GET', url: '/')]
-	public function index(?string $hash = null): TemplateResponse {
+	public function index(?string $hash = null, ?int $submissionId = null): TemplateResponse {
 		Util::addScript($this->appName, 'forms-main');
 		Util::addStyle($this->appName, 'forms');
 		Util::addStyle($this->appName, 'forms-style');
@@ -81,6 +84,16 @@ public function index(?string $hash = null): TemplateResponse {
 			}
 		}
 
+		if (isset($submissionId)) {
+			try {
+				$submission = $this->submissionMapper->findById($submissionId);
+				$this->initialState->provideInitialState('submissionId', $submission->id);
+			} catch (DoesNotExistException $e) {
+				// Provide null to indicate no form was found
+				$this->initialState->provideInitialState('submissionId', null);
+			}
+		}
+
 		return new TemplateResponse($this->appName, self::TEMPLATE_MAIN, [
 			'id-app-content' => '#app-content-vue',
 			'id-app-navigation' => '#app-navigation-vue',
@@ -97,6 +110,16 @@ public function views(string $hash): TemplateResponse {
 		return $this->index($hash);
 	}
 
+	/**
+	 * @return TemplateResponse
+	 */
+	#[NoAdminRequired()]
+	#[NoCSRFRequired()]
+	#[FrontpageRoute(verb: 'GET', url: '/{hash}/submit/{submissionId}', requirements: ['hash' => '[a-zA-Z0-9]{16,}', 'submissionId' => '\d+'])]
+	public function submitViewWithSubmission(string $hash, int $submissionId): TemplateResponse {
+		return $this->formMapper->findByHash($hash)->getAllowEdit() ? $this->index($hash, $submissionId) : $this->index($hash);
+	}
+
 	/**
 	 * @param string $hash
 	 * @return RedirectResponse|TemplateResponse Redirect to login or internal view.

lib/Service/SubmissionService.php

@@ -121,6 +121,29 @@ public function getSubmissions(int $formId, ?string $userId = null): array {
 		}
 	}
 
+	/**
+	 * Load specific submission
+	 *
+	 * @param integer $submissionId id of the submission
+	 * @return array{
+	 *     id: int,
+	 *     formId: int,
+	 *     userId: string,
+	 *     timestamp: int,
+	 *     answers: list<FormsAnswer>,
+	 * }
+	 */
+	public function getSubmission(int $submissionId): ?array {
+		try {
+			$submissionEntity = $this->submissionMapper->findById($submissionId);
+			$submission = $submissionEntity->read();
+			$submission['answers'] = $this->getAnswers($submission['id']);
+			return $submission;
+		} catch (DoesNotExistException $e) {
+			return null;
+		}
+	}
+
 	/**
 	 * Export Submissions to Cloud-Filesystem
 	 *

openapi.json

@@ -3414,6 +3414,139 @@
             }
         },
         "/ocs/v2.php/apps/forms/api/v3/forms/{formId}/submissions/{submissionId}": {
+            "get": {
+                "operationId": "api-get-submission",
+                "summary": "Get a specific submission",
+                "description": "This endpoint allows CORS requests",
+                "tags": [
+                    "api"
+                ],
+                "security": [
+                    {
+                        "basic_auth": []
+                    }
+                ],
+                "parameters": [
+                    {
+                        "name": "formId",
+                        "in": "path",
+                        "description": "of the form",
+                        "required": true,
+                        "schema": {
+                            "type": "integer",
+                            "format": "int64"
+                        }
+                    },
+                    {
+                        "name": "submissionId",
+                        "in": "path",
+                        "description": "of the submission",
+                        "required": true,
+                        "schema": {
+                            "type": "integer",
+                            "format": "int64"
+                        }
+                    },
+                    {
+                        "name": "OCS-APIRequest",
+                        "in": "header",
+                        "description": "Required to be true for the API request to pass",
+                        "required": true,
+                        "schema": {
+                            "type": "boolean",
+                            "default": true
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "the submissions of the form",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {
+                                                    "$ref": "#/components/schemas/Submission"
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "404": {
+                        "description": "Could not find form",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {}
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "403": {
+                        "description": "The current user has no permission to get this submission",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {}
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            },
             "put": {
                 "operationId": "api-update-submission",
                 "summary": "Update an existing submission",

src/components/Questions/QuestionDropdown.vue

@@ -150,7 +150,7 @@ export default {
 			}
 
 			const selected = this.values.map((id) =>
-				this.options.find((option) => option.id === id),
+				this.options.find((option) => option.id === parseInt(id)),
 			)
 
 			return this.isMultiple ? selected : selected[0]