feat: Allow for duplicating questions

* ApiController can now receive a duplication request, copies the question and options to new ones and then returns that new question object.
* All questions can now handle duplication.
* Create can now handle the duplication of questions.
* Added the new api route.
* Some styling and variables renamed to fit nextcloud guidelines
* Written an integration test.
* Added some comments to new methods added.
* Added start for translation
* Refactored variable names and some cleanup.
* Create is now more concise.
* Updated routes

Signed-off-by: Mitchel van Hamburg [email protected]

appinfo/routes.php

@@ -211,6 +211,14 @@
  'apiVersion' => 'v2(\.[1-2])?'
  ]
  ],
+ [
+ 'name' => 'api#duplicateQuestion',
+ 'url' => '/api/{apiVersion}/question/clone/{id}',
+ 'verb' => 'POST',
+ 'requirements' => [
+ 'apiVersion' => 'v2.1'
+ ]
+ ],
 
  // Options
  [

lib/Controller/ApiController.php

@@ -715,6 +715,60 @@ public function deleteQuestion(int $id): DataResponse {
 
  /**
  * @CORS
+ * @NoAdminRequired
+ *
+ * Duplicate a question
+ *
+ * @param int $id the question id
+ * @return DataResponse
+ * @throws OCSBadRequestException|OCSForbiddenException
+ */
+ public function duplicateQuestion(int $id): DataResponse {
+ $this->logger->debug('Question to be duplicated: {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 OCSBadRequestException('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

src/components/Questions/Question.vue

@@ -100,6 +100,12 @@
  </template>
  {{ t('forms', 'Technical name') }}
  </NcActionInput>
+ <NcActionButton @click="onDuplicate">
+ <template #icon>
+ <IconContentDuplicate :size="20" />
+ </template>
+ {{ t('forms', 'Copy question') }}
+ </NcActionButton>
  <NcActionButton @click="onDelete">
  <template #icon>
  <IconDelete :size="20" />
@@ -140,6 +146,7 @@ import IconArrowUp from 'vue-material-design-icons/ArrowUp.vue'
 import IconDelete from 'vue-material-design-icons/Delete.vue'
 import IconDragHorizontalVariant from 'vue-material-design-icons/DragHorizontalVariant.vue'
 import IconIdentifier from 'vue-material-design-icons/Identifier.vue'
+import IconContentDuplicate from 'vue-material-design-icons/ContentDuplicate.vue'
 
 export default {
  name: 'Question',
@@ -148,6 +155,7 @@ export default {
  IconAlertCircleOutline,
  IconArrowDown,
  IconArrowUp,
+ IconContentDuplicate,
  IconDelete,
  IconDragHorizontalVariant,
  IconIdentifier,
@@ -305,6 +313,13 @@ export default {
  onDelete() {
  this.$emit('delete')
  },
+
+ /**
+ * Duplicate this question
+ */
+ onDuplicate() {
+ this.$emit('duplicate')
+ },
  },
 }
 </script>

src/mixins/QuestionMixin.js

@@ -202,6 +202,7 @@ export default {
  commonListeners() {
  return {
  delete: this.onDelete,
+ duplicate: this.onDuplicate,
  'update:text': this.onTitleChange,
  'update:description': this.onDescriptionChange,
  'update:isRequired': this.onRequiredChange,
@@ -290,6 +291,13 @@ export default {
  this.$emit('delete')
  },
 
+ /**
+ * Duplicate this question.
+ */
+ onDuplicate() {
+ this.$emit('duplicate')
+ },
+
  /**
  * Don't automatically submit form on Enter, parent will handle that
  * To be called with prevent: @keydown.enter.prevent="onKeydownEnter"

src/views/Create.vue

@@ -97,6 +97,7 @@
  :max-string-lengths="maxStringLengths"
  v-bind.sync="form.questions[index]"
  @delete="deleteQuestion(question)"
+ @duplicate="duplicateQuestion(question)"
  @move-down="onMoveDown(index)"
  @move-up="onMoveUp(index)" />
  </transition-group>
@@ -393,6 +394,35 @@ export default {
  }
  },
 
+ /**
+ * Duplicate a question
+ *
+ * @param {number} id the question id to duplicate in the current form
+ */
+ async duplicateQuestion({ id }) {
+ this.isLoadingQuestions = true
+
+ try {
+ const response = await axios.post(generateOcsUrl('apps/forms/api/v2.1/question/clone/{id}', { id }))
+ const question = OcsResponse2Data(response)
+
+ this.form.questions.push(Object.assign({
+ answers: [],
+ }, question))
+
+ this.$nextTick(() => {
+ const lastQuestion = this.$refs.questions[this.$refs.questions.length - 1]
+ lastQuestion.focus()
+ })
+
+ } catch (error) {
+ logger.error(`Error while duplicating question ${id}`, { error })
+ showError('There was an error while duplicating the question')
+ } finally {
+ this.isLoadingQuestions = false
+ }
+ },
+
  /**
  * Reorder questions on dragEnd
  */

tests/Integration/Api/ApiV2Test.php

@@ -930,6 +930,31 @@ public function testDeleteQuestion(array $fullFormExpected) {
  $this->testGetFullForm($fullFormExpected);
  }
 
+ public function dataDuplicateQuestion() {
+ $fullFormExpected = $this->dataGetFullForm()['getFullForm']['expected'];
+ array_splice($fullFormExpected['questions'][1]['options'], 0, 1);
+
+ return [
+ 'duplicateQuestion' => [
+ 'fullFormExpected' => $fullFormExpected
+ ]
+ ];
+ }
+
+ /**
+ * @dataProvider dataDuplicateQuestion
+ * @param array $fullFormExpected
+ */
+ public function testDuplicateQuestion(array $fullFormExpected) {
+ $resp = $this->http->request('POST', "api/v2/question/{$this->testForms[0]['questions'][0]['id']}");
+ $data = $this->OcsResponse2Data($resp);
+
+ $this->assertEquals(200, $resp->getStatusCode());
+ $this->assertEquals($this->testForms[0]['questions'][count($this->testForms[0]['questions'])]['id'], $data);
+
+ $this->testGetFullForm($fullFormExpected);
+ }
+
  public function dataCreateNewOption() {
  return [
  'newOption' => [