fix

Signed-off-by: Christian Hartmann <chris-hartmann@gmx.de>
nextcloud · Oct 28, 2024 · 956342d · 956342d
1 parent cfcde6b
commit 956342d
Show file tree

Hide file tree

Showing 4 changed files with 163 additions and 57 deletions.
diff --git a/lib/Controller/ApiController.php b/lib/Controller/ApiController.php
@@ -1081,9 +1081,9 @@ public function reorderOptions(int $formId, int $questionId, array $newOrder) {
 			$oldOrder = $options[$arrayKey]->getOrder();
 
 			// Only set order, if it changed.
-			if ($oldOrder !== $arrayKey + 1) {
+			if ($oldOrder !== (int)$arrayKey + 1) {
 				// Set Order. ArrayKey counts from zero, order counts from 1.
-				$options[$arrayKey]->setOrder($arrayKey + 1);
+				$options[$arrayKey]->setOrder((int)$arrayKey + 1);
 			}
 		}
 

diff --git a/lib/Controller/ShareApiController.php b/lib/Controller/ShareApiController.php
@@ -231,7 +231,7 @@ public function newShare(int $formId, int $shareType, string $shareWith = '', ar
 	 *
 	 * @param int $formId of the form
 	 * @param int $shareId of the share to update
-	 * @param array{key: string, values: mixed} $keyValuePairs Array of key=>value pairs to update.
+	 * @param array<string, mixed> $keyValuePairs Array of key=>value pairs to update.
 	 * @return DataResponse<Http::STATUS_OK, int, array{}>
 	 * @throws OCSBadRequestException Share doesn't belong to given Form
 	 * @throws OCSBadRequestException Invalid permission given
@@ -277,7 +277,7 @@ public function updateShare(int $formId, int $shareId, array $keyValuePairs): Da
 		}
 
 		//Don't allow to change other properties than permissions
-		if (count($keyValuePairs) > 1 || !key_exists('permissions', $keyValuePairs)) {
+		if (count($keyValuePairs) > 1 || !array_key_exists('permissions', $keyValuePairs)) {
 			$this->logger->debug('Not allowed to update other properties than permissions');
 			throw new OCSForbiddenException('Not allowed to update other properties than permissions');
 		}

diff --git a/lib/ResponseDefinitions.php b/lib/ResponseDefinitions.php
@@ -24,23 +24,26 @@
 namespace OCA\Forms;
 
 /**
- * @psalm-type FormsPartialForm = array{
- *   id: int,
- *   hash: string,
- *   title: string,
- *   expires: int,
- *   permissions: string[],
- *   partial: bool,
- *   state: int
- * }
- *
  * @psalm-type FormsOption = array{
  *   id: int,
  *   questionId: int,
  *   text: string,
  *   order: ?int
  * }
  *
+ * @psalm-type FormsQuestionExtraSettings = array{
+ *   allowOtherAnswer?: ?bool,
+ *   allowedFileExtensions?: ?list<string>,
+ *   allowedFileTypes?: ?list<string>,
+ *   maxAllowedFilesCount?: ?int,
+ *   maxFileSize?: ?int,
+ *   optionsLimitMax?: ?int,
+ *   optionsLimitMin?: ?int,
+ *   shuffleOptions?: ?bool,
+ *   validationRegex?: ?string,
+ *   validationType?: ?string
+ * }
+ *
  * @psalm-type FormsQuestion = array{
  *   id: int,
  *   formId: int,
@@ -49,9 +52,10 @@
  *   isRequired: bool,
  *   text: string,
  *   name: string,
- *   options: array<FormsOption>,
- *   accept: string[],
- *   extraSettings: \stdClass
+ *   description: string,
+ *   extraSettings: list<empty>|FormsQuestionExtraSettings,
+ *   options: ?list<FormsOption>,
+ *   accept?: ?list<string>
  * }
  *
  * @psalm-type FormsAnswer = array{
@@ -66,13 +70,39 @@
  *   formId: int,
  *   userId: string,
  *   timestamp: int,
- *   answers: array<FormsAnswer>,
+ *   answers: list<FormsAnswer>,
  *   userDisplayName: string
  * }
  *
  * @psalm-type FormsSubmissions = array{
- *   submissions: array<FormsSubmission>,
- *   questions: array<FormsQuestion>
+ *   submissions: list<FormsSubmission>,
+ *   questions: list<FormsQuestion>
+ * }
+ *
+ * @psalm-type FormsAccess = array{
+ *   permitAllUsers: bool,
+ *   showToAllUsers: bool
+ * }
+ *
+ * @psalm-type FormsPermission = "edit"|"results"|"results_delete"|"submit"|"embed"
+ *
+ * @psalm-type FormsShare = array{
+ *   id: int,
+ *   formId: int,
+ *   shareType: int,
+ *   shareWith: string,
+ *   permissions: list<FormsPermission>,
+ *   displayName: string
+ * }
+ *
+ * @psalm-type FormsPartialForm = array{
+ *   id: int,
+ *   hash: string,
+ *   title: string,
+ *   expires: int,
+ *   permissions: list<FormsPermission>,
+ *   partial: true,
+ *   state: int
  * }
  *
  * @psalm-type FormsForm = array{
@@ -82,32 +112,23 @@
  *   description: string,
  *   ownerId: string,
  *   created: int,
- *   access: \stdClass,
+ *   access: FormsAccess,
  *   expires: int,
  *   isAnonymous: bool,
  *   submitMultiple: bool,
  *   showExpiration: bool,
  *   canSubmit: bool,
- *   permissions: string[],
- *   questions: array<FormsQuestion>,
+ *   permissions: list<FormsPermission>,
+ *   questions: list<FormsQuestion>,
  *   state: int,
- *   shares: string[],
- *   submissions: array<FormsSubmission>,
+ *   shares: list<string>,
+ *   submissions: list<FormsSubmission>,
  * }
  *
  * @psalm-type FormsUploadedFile = array{
  *   uploadedFileId: int,
  *   fileName: string
  * }
- *
- * @psalm-type FormsShare = array{
- *   id: int,
- *   formId: int,
- *   shareType: int,
- *   shareWith: string,
- *   permissions: string[],
- *   displayName: string
- * }
  */
 class ResponseDefinitions {
 }
diff --git a/openapi.json b/openapi.json
@@ -20,6 +20,21 @@
             }
         },
         "schemas": {
+            "Access": {
+                "type": "object",
+                "required": [
+                    "permitAllUsers",
+                    "showToAllUsers"
+                ],
+                "properties": {
+                    "permitAllUsers": {
+                        "type": "boolean"
+                    },
+                    "showToAllUsers": {
+                        "type": "boolean"
+                    }
+                }
+            },
             "Answer": {
                 "type": "object",
                 "required": [
@@ -115,8 +130,7 @@
                         "format": "int64"
                     },
                     "access": {
-                        "type": "object",
-                        "additionalProperties": true
+                        "$ref": "#/components/schemas/Access"
                     },
                     "expires": {
                         "type": "integer",
@@ -137,7 +151,7 @@
                     "permissions": {
                         "type": "array",
                         "items": {
-                            "type": "string"
+                            "$ref": "#/components/schemas/Permission"
                         }
                     },
                     "questions": {
@@ -244,18 +258,31 @@
                     "permissions": {
                         "type": "array",
                         "items": {
-                            "type": "string"
+                            "$ref": "#/components/schemas/Permission"
                         }
                     },
                     "partial": {
-                        "type": "boolean"
+                        "type": "boolean",
+                        "enum": [
+                            true
+                        ]
                     },
                     "state": {
                         "type": "integer",
                         "format": "int64"
                     }
                 }
             },
+            "Permission": {
+                "type": "string",
+                "enum": [
+                    "edit",
+                    "results",
+                    "results_delete",
+                    "submit",
+                    "embed"
+                ]
+            },
             "Question": {
                 "type": "object",
                 "required": [
@@ -266,9 +293,9 @@
                     "isRequired",
                     "text",
                     "name",
-                    "options",
-                    "accept",
-                    "extraSettings"
+                    "description",
+                    "extraSettings",
+                    "options"
                 ],
                 "properties": {
                     "id": {
@@ -295,21 +322,88 @@
                     "name": {
                         "type": "string"
                     },
+                    "description": {
+                        "type": "string"
+                    },
+                    "extraSettings": {
+                        "anyOf": [
+                            {
+                                "type": "array",
+                                "maxItems": 0
+                            },
+                            {
+                                "$ref": "#/components/schemas/QuestionExtraSettings"
+                            }
+                        ]
+                    },
                     "options": {
                         "type": "array",
+                        "nullable": true,
                         "items": {
                             "$ref": "#/components/schemas/Option"
                         }
                     },
                     "accept": {
                         "type": "array",
+                        "nullable": true,
                         "items": {
                             "type": "string"
                         }
+                    }
+                }
+            },
+            "QuestionExtraSettings": {
+                "type": "object",
+                "properties": {
+                    "allowOtherAnswer": {
+                        "type": "boolean",
+                        "nullable": true
                     },
-                    "extraSettings": {
-                        "type": "object",
-                        "additionalProperties": true
+                    "allowedFileExtensions": {
+                        "type": "array",
+                        "nullable": true,
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "allowedFileTypes": {
+                        "type": "array",
+                        "nullable": true,
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "maxAllowedFilesCount": {
+                        "type": "integer",
+                        "format": "int64",
+                        "nullable": true
+                    },
+                    "maxFileSize": {
+                        "type": "integer",
+                        "format": "int64",
+                        "nullable": true
+                    },
+                    "optionsLimitMax": {
+                        "type": "integer",
+                        "format": "int64",
+                        "nullable": true
+                    },
+                    "optionsLimitMin": {
+                        "type": "integer",
+                        "format": "int64",
+                        "nullable": true
+                    },
+                    "shuffleOptions": {
+                        "type": "boolean",
+                        "nullable": true
+                    },
+                    "validationRegex": {
+                        "type": "string",
+                        "nullable": true
+                    },
+                    "validationType": {
+                        "type": "string",
+                        "nullable": true
                     }
                 }
             },
@@ -342,7 +436,7 @@
                     "permissions": {
                         "type": "array",
                         "items": {
-                            "type": "string"
+                            "$ref": "#/components/schemas/Permission"
                         }
                     },
                     "displayName": {
@@ -3949,17 +4043,8 @@
                                     "keyValuePairs": {
                                         "type": "object",
                                         "description": "Array of key=>value pairs to update.",
-                                        "required": [
-                                            "key",
-                                            "values"
-                                        ],
-                                        "properties": {
-                                            "key": {
-                                                "type": "string"
-                                            },
-                                            "values": {
-                                                "type": "object"
-                                            }
+                                        "additionalProperties": {
+                                            "type": "object"
                                         }
                                     }
                                 }