Merge pull request #7159 from christianbeeznest/GH-3800-clean

Search: enable Xapian indexing for course resources - refs #3800

Author: christianbeeznest

assets/vue/components/documents/FormNewDocument.vue

@@ -1,12 +1,14 @@
 <template>
   <form>
+    <!-- Title -->
     <BaseInputTextWithVuelidate
       id="item_title"
       v-model.trim="item.title"
       :label="$t('Title')"
       :vuelidate-property="v$.item.title"
     />
 
+    <!-- Content editor -->
     <BaseTinyEditor
       v-if="
         (item.resourceNode && item.resourceNode.firstResourceFile && item.resourceNode.firstResourceFile.text) ||
@@ -18,9 +20,28 @@
       required
     />
 
-    <!-- For extra content-->
+    <!-- Advanced options: search / indexing -->
+    <BaseAdvancedSettingsButton
+      v-if="searchEnabled"
+      v-model="showAdvancedSettings"
+    >
+      <div class="flex flex-row mb-2">
+        <label class="font-semibold w-40">
+          {{ $t('Options') }}:
+        </label>
+        <BaseCheckbox
+          id="indexDocumentContent"
+          v-model="item.indexDocumentContent"
+          :label="$t('Index document content?')"
+          name="indexDocumentContent"
+        />
+      </div>
+    </BaseAdvancedSettingsButton>
+
+    <!-- For extra content -->
     <slot></slot>
 
+    <!-- Submit -->
     <BaseButton
       type="primary"
       icon="save"
@@ -39,22 +60,35 @@ import BaseInputTextWithVuelidate from "../basecomponents/BaseInputTextWithVueli
 import BaseTinyEditor from "../basecomponents/BaseTinyEditor.vue"
 import { useI18n } from "vue-i18n"
 import BaseButton from "../basecomponents/BaseButton.vue"
+import BaseAdvancedSettingsButton from "../basecomponents/BaseAdvancedSettingsButton.vue"
+import BaseCheckbox from "../basecomponents/BaseCheckbox.vue"
 
 export default {
   name: "DocumentsForm",
-  components: { BaseButton, BaseTinyEditor, BaseInputTextWithVuelidate },
+  components: {
+    BaseButton,
+    BaseTinyEditor,
+    BaseInputTextWithVuelidate,
+    BaseAdvancedSettingsButton,
+    BaseCheckbox,
+  },
   props: {
     values: {
       type: Object,
       required: true,
     },
     errors: {
       type: Object,
-      default: () => {},
+      default: () => ({}),
     },
     initialValues: {
       type: Object,
-      default: () => {},
+      default: () => ({}),
+    },
+    // Indicates if full-text search is enabled at platform level
+    searchEnabled: {
+      type: Boolean,
+      default: false,
     },
   },
   setup() {
@@ -74,19 +108,19 @@ export default {
       contentFile: this.initialValues ? this.initialValues.contentFile : "",
       parentResourceNodeId: null,
       resourceNode: null,
+      showAdvancedSettings: false,
     }
   },
   computed: {
     item() {
-      return this.initialValues || this.values
+      // Prefer initialValues when present (edit mode), otherwise use values (create mode)
+      return this.initialValues && Object.keys(this.initialValues).length > 0
+        ? this.initialValues
+        : this.values
     },
     titleErrors() {
       const errors = []
 
-      /*if (!this.$v.item.title.$dirty) return errors;
-            has(this.violations, 'title') && errors.push(this.violations.title);
-            !this.$v.item.title.required && errors.push(this.$t('Required field'));*/
-
       if (this.v$.item.title.required) {
         return this.$t("Required field")
       }
@@ -99,12 +133,13 @@ export default {
   },
   watch: {
     contentFile(newContent) {
-      tinymce.get("item_content").setContent(newContent)
+      if (window.tinymce && tinymce.get("item_content")) {
+        tinymce.get("item_content").setContent(newContent)
+      }
     },
   },
   methods: {
     browser(callback, value, meta) {
-      //const route = useRoute();
       let nodeId = this.$route.params["node"]
       let folderParams = this.$route.query
       let url = this.$router.resolve({
@@ -113,54 +148,39 @@ export default {
         query: folderParams,
       })
       url = url.fullPath
-      console.log(url)
 
       if (meta.filetype === "image") {
         url = url + "&type=images"
       } else {
         url = url + "&type=files"
       }
 
-      console.log(url)
-
       window.addEventListener("message", function (event) {
-        var data = event.data
+        const data = event.data
         if (data.url) {
-          url = data.url
-          console.log(meta) // {filetype: "image", fieldname: "src"}
-          callback(url)
+          const finalUrl = data.url
+          callback(finalUrl)
         }
       })
 
       tinymce.activeEditor.windowManager.openUrl(
         {
-          url: url, // use an absolute path!
+          url: url,
           title: "file manager",
-          /*width: 900,
-                  height: 450,
-                  resizable: 'yes'*/
         },
         {
           oninsert: function (file, fm) {
-            var url, info
-
-            // URL normalization
-            url = fm.convAbsUrl(file.url)
-
-            // Make file info
-            info = file.name + " (" + fm.formatSize(file.size) + ")"
+            let url = fm.convAbsUrl(file.url)
+            const info = file.name + " (" + fm.formatSize(file.size) + ")"
 
-            // Provide file and text for the link dialog
             if (meta.filetype === "file") {
               callback(url, { text: info, title: info })
             }
 
-            // Provide image and alt text for the image dialog
             if (meta.filetype === "image") {
               callback(url, { alt: info })
             }
 
-            // Provide alternative source and posted for the media dialog
             if (meta.filetype === "media") {
               callback(url)
             }
@@ -179,7 +199,7 @@ export default {
         required,
       },
       contentFile: {
-        //required,
+        // required,
       },
       parentResourceNodeId: {},
       resourceNode: {},

assets/vue/composables/sidebarMenu.js

@@ -16,6 +16,8 @@ export function useSidebarMenu() {
 
   const allowSocialTool = computed(() => platformConfigStore.getSetting("social.allow_social_tool") !== "false")
 
+  const allowSearchFeature = computed(() => platformConfigStore.getSetting("search.search_enabled") === "true")
+
   const showTabs = computed(() => {
     const defaultTabs = platformConfigStore.getSetting("display.show_tabs") || []
     const tabsPerRoleJson = platformConfigStore.getSetting("display.show_tabs_per_role") || ""
@@ -158,6 +160,15 @@ export function useSidebarMenu() {
       }),
     )
 
+    // Global search (Xapian)
+    if (allowSearchFeature.value) {
+      items.push({
+        icon: "mdi mdi-magnify",
+        label: t("Search"),
+        url: "/search/xapian/ui",
+      })
+    }
+
     if (showTabs.value.indexOf("reporting") > -1) {
       const subItems = []
 
@@ -259,9 +270,7 @@ export function useSidebarMenu() {
 
     {
       const roles = securityStore.user?.roles || []
-      const isQuestionManager =
-        securityStore.isAdmin ||
-        roles.includes("ROLE_QUESTION_MANAGER")
+      const isQuestionManager = securityStore.isAdmin || roles.includes("ROLE_QUESTION_MANAGER")
 
       if (isQuestionManager) {
         const questionAdminItems = [

assets/vue/views/documents/CreateFile.vue

@@ -11,13 +11,16 @@
         @template-selected="addTemplateToEditor"
       />
     </div>
+
     <div class="documents-form-container">
       <DocumentsForm
         ref="createForm"
         :errors="errors"
         :values="item"
+        :search-enabled="searchEnabled"
         @submit="onSendFormData"
       />
+
       <Panel
         v-if="$route.query.filetype === 'certificate'"
         :header="
@@ -30,6 +33,7 @@
       </Panel>
     </div>
   </div>
+
   <Loading :visible="isLoading" />
 </template>
 
@@ -42,6 +46,7 @@ import { RESOURCE_LINK_PUBLISHED } from "../../constants/entity/resourcelink"
 import Panel from "primevue/panel"
 import TemplateList from "../../components/documents/TemplateList.vue"
 import documentsService from "../../services/documents"
+import { usePlatformConfig } from "../../store/platformConfig"
 
 const servicePrefix = "Documents"
 
@@ -56,12 +61,28 @@ export default {
     Panel,
   },
   mixins: [CreateMixin],
+
+  // Read platform search setting once and expose as simple booleans
+  setup() {
+    const platformConfigStore = usePlatformConfig()
+
+    const raw = platformConfigStore.getSetting("search.search_enabled")
+    const searchEnabled = raw !== "false"
+    const defaultIndexDocumentContent = searchEnabled
+
+    return {
+      searchEnabled,
+      defaultIndexDocumentContent,
+    }
+  },
+
   data() {
     const allowedFiletypes = ["file", "video", "audio", "certificate"]
     const filetypeQuery = this.$route.query.filetype
     const filetype = allowedFiletypes.includes(filetypeQuery) ? filetypeQuery : "file"
 
     const finalTags = this.getCertificateTags()
+
     return {
       item: {
         title: "",
@@ -70,13 +91,17 @@ export default {
         filetype: filetype,
         parentResourceNodeId: null,
         resourceLinkList: null,
+
+        // Search-related flag: default depends on global search setting
+        indexDocumentContent: this.defaultIndexDocumentContent,
       },
       templates: [],
       isLoading: false,
       errors: {},
       finalTags,
     }
   },
+
   created() {
     this.item.parentResourceNodeId = this.$route.params.node
     this.item.resourceLinkList = JSON.stringify([
@@ -88,27 +113,31 @@ export default {
       },
     ])
   },
+
   methods: {
     handleBack() {
       this.$router.back()
     },
+
     addTemplateToEditor(templateContent) {
       this.item.contentFile = templateContent
     },
+
     async fetchTemplates() {
       this.errors = {}
       const courseId = this.$route.query.cid
       try {
-        let data = await documentsService.getTemplates(courseId)
+        const data = await documentsService.getTemplates(courseId)
         this.templates = data
       } catch (error) {
         console.error(error)
         this.errors = error.errors
       }
     },
+
     getCertificateTags() {
       let finalTags = ""
-      let tags = [
+      const tags = [
         "((user_firstname))",
         "((user_lastname))",
         "((user_username))",
@@ -138,12 +167,13 @@ export default {
 
       return finalTags
     },
+
     async createWithFormData(payload) {
       this.isLoading = true
       this.errors = {}
       try {
-        let response = await documentsService.createWithFormData(payload)
-        let data = await response.json()
+        const response = await documentsService.createWithFormData(payload)
+        const data = await response.json()
         console.log(data)
         this.onCreated(data)
       } catch (error) {
@@ -153,6 +183,7 @@ export default {
         this.isLoading = false
       }
     },
+
     onCreated(item) {
       let message
       if (item["resourceNode"]) {
@@ -162,11 +193,13 @@ export default {
             : `${item["resourceNode"].title} created`
       } else {
         message =
-          this.$i18n && this.$i18n.t ? this.$t("{resource} created", { resource: item.title }) : `${item.title} created`
+          this.$i18n && this.$i18n.t
+            ? this.$t("{resource} created", { resource: item.title })
+            : `${item.title} created`
       }
 
       this.showMessage(message)
-      let folderParams = this.$route.query
+      const folderParams = this.$route.query
 
       this.$router.push({
         name: `${this.$options.servicePrefix}List`,
@@ -175,6 +208,7 @@ export default {
       })
     },
   },
+
   mounted() {
     this.fetchTemplates()
   },