Merge pull request #8615 from christianbeeznest/feature/survey-state-organization

Survey: Organize state providers and processors

Author: christianbeeznest

assets/vue/App.vue

@@ -242,7 +242,12 @@ const layout = computed(() => {
     return EmptyLayout
   }
 
-  if ((qp.has("lp_id") && "view" === qp.get("action")) || (qp.has("origin") && "learnpath" === qp.get("origin"))) {
+  const lpAction = String(qp.get("action") || "").toLowerCase()
+  const isLearningPathPlayerContext =
+    qp.has("lp_id") &&
+    ("view" === lpAction || "1" === qp.get("embedded") || "true" === String(qp.get("isStudentView") || ""))
+
+  if (isLearningPathPlayerContext) {
     return EmptyLayout
   }
 

assets/vue/composables/useTopbarLoggedIn.js

@@ -304,8 +304,11 @@ export function useTopbarLoggedIn(props) {
       if (resolvedRoute?.href) {
         return resolvedRoute.href
       }
-    } catch {}
-    return "/main/survey/pending.php"
+    } catch (error) {
+      console.error("Could not resolve pending surveys route", error)
+    }
+
+    return "/survey/pending"
   })
 
   const myServicesUrl = computed(() => {

assets/vue/router/index.js

@@ -466,6 +466,16 @@ const router = createRouter({
       component: MySessionListUpcoming,
       meta: { requiresAuth: true },
     },
+    {
+      path: "/survey/pending",
+      name: "SurveyPending",
+      component: () => import("../views/survey/SurveyPendingView.vue"),
+      meta: {
+        requiresAuth: true,
+        showBreadcrumb: true,
+        breadcrumb: "Pending surveys",
+      },
+    },
     fileManagerRoutes,
     socialNetworkRoutes,
     catalogue,
@@ -584,12 +594,13 @@ router.beforeEach(async (to, from, next) => {
   }
 
   // Determine what the route requires
+  const allowsAnonymousAccess = to.matched.some((record) => record.meta?.allowAnonymousAccess === true)
   const needsAuth = to.matched.some((record) => record.meta?.requiresAuth === true)
   const wantsAdmin = to.matched.some((record) => record.meta?.requiresAdmin === true)
   const wantsSessionAdmin = to.matched.some((record) => record.meta?.requiresSessionAdmin === true)
   const wantsHR = to.matched.some((record) => record.meta?.requiresHR === true)
 
-  const mustBeLogged = needsAuth || wantsAdmin || wantsSessionAdmin || wantsHR
+  const mustBeLogged = !allowsAnonymousAccess && (needsAuth || wantsAdmin || wantsSessionAdmin || wantsHR)
 
   if (mustBeLogged && !securityStore.isLoading) {
     await securityStore.checkSession()

assets/vue/router/survey.js

@@ -80,7 +80,7 @@ export default {
     {
       name: "SurveyAnswer",
       path: ":surveyId/answer",
-      meta: { breadcrumb: "Answer survey" },
+      meta: { breadcrumb: "Answer survey", allowAnonymousAccess: true },
       component: () => import("../views/survey/SurveyAnswerView.vue"),
     },
   ],

assets/vue/services/surveyService.js

@@ -36,6 +36,10 @@ export default {
     return await baseService.get("/api/survey/list", cleanParams(params), surveyRequestConfig())
   },
 
+  async getPendingSurveys(params = {}) {
+    return await baseService.get("/api/survey/pending", cleanParams(params), surveyRequestConfig())
+  },
+
   async getSurveyConfiguration(params = {}, surveyId = null) {
     const endpoint = surveyId ? `/api/survey/configuration/${surveyId}` : "/api/survey/configuration"
 

assets/vue/views/survey/SurveyAnswerView.vue

@@ -15,6 +15,7 @@
 
       <div class="flex flex-wrap items-center justify-end gap-2">
         <BaseButton
+          v-if="showBackToSurveyList"
           :label="t('Back to survey list')"
           :route="buildListRoute()"
           icon="back"
@@ -418,6 +419,28 @@ const currentPageIndex = ref(0)
 
 const surveyId = computed(() => Number(route.params.surveyId || 0))
 const previewMode = computed(() => route.name === "SurveyPreview" || route.query.preview === "1")
+const isLearningPathContext = computed(() => {
+  const origin = String(getQueryValue(route.query.origin) || "")
+  const returnToLp = String(getQueryValue(route.query.returnToLp) || "")
+
+  return (
+    origin === "learnpath" ||
+    returnToLp === "1" ||
+    Boolean(getQueryValue(route.query.lp_id)) ||
+    Boolean(getQueryValue(route.query.lpItemId || route.query.lp_item_id))
+  )
+})
+const isPublicAnswerContext = computed(() => {
+  return (
+    Boolean(getQueryValue(route.query.invitationCode || route.query.invitationcode)) ||
+    Boolean(getQueryValue(route.query.publicCid)) ||
+    Boolean(getQueryValue(route.query.publicSid)) ||
+    Boolean(getQueryValue(route.query.publicGid))
+  )
+})
+const showBackToSurveyList = computed(() => {
+  return !isLearningPathContext.value && !isPublicAnswerContext.value
+})
 const canInteract = computed(() => previewMode.value || canSubmit.value)
 const totalPages = computed(() => Math.max(1, pages.value.length))
 const currentQuestionIds = computed(() => pages.value[currentPageIndex.value] || [])
@@ -426,13 +449,26 @@ const currentVisibleQuestions = computed(() => currentQuestions.value.filter((qu
 const canGoNext = computed(() => currentPageIndex.value < totalPages.value - 1)
 const canGoBack = computed(() => settings.value.backwardsEnabled && currentPageIndex.value > 0)
 
+function getQueryValue(value) {
+  return Array.isArray(value) ? value[0] : value
+}
+
 function getContextParams() {
   return {
-    cid: route.query.cid,
-    sid: route.query.sid,
-    gid: route.query.gid,
-    invitationCode: route.query.invitationCode || route.query.invitationcode,
-    lpItemId: route.query.lpItemId || route.query.lp_item_id,
+    cid: getQueryValue(route.query.cid),
+    sid: getQueryValue(route.query.sid),
+    gid: getQueryValue(route.query.gid),
+    publicCid: getQueryValue(route.query.publicCid),
+    publicSid: getQueryValue(route.query.publicSid),
+    publicGid: getQueryValue(route.query.publicGid),
+    invitationCode: getQueryValue(route.query.invitationCode || route.query.invitationcode),
+    lpItemId: getQueryValue(route.query.lpItemId || route.query.lp_item_id),
+    lp_id: getQueryValue(route.query.lp_id),
+    origin: getQueryValue(route.query.origin),
+    type: getQueryValue(route.query.type),
+    returnToLp: getQueryValue(route.query.returnToLp),
+    embedded: getQueryValue(route.query.embedded),
+    isStudentView: getQueryValue(route.query.isStudentView),
     preview: previewMode.value ? 1 : undefined,
   }
 }
@@ -442,9 +478,9 @@ function buildListRoute() {
     name: "SurveyList",
     params: { node: route.params.node },
     query: {
-      cid: route.query.cid,
-      sid: route.query.sid,
-      gid: route.query.gid,
+      ...getContextParams(),
+      invitationCode: undefined,
+      preview: undefined,
     },
   }
 }
@@ -457,9 +493,9 @@ function buildConfigureRoute() {
       surveyId: surveyId.value,
     },
     query: {
-      cid: route.query.cid,
-      sid: route.query.sid,
-      gid: route.query.gid,
+      ...getContextParams(),
+      invitationCode: undefined,
+      preview: undefined,
     },
   }
 }

assets/vue/views/survey/SurveyConfigurationView.vue

@@ -22,6 +22,7 @@
 
         <div class="flex flex-wrap items-center gap-2">
           <BaseButton
+            v-if="!isLearningPathContext"
             :label="t('Back to survey list')"
             :route="buildListRoute()"
             icon="back"
@@ -362,6 +363,14 @@
         class="flex flex-col-reverse gap-3 rounded-2xl border border-gray-20 bg-white p-6 shadow-sm md:flex-row md:items-center md:justify-end"
       >
         <BaseButton
+          v-if="isLearningPathContext"
+          :label="t('Cancel')"
+          icon="close"
+          type="black"
+          @click="goToLearningPathAddItem"
+        />
+        <BaseButton
+          v-else
           :label="t('Cancel')"
           :route="buildListRoute()"
           icon="close"
@@ -467,14 +476,89 @@ function createEmptyForm() {
   }
 }
 
-function getContextParams() {
+function getContextParams(extra = {}) {
+  return cleanQueryParams({
+    cid: getQueryValue(route.query.cid),
+    sid: getQueryValue(route.query.sid),
+    gid: getQueryValue(route.query.gid),
+    origin: getQueryValue(route.query.origin),
+    lp_id: getQueryValue(route.query.lp_id),
+    lpItemId: getQueryValue(route.query.lpItemId || route.query.lp_item_id),
+    type: getQueryValue(route.query.type),
+    returnToLp: getQueryValue(route.query.returnToLp),
+    isStudentView: getQueryValue(route.query.isStudentView),
+    ...extra,
+  })
+}
+
+function getQueryValue(value) {
+  if (Array.isArray(value)) {
+    return value[0] || ""
+  }
+
+  return value || ""
+}
+
+function cleanQueryParams(params = {}) {
+  const cleanParams = {}
+
+  for (const [key, value] of Object.entries(params)) {
+    if (value !== undefined && value !== null && String(value) !== "") {
+      cleanParams[key] = value
+    }
+  }
+
+  return cleanParams
+}
+
+const learningPathId = computed(() => Number(getQueryValue(route.query.lp_id) || 0))
+
+const isLearningPathContext = computed(() => {
+  return getQueryValue(route.query.origin) === "learnpath" && learningPathId.value > 0
+})
+
+function buildLearningPathQuery(extra = {}) {
+  const query = new URLSearchParams()
+
+  query.set("action", extra.action || "add_item")
+  query.set("type", extra.type || "step")
+  query.set("lp_id", String(learningPathId.value))
+
+  for (const key of ["cid", "sid", "gid"]) {
+    const value = getQueryValue(route.query[key])
+
+    if (String(value) !== "") {
+      query.set(key, String(value))
+    }
+  }
+
+  query.set("isStudentView", "false")
+
+  if (extra.surveyId) {
+    query.set("survey_id", String(extra.surveyId))
+  }
+
+  return query.toString()
+}
+
+function buildLearningPathAddItemUrl() {
+  return `/main/lp/lp_controller.php?${buildLearningPathQuery()}`
+}
+
+function buildLearningPathQuestionsRoute(surveyId) {
   return {
-    cid: route.query.cid,
-    sid: route.query.sid,
-    gid: route.query.gid,
+    name: "SurveyQuestions",
+    params: {
+      node: route.params.node,
+      surveyId,
+    },
+    query: getContextParams({ lpItemId: undefined }),
   }
 }
 
+function goToLearningPathAddItem() {
+  window.location.href = buildLearningPathAddItemUrl()
+}
 
 function buildQuestionsRoute() {
   return {
@@ -654,6 +738,12 @@ async function submitForm() {
     csrfToken.value = saved.csrfToken || csrfToken.value
 
     if (!isEditMode.value && saved.surveyId) {
+      if (isLearningPathContext.value) {
+        await router.push(buildLearningPathQuestionsRoute(saved.surveyId))
+
+        return
+      }
+
       await router.push({
         name: "SurveyQuestions",
         params: {