Question duplication

appinfo/routes.php

@@ -73,7 +73,7 @@
 			'verb' => 'OPTIONS',
 			'requirements' => [
 				'path' => '.+',
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 
@@ -83,31 +83,31 @@
 			'url' => '/api/{apiVersion}/forms',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#newForm',
 			'url' => '/api/{apiVersion}/form',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#getForm',
 			'url' => '/api/{apiVersion}/form/{id}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#cloneForm',
 			'url' => '/api/{apiVersion}/form/clone/{id}',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		// TODO: Remove POST in next API release
@@ -116,47 +116,47 @@
 			'url' => '/api/{apiVersion}/form/update',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#updateForm',
 			'url' => '/api/{apiVersion}/form/update',
 			'verb' => 'PATCH',
 			'requirements' => [
-				'apiVersion' => 'v2.2'
+				'apiVersion' => 'v2\.[2-3]'
 			]
 		],
 		[
 			'name' => 'api#transferOwner',
 			'url' => '/api/{apiVersion}/form/transfer',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2.2'
+				'apiVersion' => 'v2\.[2-3]'
 			]
 		],
 		[
 			'name' => 'api#deleteForm',
 			'url' => '/api/{apiVersion}/form/{id}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#getPartialForm',
 			'url' => '/api/{apiVersion}/partial_form/{hash}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#getSharedForms',
 			'url' => '/api/{apiVersion}/shared_forms',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 
@@ -166,7 +166,7 @@
 			'url' => '/api/{apiVersion}/question',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		// TODO: Remove POST in next API release
@@ -175,15 +175,15 @@
 			'url' => '/api/{apiVersion}/question/update',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#updateQuestion',
 			'url' => '/api/{apiVersion}/question/update',
 			'verb' => 'PATCH',
 			'requirements' => [
-				'apiVersion' => 'v2.2'
+				'apiVersion' => 'v2\.[2-3]'
 			]
 		],
 		// TODO: Remove POST in next API release
@@ -192,23 +192,31 @@
 			'url' => '/api/{apiVersion}/question/reorder',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#reorderQuestions',
 			'url' => '/api/{apiVersion}/question/reorder',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v2.2'
+				'apiVersion' => 'v2\.[2-3]'
 			]
 		],
 		[
 			'name' => 'api#deleteQuestion',
 			'url' => '/api/{apiVersion}/question/{id}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
+			]
+		],
+		[
+			'name' => 'api#cloneQuestion',
+			'url' => '/api/{apiVersion}/question/clone/{id}',
+			'verb' => 'POST',
+			'requirements' => [
+				'apiVersion' => 'v2.3'
 			]
 		],
 
@@ -218,7 +226,7 @@
 			'url' => '/api/{apiVersion}/option',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		// TODO: Remove POST in next API release
@@ -227,23 +235,23 @@
 			'url' => '/api/{apiVersion}/option/update',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#updateOption',
 			'url' => '/api/{apiVersion}/option/update',
 			'verb' => 'PATCH',
 			'requirements' => [
-				'apiVersion' => 'v2.2'
+				'apiVersion' => 'v2\.[2-3]'
 			]
 		],
 		[
 			'name' => 'api#deleteOption',
 			'url' => '/api/{apiVersion}/option/{id}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 
@@ -253,15 +261,15 @@
 			'url' => '/api/{apiVersion}/share',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'shareApi#deleteShare',
 			'url' => '/api/{apiVersion}/share/{id}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		// TODO: Remove POST in next API release
@@ -278,7 +286,7 @@
 			'url' => '/api/{apiVersion}/share/update',
 			'verb' => 'PATCH',
 			'requirements' => [
-				'apiVersion' => 'v2.2'
+				'apiVersion' => 'v2\.[2-3]'
 			]
 		],
 
@@ -288,47 +296,47 @@
 			'url' => '/api/{apiVersion}/submissions/{hash}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#exportSubmissions',
 			'url' => '/api/{apiVersion}/submissions/export/{hash}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#exportSubmissionsToCloud',
 			'url' => '/api/{apiVersion}/submissions/export',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#deleteAllSubmissions',
 			'url' => '/api/{apiVersion}/submissions/{formId}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#insertSubmission',
 			'url' => '/api/{apiVersion}/submission/insert',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 		[
 			'name' => 'api#deleteSubmission',
 			'url' => '/api/{apiVersion}/submission/{id}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-2])?'
+				'apiVersion' => 'v2(\.[1-3])?'
 			]
 		],
 	]

docs/API.md

@@ -29,6 +29,8 @@ This file contains the API-Documentation. For more information on the returned D
 
 ### Other API changes
 - In API version 2.1 the endpoint `/api/v2.1/share/update` was added to update a Share
+- In API version 2.2 the endpoint `/api/v2.2/form/transfer` was added to transfer ownership of a form
+- In API version 2.3 the endpoint `/api/v2.3/question/clone` was added to clone a question
 
 ## Form Endpoints
 ### List owned Forms
@@ -329,6 +331,19 @@ Reorders all Questions of a single form
 "data": 4
 ```
 
+### Clone a question
+Creates a clone of a question with all its options.
+- Endpoint: `/api/v2.3/question/clone/{id}`
+- Url-Parameter:
+  | Parameter | Type    | Description |
+  |-----------|---------|-------------|
+  | _id_      | Integer | ID of the question to clone |
+- Method: `POST`
+- Response: Returns cloned question object with the new ID set.
+```
+See section 'Create a new question'.
+```
+
 ## Option Endpoints
 Contains only manipulative question-endpoints. To retrieve options, request the full form data.
 

lib/Controller/ApiController.php

@@ -50,6 +50,7 @@
 use OCP\AppFramework\OCS\OCSBadRequestException;
 use OCP\AppFramework\OCS\OCSException;
 use OCP\AppFramework\OCS\OCSForbiddenException;
+use OCP\AppFramework\OCS\OCSNotFoundException;
 use OCP\AppFramework\OCSController;
 use OCP\Files\NotFoundException;
 use OCP\Files\NotPermittedException;
@@ -715,6 +716,60 @@
 
 	/**
 	 * @CORS
+	 * @NoAdminRequired
+	 *
+	 * Clone a question
+	 *
+	 * @param int $id the question id
+	 * @return DataResponse
+	 * @throws OCSBadRequestException|OCSForbiddenException
+	 */
+	public function cloneQuestion(int $id): DataResponse {
+		$this->logger->debug('Question to be cloned: {id}', [
+			'id' => $id
+		]);
+
+		try {
+			$sourceQuestion = $this->questionMapper->findById($id);
+			$sourceOptions = $this->optionMapper->findByQuestion($id);
+			$form = $this->formMapper->findById($sourceQuestion->getFormId());
+		} catch (IMapperException $e) {
+			$this->logger->debug('Could not find form or question');
+			throw new OCSNotFoundException('Could not find form or question');
+		}
+
+		if ($form->getOwnerId() !== $this->currentUser->getUID()) {
+			$this->logger->debug('This form is not owned by the current user');
+			throw new OCSForbiddenException();
+		}
+
+		$allQuestions = $this->questionMapper->findByForm($form->getId());
+
+		$questionData = $sourceQuestion->read();
+		unset($questionData['id']);
+		$questionData["order"] = end($allQuestions)->getOrder() + 1;
+
+		$newQuestion = Question::fromParams($questionData);
+		$this->questionMapper->insert($newQuestion);
+
+		$response = $newQuestion->read();
+		$response['options'] = [];
+
+		foreach ($sourceOptions as $sourceOption) {
+			$optionData = $sourceOption->read();
+
+			unset($optionData['id']);
+			$optionData['questionId'] = $newQuestion->getId();
+			$newOption = Option::fromParams($optionData);
+			$insertedOption = $this->optionMapper->insert($newOption);
+
+			$response['options'][] = $insertedOption->read();
+		}
+
+		return new DataResponse($response);
+	}
+
+	/**
 	 * @NoAdminRequired
 	 *
 	 * Add a new option to a question