permissionGuard.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. import type { Router, RouteRecordRaw } from 'vue-router';
  2. import { usePermissionStoreWithOut } from '/@/store/modules/permission';
  3. import { PageEnum } from '/@/enums/pageEnum';
  4. import { useUserStoreWithOut } from '/@/store/modules/user';
  5. import { PAGE_NOT_FOUND_ROUTE, QIANKUN_ROUTE } from '/@/router/routes/basic';
  6. import { RootRoute } from '/@/router/routes';
  7. import { isOAuth2AppEnv } from '/@/views/sys/login/useLogin';
  8. import { OAUTH2_THIRD_LOGIN_TENANT_ID } from '/@/enums/cacheEnum';
  9. import { useGlobSetting } from '/@/hooks/setting';
  10. import _ from 'lodash';
  11. import { MOCK_LOGIN_URL_QUERY, SKIP_SSO_URL_QUERY } from '../constant';
  12. import { useSso } from '/@/hooks/web/useSso';
  13. import { useAutoLogin } from '/@/hooks/vent/useAutoLogin';
  14. const LOGIN_PATH = PageEnum.BASE_LOGIN;
  15. //auth2登录路由
  16. const OAUTH2_LOGIN_PAGE_PATH = PageEnum.OAUTH2_LOGIN_PAGE_PATH;
  17. //分享免登录路由
  18. const SYS_FILES_PATH = PageEnum.SYS_FILES_PATH;
  19. // 邮件中的跳转地址,对应此路由,携带token免登录直接去办理页面
  20. const TOKEN_LOGIN = PageEnum.TOKEN_LOGIN;
  21. const ROOT_PATH = RootRoute.path;
  22. //update-begin---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3不支持auth2登录------------
  23. //update-begin---author:wangshuai ---date:20221111 for: [VUEN-2472]分享免登录------------
  24. const whitePathList: PageEnum[] = [LOGIN_PATH, OAUTH2_LOGIN_PAGE_PATH, SYS_FILES_PATH, TOKEN_LOGIN];
  25. //update-end---author:wangshuai ---date:20221111 for: [VUEN-2472]分享免登录------------
  26. //update-end---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3不支持auth2登录------------
  27. const glob = useGlobSetting();
  28. export function createPermissionGuard(router: Router) {
  29. const userStore = useUserStoreWithOut();
  30. const permissionStore = usePermissionStoreWithOut();
  31. const { doAutoLogin, validateRoute } = useAutoLogin();
  32. router.beforeEach(async (to, from, next) => {
  33. RootRoute.redirect = glob.homePath || PageEnum.BASE_HOME;
  34. if (_.isEmpty(history.state.current)) {
  35. _.assign(history.state, { current: from.fullPath });
  36. }
  37. if (
  38. from.path === ROOT_PATH &&
  39. to.path === (glob.homePath || PageEnum.BASE_HOME) &&
  40. userStore.getUserInfo.homePath &&
  41. userStore.getUserInfo.homePath !== (glob.homePath || PageEnum.BASE_HOME)
  42. ) {
  43. // mountMicroApp(userStore.getUserInfo.homePath);
  44. next(userStore.getUserInfo.homePath);
  45. document.title = '首页';
  46. return;
  47. }
  48. // 如果符合自动登录的相关条件则直接执行自动登录,覆盖原有的登录信息
  49. if (validateRoute(to)) {
  50. await doAutoLogin(to);
  51. // 自动登录后会动态添加路由,此处应当重定向到fullPath,否则会加载404页面内容
  52. return next({ path: to.fullPath, replace: true, query: to.query });
  53. }
  54. // 如果指定了需要模拟登录则执行模拟登录,覆盖原有的登录信息
  55. if (to.query[MOCK_LOGIN_URL_QUERY.key] === MOCK_LOGIN_URL_QUERY.val) {
  56. await userStore.mockLogin({ goHome: false });
  57. delete to.query[MOCK_LOGIN_URL_QUERY.key];
  58. return next({ path: to.fullPath, replace: true, query: to.query });
  59. }
  60. const token = userStore.getToken;
  61. // Whitelist can be directly entered
  62. if (whitePathList.includes(to.path as PageEnum)) {
  63. if (to.path === LOGIN_PATH && token) {
  64. const isSessionTimeout = userStore.getSessionTimeout;
  65. //update-begin---author:scott ---date:2023-04-24 for:【QQYUN-4713】登录代码调整逻辑有问题,改造待观察--
  66. //TODO vben默认写法,暂时不知目的,有问题暂时先注释掉
  67. //await userStore.afterLoginAction();
  68. //update-end---author:scott ---date::2023-04-24 for:【QQYUN-4713】登录代码调整逻辑有问题,改造待观察--
  69. try {
  70. if (!isSessionTimeout) {
  71. next((to.query?.redirect as string) || '/');
  72. document.title = '';
  73. return;
  74. }
  75. } catch {}
  76. //update-begin---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3不支持auth2登录------------
  77. } else if (to.path === LOGIN_PATH && isOAuth2AppEnv() && !token) {
  78. //退出登录进入此逻辑
  79. //如果进入的页面是login页面并且当前是OAuth2app环境,并且token为空,就进入OAuth2登录页面
  80. //update-begin---author:wangshuai ---date:20230224 for:[QQYUN-3440]新建企业微信和钉钉配置表,通过租户模式隔离------------
  81. // if (to.query.tenantId) {
  82. // setAuthCache(OAUTH2_THIRD_LOGIN_TENANT_ID, to.query.tenantId);
  83. // }
  84. next({ path: OAUTH2_LOGIN_PAGE_PATH });
  85. document.title = '登录';
  86. ///
  87. //update-end---author:wangshuai ---date:20230224 for:[QQYUN-3440]新建企业微信和钉钉配置表,通过租户模式隔离------------
  88. return;
  89. //update-end---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3不支持auth2登录------------
  90. }
  91. next();
  92. document.title = to.meta.title;
  93. return;
  94. }
  95. // token does not exist
  96. if (!token) {
  97. // You can access without permission. You need to set the routing meta.ignoreAuth to true
  98. if (to.meta.ignoreAuth) {
  99. next();
  100. document.title = to.meta.title;
  101. return;
  102. }
  103. // query如果没有明确要求跳过sso则执行sso登录
  104. if (to.query[SKIP_SSO_URL_QUERY.key] !== SKIP_SSO_URL_QUERY.val) {
  105. const redirectSso = await useSso().ssoLogin();
  106. // 如果需要重定向到sso页面则取消路由导航
  107. if (redirectSso) return;
  108. }
  109. // @deprecated query中要求自动登录的执行自动登录
  110. // if (to.query[AUTO_LOGIN_URL_QUERY.key] === AUTO_LOGIN_URL_QUERY.val) {
  111. // const userStore = useUserStoreWithOut();
  112. // await userStore.mockLogin({
  113. // goHome: false,
  114. // });
  115. // return next({
  116. // path: to.path,
  117. // query: to.query,
  118. // });
  119. // }
  120. //update-begin---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3 Auth2未实现------------
  121. let path = LOGIN_PATH;
  122. if (whitePathList.includes(to.path as PageEnum)) {
  123. // 在免登录白名单,如果进入的页面是login页面并且当前是OAuth2app环境,就进入OAuth2登录页面
  124. if (to.path === LOGIN_PATH && isOAuth2AppEnv()) {
  125. next({ path: OAUTH2_LOGIN_PAGE_PATH });
  126. document.title = '登录';
  127. } else {
  128. //在免登录白名单,直接进入
  129. // mountMicroApp(to.path);
  130. next();
  131. document.title = to.meta.title;
  132. }
  133. } else {
  134. //update-begin---author:wangshuai ---date:20230302 for:只有首次登陆并且是企业微信或者钉钉的情况下才会调用------------
  135. //----------【首次登陆并且是企业微信或者钉钉的情况下才会调用】-----------------------------------------------
  136. //只有首次登陆并且是企业微信或者钉钉的情况下才会调用
  137. const href = window.location.href;
  138. //判断当前是auth2页面,并且是钉钉/企业微信,并且包含tenantId参数
  139. if (isOAuth2AppEnv() && href.indexOf('/tenantId/') != -1) {
  140. const params = to.params;
  141. if (params && params.path && params.path.length > 0) {
  142. //直接获取参数最后一位
  143. setAuthCache(OAUTH2_THIRD_LOGIN_TENANT_ID, params.path[params.path.length - 1]);
  144. }
  145. }
  146. //---------【首次登陆并且是企业微信或者钉钉的情况下才会调用】------------------------------------------------
  147. //update-end---author:wangshuai ---date:20230302 for:只有首次登陆并且是企业微信或者钉钉的情况下才会调用------------
  148. // 如果当前是在OAuth2APP环境,就跳转到OAuth2登录页面,否则跳转到登录页面
  149. path = isOAuth2AppEnv() ? OAUTH2_LOGIN_PAGE_PATH : LOGIN_PATH;
  150. }
  151. //update-end---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3 Auth2未实现------------
  152. // redirect login page
  153. const redirectData: { path: string; replace: boolean; query?: Recordable<string> } = {
  154. //update-begin---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3 Auth2未实现------------
  155. path: path,
  156. //update-end---author:wangshuai ---date:20220629 for:[issues/I5BG1I]vue3 Auth2未实现------------
  157. replace: true,
  158. };
  159. //update-begin---author:scott ---date:2023-04-24 for:【QQYUN-4713】登录代码调整逻辑有问题,改造待观察--
  160. if (to.fullPath) {
  161. const getFullPath = to.fullPath;
  162. if (
  163. getFullPath == '/' ||
  164. getFullPath == '/500' ||
  165. getFullPath == '/400' ||
  166. getFullPath == '/login?redirect=/' ||
  167. getFullPath == '/login?redirect=/login?redirect=/'
  168. ) {
  169. return;
  170. }
  171. //update-end---author:scott ---date:2023-04-24 for:【QQYUN-4713】登录代码调整逻辑有问题,改造待观察--
  172. redirectData.query = {
  173. ...redirectData.query,
  174. // update-begin-author:sunjianlei date:20230306 for: 修复登录成功后,没有正确重定向的问题
  175. redirect: to.fullPath,
  176. // update-end-author:sunjianlei date:20230306 for: 修复登录成功后,没有正确重定向的问题
  177. };
  178. }
  179. // mountMicroApp(redirectData.path);
  180. next(redirectData);
  181. document.title = '';
  182. return;
  183. }
  184. //==============================【首次登录并且是企业微信或者钉钉的情况下才会调用】==================
  185. //判断是免登录页面,如果页面包含/tenantId/,那么就直接前往主页
  186. if (isOAuth2AppEnv() && to.path.indexOf('/tenantId/') != -1) {
  187. next(userStore.getUserInfo.homePath || PageEnum.BASE_HOME);
  188. document.title = '首页';
  189. return;
  190. }
  191. //==============================【首次登录并且是企业微信或者钉钉的情况下才会调用】==================
  192. // Jump to the 404 page after processing the login
  193. if (
  194. from.path === LOGIN_PATH &&
  195. to.name === PAGE_NOT_FOUND_ROUTE.name &&
  196. to.fullPath !== (userStore.getUserInfo.homePath || glob.homePath || PageEnum.BASE_HOME)
  197. ) {
  198. // mountMicroApp(userStore.getUserInfo.homePath || PageEnum.BASE_HOME);
  199. next(userStore.getUserInfo.homePath || PageEnum.BASE_HOME);
  200. document.title = '首页';
  201. return;
  202. }
  203. // get userinfo while last fetch time is empty
  204. if (userStore.getLastUpdateTime === 0) {
  205. try {
  206. await userStore.getUserInfoAction();
  207. } catch (err) {
  208. console.info(err);
  209. // mountMicroApp(to.path);
  210. next();
  211. document.title = to.meta.title;
  212. }
  213. }
  214. if (permissionStore.getIsDynamicAddedRoute) {
  215. // mountMicroApp(to.path);
  216. next();
  217. document.title = to.meta.title;
  218. return;
  219. }
  220. const routes = await permissionStore.buildRoutesAction();
  221. routes.forEach((route) => {
  222. router.addRoute(route as unknown as RouteRecordRaw);
  223. });
  224. router.addRoute(PAGE_NOT_FOUND_ROUTE as unknown as RouteRecordRaw); //
  225. router.addRoute(QIANKUN_ROUTE as unknown as RouteRecordRaw);
  226. permissionStore.setDynamicAddedRoute(true);
  227. if (to.name === PAGE_NOT_FOUND_ROUTE.name) {
  228. // 动态添加路由后,此处应当重定向到fullPath,否则会加载404页面内容
  229. next({ path: to.fullPath, replace: true, query: to.query });
  230. } else {
  231. const redirectPath = (from.query.redirect || to.path) as string;
  232. const redirect = decodeURIComponent(redirectPath);
  233. const nextData = to.path === redirect ? { ...to, replace: true } : { path: redirect };
  234. // mountMicroApp(nextData.path);
  235. next(nextData);
  236. document.title = '';
  237. }
  238. });
  239. }