vent-template/src/router/guard/permissionGuard.ts

import type { Router, RouteRecordRaw } from 'vue-router';

import { usePermissionStoreWithOut } from '/@/store/modules/permission';

import { PageEnum } from '/@/enums/pageEnum';
import { useUserStoreWithOut } from '/@/store/modules/user';

import { PAGE_NOT_FOUND_ROUTE, QIANKUN_ROUTE } from '/@/router/routes/basic';

import { RootRoute } from '/@/router/routes';

import { isOAuth2AppEnv } from '/@/views/sys/login/useLogin';
import { OAUTH2_THIRD_LOGIN_TENANT_ID } from '/@/enums/cacheEnum';

import { useGlobSetting } from '/@/hooks/setting';

import _ from 'lodash';
import { MOCK_LOGIN_URL_QUERY, SKIP_SSO_URL_QUERY } from '../constant';
import { useSso } from '/@/hooks/web/useSso';
import { useAutoLogin } from '/@/hooks/vent/useAutoLogin';

const LOGIN_PATH = PageEnum.BASE_LOGIN;
//auth2登录路由
const OAUTH2_LOGIN_PAGE_PATH = PageEnum.OAUTH2_LOGIN_PAGE_PATH;

//分享免登录路由
const SYS_FILES_PATH = PageEnum.SYS_FILES_PATH;

// 邮件中的跳转地址,对应此路由,携带token免登录直接去办理页面
const TOKEN_LOGIN = PageEnum.TOKEN_LOGIN;

const ROOT_PATH = RootRoute.path;

//update-begin---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3不支持auth2登录------------
//update-begin---author:wangshuai ---date:20221111  for: [VUEN-2472]分享免登录------------
const whitePathList: PageEnum[] = [LOGIN_PATH, OAUTH2_LOGIN_PAGE_PATH, SYS_FILES_PATH, TOKEN_LOGIN];
//update-end---author:wangshuai ---date:20221111  for: [VUEN-2472]分享免登录------------
//update-end---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3不支持auth2登录------------
const glob = useGlobSetting();

export function createPermissionGuard(router: Router) {
  // debugger;
  const userStore = useUserStoreWithOut();
  const permissionStore = usePermissionStoreWithOut();
  const { doAutoLogin, doTokenLogin, validateRoute, tokenValidateRoute } = useAutoLogin();

  router.beforeEach(async (to, from, next) => {
    RootRoute.redirect = glob.homePath || PageEnum.BASE_HOME;

    if (_.isEmpty(history.state.current)) {
      _.assign(history.state, { current: from.fullPath });
    }
    if (
      from.path === ROOT_PATH &&
      to.path === (glob.homePath || PageEnum.BASE_HOME) &&
      userStore.getUserInfo.homePath &&
      userStore.getUserInfo.homePath !== (glob.homePath || PageEnum.BASE_HOME)
    ) {
      // mountMicroApp(userStore.getUserInfo.homePath);
      next(userStore.getUserInfo.homePath);
      document.title = '首页';
      return;
    }

    // 如果符合自动登录的相关条件则直接执行自动登录，覆盖原有的登录信息
    if (validateRoute(to)) {
      await doAutoLogin(to);
      // 自动登录后会动态添加路由，此处应当重定向到fullPath，否则会加载404页面内容
      return next({ path: to.fullPath, replace: true, query: to.query });
    }
    if (tokenValidateRoute(to)) {
      await doTokenLogin(to.query['token'] as string);
    }
    // 如果指定了需要模拟登录则执行模拟登录，覆盖原有的登录信息
    if (to.query[MOCK_LOGIN_URL_QUERY.key] === MOCK_LOGIN_URL_QUERY.val) {
      await userStore.mockLogin({ goHome: false });
      delete to.query[MOCK_LOGIN_URL_QUERY.key];
      return next({ path: to.fullPath, replace: true, query: to.query });
    }

    const token = userStore.getToken;

    // Whitelist can be directly entered
    if (whitePathList.includes(to.path as PageEnum)) {
      if (to.path === LOGIN_PATH && token) {
        const isSessionTimeout = userStore.getSessionTimeout;

        //update-begin---author:scott ---date:2023-04-24  for：【QQYUN-4713】登录代码调整逻辑有问题，改造待观察--
        //TODO vben默认写法，暂时不知目的，有问题暂时先注释掉
        //await userStore.afterLoginAction();
        //update-end---author:scott ---date::2023-04-24  for：【QQYUN-4713】登录代码调整逻辑有问题，改造待观察--

        try {
          if (!isSessionTimeout) {
            next((to.query?.redirect as string) || '/');
            document.title = '';
            return;
          }
        } catch {}
        //update-begin---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3不支持auth2登录------------
      } else if (to.path === LOGIN_PATH && isOAuth2AppEnv() && !token) {
        //退出登录进入此逻辑
        //如果进入的页面是login页面并且当前是OAuth2app环境，并且token为空，就进入OAuth2登录页面
        //update-begin---author:wangshuai ---date:20230224  for：[QQYUN-3440]新建企业微信和钉钉配置表，通过租户模式隔离------------
        // if (to.query.tenantId) {
        //   setAuthCache(OAUTH2_THIRD_LOGIN_TENANT_ID, to.query.tenantId);
        // }
        next({ path: OAUTH2_LOGIN_PAGE_PATH });
        document.title = '登录';
        ///

        //update-end---author:wangshuai ---date:20230224  for：[QQYUN-3440]新建企业微信和钉钉配置表，通过租户模式隔离------------
        return;
        //update-end---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3不支持auth2登录------------
      }
      next();

      document.title = to.meta.title;
      return;
    }

    // token does not exist
    if (!token) {
      // You can access without permission. You need to set the routing meta.ignoreAuth to true
      if (to.meta.ignoreAuth) {
        next();
        document.title = to.meta.title;
        return;
      }
      // query如果没有明确要求跳过sso则执行sso登录
      if (to.query[SKIP_SSO_URL_QUERY.key] !== SKIP_SSO_URL_QUERY.val) {
        const redirectSso = await useSso().ssoLogin();
        // 如果需要重定向到sso页面则取消路由导航
        if (redirectSso) return;
      }
      // @deprecated query中要求自动登录的执行自动登录
      // if (to.query[AUTO_LOGIN_URL_QUERY.key] === AUTO_LOGIN_URL_QUERY.val) {
      //   const userStore = useUserStoreWithOut();
      //   await userStore.mockLogin({
      //     goHome: false,
      //   });
      //   return next({
      //     path: to.path,
      //     query: to.query,
      //   });
      // }

      //update-begin---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3 Auth2未实现------------
      let path = LOGIN_PATH;
      if (whitePathList.includes(to.path as PageEnum)) {
        // 在免登录白名单，如果进入的页面是login页面并且当前是OAuth2app环境，就进入OAuth2登录页面
        if (to.path === LOGIN_PATH && isOAuth2AppEnv()) {
          next({ path: OAUTH2_LOGIN_PAGE_PATH });
          document.title = '登录';
        } else {
          //在免登录白名单，直接进入
          // mountMicroApp(to.path);
          next();
          document.title = to.meta.title;
        }
      } else {
        //update-begin---author:wangshuai ---date:20230302  for：只有首次登陆并且是企业微信或者钉钉的情况下才会调用------------
        //----------【首次登陆并且是企业微信或者钉钉的情况下才会调用】-----------------------------------------------
        //只有首次登陆并且是企业微信或者钉钉的情况下才会调用
        const href = window.location.href;
        //判断当前是auth2页面，并且是钉钉/企业微信，并且包含tenantId参数
        if (isOAuth2AppEnv() && href.indexOf('/tenantId/') != -1) {
          const params = to.params;
          if (params && params.path && params.path.length > 0) {
            //直接获取参数最后一位
            setAuthCache(OAUTH2_THIRD_LOGIN_TENANT_ID, params.path[params.path.length - 1]);
          }
        }
        //---------【首次登陆并且是企业微信或者钉钉的情况下才会调用】------------------------------------------------
        //update-end---author:wangshuai ---date:20230302  for：只有首次登陆并且是企业微信或者钉钉的情况下才会调用------------
        // 如果当前是在OAuth2APP环境，就跳转到OAuth2登录页面，否则跳转到登录页面
        path = isOAuth2AppEnv() ? OAUTH2_LOGIN_PAGE_PATH : LOGIN_PATH;
      }
      //update-end---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3 Auth2未实现------------
      // redirect login page
      const redirectData: { path: string; replace: boolean; query?: Recordable<string> } = {
        //update-begin---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3 Auth2未实现------------
        path: path,
        //update-end---author:wangshuai ---date:20220629  for：[issues/I5BG1I]vue3 Auth2未实现------------
        replace: true,
      };

      //update-begin---author:scott ---date:2023-04-24  for：【QQYUN-4713】登录代码调整逻辑有问题，改造待观察--
      if (to.fullPath) {
        const getFullPath = to.fullPath;
        if (
          getFullPath == '/' ||
          getFullPath == '/500' ||
          getFullPath == '/400' ||
          getFullPath == '/login?redirect=/' ||
          getFullPath == '/login?redirect=/login?redirect=/'
        ) {
          return;
        }
        //update-end---author:scott ---date:2023-04-24  for：【QQYUN-4713】登录代码调整逻辑有问题，改造待观察--

        redirectData.query = {
          ...redirectData.query,
          // update-begin-author:sunjianlei date:20230306 for: 修复登录成功后，没有正确重定向的问题
          redirect: to.fullPath,
          // update-end-author:sunjianlei date:20230306 for: 修复登录成功后，没有正确重定向的问题
        };
      }
      // mountMicroApp(redirectData.path);
      next(redirectData);
      document.title = '';
      return;
    }
    //==============================【首次登录并且是企业微信或者钉钉的情况下才会调用】==================
    //判断是免登录页面,如果页面包含/tenantId/,那么就直接前往主页
    if (isOAuth2AppEnv() && to.path.indexOf('/tenantId/') != -1) {
      next(userStore.getUserInfo.homePath || PageEnum.BASE_HOME);
      document.title = '首页';
      return;
    }
    //==============================【首次登录并且是企业微信或者钉钉的情况下才会调用】==================

    // Jump to the 404 page after processing the login
    if (
      from.path === LOGIN_PATH &&
      to.name === PAGE_NOT_FOUND_ROUTE.name &&
      to.fullPath !== (userStore.getUserInfo.homePath || glob.homePath || PageEnum.BASE_HOME)
    ) {
      // mountMicroApp(userStore.getUserInfo.homePath || PageEnum.BASE_HOME);
      next(userStore.getUserInfo.homePath || PageEnum.BASE_HOME);
      document.title = '首页';
      return;
    }

    // get userinfo while last fetch time is empty
    if (userStore.getLastUpdateTime === 0) {
      try {
        await userStore.getUserInfoAction();
      } catch (err) {
        console.info(err);
        // mountMicroApp(to.path);
        next();
        document.title = to.meta.title;
      }
    }
    if (permissionStore.getIsDynamicAddedRoute) {
      // mountMicroApp(to.path);
      next();
      document.title = to.meta.title;
      return;
    }

    const routes = await permissionStore.buildRoutesAction();

    routes.forEach((route) => {
      router.addRoute(route as unknown as RouteRecordRaw);
    });

    router.addRoute(PAGE_NOT_FOUND_ROUTE as unknown as RouteRecordRaw); //
    router.addRoute(QIANKUN_ROUTE as unknown as RouteRecordRaw);

    permissionStore.setDynamicAddedRoute(true);

    if (to.name === PAGE_NOT_FOUND_ROUTE.name) {
      // 动态添加路由后，此处应当重定向到fullPath，否则会加载404页面内容
      next({ path: to.fullPath, replace: true, query: to.query });
    } else {
      const redirectPath = (from.query.redirect || to.path) as string;
      const redirect = decodeURIComponent(redirectPath);
      const nextData = to.path === redirect ? { ...to, replace: true } : { path: redirect };
      // mountMicroApp(nextData.path);
      next(nextData);
      document.title = '';
    }
  });
}