added functionality to create new facility on existing kolibri

kolibri/core/assets/src/constants.js

@@ -186,3 +186,10 @@ export const ApplicationTypes = {
   KOLIBRI: 'kolibri',
   STUDIO: 'studio',
 };
+
+// aliasing 'informal' to 'personal' since it's how we talk about it
+export const Presets = Object.freeze({
+  PERSONAL: 'informal',
+  FORMAL: 'formal',
+  NONFORMAL: 'nonformal',
+});

kolibri/core/assets/src/mixins/notificationStrings.js

@@ -139,6 +139,10 @@ export default createTranslator('NotificationStrings', {
     message: 'Device not removed',
     context: 'Snackbar message when a device fails to be removed from he sync schedule',
   },
+  newLearningFacilityCreated: {
+    message: 'New learning facility created',
+    context: 'Snackbar message when a new facility created',
+  },
   // TODO move more messages into this namespace:
   // - "Quiz started"
   // - "Quiz Ended"

kolibri/core/auth/api.py

@@ -60,6 +60,7 @@
 from .models import Membership
 from .models import Role
 from .serializers import ClassroomSerializer
+from .serializers import CreateFacilitySerializer
 from .serializers import ExtraFieldsSerializer
 from .serializers import FacilityDatasetSerializer
 from .serializers import FacilitySerializer
@@ -621,6 +622,13 @@ def annotate_queryset(self, queryset):
             )
         )
 
+    @decorators.action(methods=["post"], detail=False)
+    def create_facility(self, request):
+        serializer = CreateFacilitySerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        serializer.save()
+        return Response()
+
 
 class PublicFacilityViewSet(viewsets.ReadOnlyModelViewSet):
     queryset = Facility.objects.all()

kolibri/core/auth/serializers.py

@@ -2,10 +2,15 @@
 from __future__ import print_function
 from __future__ import unicode_literals
 
+import logging
+
 from django.core.validators import MinLengthValidator
+from django.db import transaction
 from rest_framework import serializers
+from rest_framework.exceptions import ParseError
 from rest_framework.validators import UniqueTogetherValidator
 
+from .constants import facility_presets
 from .errors import IncompatibleDeviceSettingError
 from .errors import InvalidCollectionHierarchy
 from .errors import InvalidMembershipError
@@ -20,6 +25,9 @@
 from kolibri.core.auth.constants.demographics import NOT_SPECIFIED
 
 
+logger = logging.getLogger(__name__)
+
+
 class RoleSerializer(serializers.ModelSerializer):
     class Meta:
         model = Role
@@ -137,6 +145,27 @@ class Meta:
         fields = ("id", "name")
 
 
+class CreateFacilitySerializer(serializers.ModelSerializer):
+    preset = serializers.ChoiceField(choices=facility_presets.choices)
+
+    class Meta:
+        model = Facility
+        fields = ("id", "name", "preset")
+
+    def create(self, validated_data):
+        preset = validated_data.get("preset")
+        name = validated_data.get("name")
+        with transaction.atomic():
+            try:
+                facility_dataset = FacilityDataset.objects.create(preset=preset)
+                facility = Facility.objects.create(name=name, dataset=facility_dataset)
+                facility.dataset.reset_to_default_settings(preset)
+            except Exception as e:
+                logger.error("Error occured while creating facility: %s", str(e))
+                raise ParseError("Error occured while creating facility")
+        return facility
+
+
 class PublicFacilitySerializer(serializers.ModelSerializer):
     learner_can_login_with_no_password = serializers.SerializerMethodField()
     learner_can_sign_up = serializers.SerializerMethodField()

kolibri/plugins/device/assets/src/constants.js

@@ -71,3 +71,7 @@ export const MeteredConnectionDownloadOptions = {
   DISALLOW_DOWNLOAD_ON_METERED_CONNECTION: 'DISALLOW_DOWNLOAD_ON_METERED_CONNECTION',
   ALLOW_DOWNLOAD_ON_METERED_CONNECTION: 'ALLOW_DOWNLOAD_ON_METERED_CONNECTION',
 };
+
+export const ImportFacility = 'import_facility';
+
+export const CreateNewFacility = 'create_new_facility';

kolibri/plugins/device/assets/src/views/FacilitiesPage/CreateNewFacilityModal.vue

@@ -0,0 +1,122 @@
+<template>
+
+  <KModal
+    :title="$tr('createFacilityLabel')"
+    :submitText="$tr('createFacilityButtonLabel')"
+    :cancelText="coreString('closeAction')"
+    size="medium"
+    @submit="handleSubmit"
+    @cancel="$emit('cancel')"
+  >
+    <p>{{ coreString('learningFacilityDescription') }}</p>
+    <KTextbox
+      ref="facilityNameTextBox"
+      v-model="facilityName"
+      :label="$tr('facilityNameFieldLabel')"
+      :invalid="facilityNameInvalid"
+      :invalidText="coreString('requiredFieldError')"
+      :maxlength="50"
+    />
+    <b>{{ $tr('learningEnvironmentHeader') }}</b>
+    <KRadioButton
+      v-model="preset"
+      class="permission-preset-radio-button"
+      :value="Presets.NONFORMAL"
+      :label="$tr('nonFormalLabel')"
+      :description="$tr('nonFormalDescription')"
+    />
+    <KRadioButton
+      v-model="preset"
+      class="permission-preset-radio-button"
+      :value="Presets.FORMAL"
+      :label="$tr('formalLabel')"
+      :description="$tr('formalDescription')"
+    />
+  </KModal>
+
+</template>
+
+
+<script>
+
+  import commonCoreStrings from 'kolibri.coreVue.mixins.commonCoreStrings';
+  import commonSyncElements from 'kolibri.coreVue.mixins.commonSyncElements';
+  import { Presets } from 'kolibri.coreVue.vuex.constants';
+  import { createFacility } from './api';
+
+  export default {
+    name: 'CreateNewFacilityModal',
+    mixins: [commonCoreStrings, commonSyncElements],
+    data() {
+      return {
+        facilityName: '',
+        preset: Presets.NONFORMAL,
+        Presets,
+      };
+    },
+    computed: {
+      facilityNameInvalid() {
+        return !this.facilityName || this.facilityName.trim() === '';
+      },
+    },
+    methods: {
+      handleSubmit() {
+        if (this.facilityNameInvalid) {
+          return this.$refs.facilityNameTextBox.focus();
+        }
+        const payload = {
+          name: this.facilityName,
+          preset: this.preset,
+        };
+        createFacility(payload)
+          .then(() => {
+            this.$emit('success');
+            this.showSnackbarNotification('newLearningFacilityCreated');
+          })
+          .catch(error => {
+            this.$store.dispatch('handleApiError', error);
+          });
+      },
+    },
+    $trs: {
+      facilityNameFieldLabel: {
+        message: 'Learning facility name',
+        context: 'The field where the admin adds the name of their facility.',
+      },
+      learningEnvironmentHeader: {
+        message: 'What kind of environment is your facility?',
+        context: 'Title for facility environment.',
+      },
+      formalLabel: {
+        message: 'Formal',
+        context: 'Label for the radio button option in the facility setup.',
+      },
+      formalDescription: {
+        message: 'Schools and other formal learning contexts.',
+        context: "Option description text for 'Formal' facility types.",
+      },
+      nonFormalLabel: {
+        message: 'Non-formal',
+        context: 'Label for the radio button option in the facility setup',
+      },
+      nonFormalDescription: {
+        message:
+          'Libraries, orphanages, youth centers, computer labs, and other non-formal learning contexts.',
+
+        context: "Option description text for 'Non-formal' facility types.",
+      },
+      createFacilityLabel: {
+        message: 'Create a new learning facility',
+        context: 'Title for create facility modal',
+      },
+      createFacilityButtonLabel: {
+        message: 'create facility',
+        context: 'Label for create facility submit button.',
+      },
+    },
+  };
+
+</script>
+
+
+<style lang="scss" scoped></style>

kolibri/plugins/device/assets/src/views/FacilitiesPage/api.js

@@ -0,0 +1,12 @@
+import client from 'kolibri.client';
+import urls from 'kolibri.urls';
+
+const url = urls['kolibri:core:facility-create-facility']();
+
+export function createFacility(payload) {
+  return client({
+    url,
+    method: 'POST',
+    data: payload,
+  });
+}

kolibri/plugins/device/assets/src/views/FacilitiesPage/index.vue

@@ -14,11 +14,18 @@
               @click="showSyncAllModal = true"
             />
             <KButton
-              :text="getCommonSyncString('importFacilityAction')"
+              hasDropdown
+              :text="$tr('createFacilityLabel')"
               primary
               style="margin-top: 16px; margin-bottom: -16px;"
-              @click="showImportModal = true"
-            />
+            >
+              <template #menu>
+                <KDropdownMenu
+                  :options="options"
+                  @select="handleSelect"
+                />
+              </template>
+            </KButton>
           </KButtonGroup>
         </template>
       </HeaderWithOptions>
@@ -144,6 +151,11 @@
         @success="handleStartImportSuccess"
         @cancel="showImportModal = false"
       />
+      <CreateNewFacilityModal
+        v-if="showCreateFacilityModal"
+        @success="handleCreateFacilitySuccess"
+        @cancel="showCreateFacilityModal = false"
+      />
 
       <!-- NOTE similar code for KDP Registration in SyncInterface -->
       <template v-if="Boolean(facilityForRegister)">
@@ -195,13 +207,14 @@
   import { TaskStatuses, TaskTypes } from 'kolibri.utils.syncTaskUtils';
   import some from 'lodash/some';
   import DeviceAppBarPage from '../DeviceAppBarPage';
-  import { PageNames } from '../../constants';
+  import { PageNames, ImportFacility, CreateNewFacility } from '../../constants';
   import { deviceString } from '../commonDeviceStrings';
   import TasksBar from '../ManageContentPage/TasksBar';
   import HeaderWithOptions from '../HeaderWithOptions';
   import RemoveFacilityModal from './RemoveFacilityModal';
   import SyncAllFacilitiesModal from './SyncAllFacilitiesModal';
   import ImportFacilityModalGroup from './ImportFacilityModalGroup';
+  import CreateNewFacilityModal from './CreateNewFacilityModal';
   import facilityTaskQueue from './facilityTasksQueue';
 
   const Options = Object.freeze({
@@ -221,6 +234,7 @@
       DeviceAppBarPage,
       ConfirmationRegisterModal,
       CoreTable,
+      CreateNewFacilityModal,
       HeaderWithOptions,
       FacilityNameAndSyncStatus,
       ImportFacilityModalGroup,
@@ -235,6 +249,7 @@
       return {
         showSyncAllModal: false,
         showImportModal: false,
+        showCreateFacilityModal: false,
         facilities: [],
         facilityForSync: null,
         facilityForRemoval: null,
@@ -245,6 +260,18 @@
       };
     },
     computed: {
+      options() {
+        return [
+          {
+            label: this.$tr('importFacilityLabel'),
+            value: ImportFacility,
+          },
+          {
+            label: this.$tr('createNewFacilityLabel'),
+            value: CreateNewFacility,
+          },
+        ];
+      },
       pageTitle() {
         return deviceString('deviceManagementTitle');
       },
@@ -344,6 +371,10 @@
         });
         this.showImportModal = false;
       },
+      handleCreateFacilitySuccess() {
+        this.showCreateFacilityModal = false;
+        this.fetchFacilites();
+      },
       manageSync(facilityId) {
         return {
           name: PageNames.MANAGE_SYNC_SCHEDULE,
@@ -389,6 +420,13 @@
             this.$emit('failure');
           });
       },
+      handleSelect(option) {
+        if (option.value == ImportFacility) {
+          this.showImportModal = true;
+        } else {
+          this.showCreateFacilityModal = true;
+        }
+      },
     },
     $trs: {
       syncAllAction: {
@@ -401,6 +439,18 @@
         context:
           "Notification that appears after a facility has been deleted. For example, \"Removed 'Zuk Village' from this device'.",
       },
+      createFacilityLabel: {
+        message: 'ADD FACILITY',
+        context: 'Label for a button used to create new facility.',
+      },
+      importFacilityLabel: {
+        message: 'Import facility',
+        context: 'Label for the dropdown option of import facility',
+      },
+      createNewFacilityLabel: {
+        message: 'Create new facility',
+        context: 'Label for the dropdown option of create new facility',
+      },
     },
   };
 

kolibri/plugins/setup_wizard/assets/src/constants.js

@@ -1,12 +1,5 @@
 import permissionPresets from '../../../../core/auth/constants/facility_configuration_presets.json';
 
-// aliasing 'informal' to 'personal' since it's how we talk about it
-const Presets = Object.freeze({
-  PERSONAL: 'informal',
-  FORMAL: 'formal',
-  NONFORMAL: 'nonformal',
-});
-
 /**
  * enum identifying whether the user has gone to the on my own flow or not
  */
@@ -43,7 +36,6 @@ export {
   permissionPresets,
   DeviceTypePresets,
   FacilityTypePresets,
-  Presets,
   UsePresets,
   SoudQueue,
   LodTypePresets,