feat: add context property to PluginType and update related components for profiles and subscriptions

Author: Ayideyia

frontend/src/lang/locale/en.ts

@@ -481,6 +481,7 @@ export default {
     path: 'Save Path',
     type: 'Type',
     menus: 'Menus',
+    context: 'Context',
     configuration: ' Configuration',
     menuKey: 'Menu Title',
     menuValue: 'Trigger function name',

frontend/src/lang/locale/zh.ts

@@ -479,6 +479,7 @@ export default {
     path: '保存路径',
     type: '类型',
     menus: '菜单',
+    context: '上下文',
     configuration: '配置',
     menuKey: '菜单名称',
     menuValue: '触发方法名',

frontend/src/stores/plugins.ts

@@ -37,13 +37,19 @@ export type PluginType = {
   path: string
   triggers: PluginTrigger[]
   menus: Record<string, string>
+  context: {
+    profiles: Recordable
+    subscriptions: Recordable
+    rulesets: Recordable
+    plugins: Recordable
+    scheduledtasks: Recordable
+  }
   configuration: PluginConfiguration[]
   disabled: boolean
   install: boolean
   installed: boolean
   status: number // 0: Normal 1: Running 2: Stopped
   // Not Config
-  key?: string
   updating?: boolean
   loading?: boolean
   running?: boolean
@@ -94,14 +100,24 @@ export const usePluginsStore = defineStore('plugins', () => {
     data && (plugins.value = parse(data))
 
     for (let i = 0; i < plugins.value.length; i++) {
-      const { id, triggers, path } = plugins.value[i]
+      const { id, triggers, path, context } = plugins.value[i]
       const code = await ignoredError(Readfile, path)
       if (code) {
         PluginsCache[id] = { plugin: plugins.value[i], code }
         triggers.forEach((trigger) => {
           PluginsTriggerMap[trigger].observers.push(id)
         })
       }
+
+      if (!context) {
+        plugins.value[i].context = {
+          profiles: {},
+          subscriptions: {},
+          rulesets: {},
+          plugins: {},
+          scheduledtasks: {},
+        }
+      }
     }
   }
 
@@ -148,7 +164,7 @@ export const usePluginsStore = defineStore('plugins', () => {
   }
 
   const savePlugins = debounce(async () => {
-    const p = omitArray(plugins.value, ['key', 'updating', 'loading', 'running'])
+    const p = omitArray(plugins.value, ['updating', 'loading', 'running'])
     await Writefile(PluginsFilePath, stringify(p))
   }, 100)
 

frontend/src/views/PluginsView/components/PluginForm.vue

@@ -30,6 +30,13 @@ const plugin = ref<PluginType>({
   path: `data/plugins/plugin-${pluginID}.js`,
   triggers: [PluginTrigger.OnManual],
   menus: {},
+  context: {
+    profiles: {},
+    subscriptions: {},
+    rulesets: {},
+    plugins: {},
+    scheduledtasks: {},
+  },
   configuration: [],
   disabled: false,
   install: false,
@@ -47,8 +54,6 @@ const handleSubmit = async () => {
   loading.value = true
   try {
     if (props.isUpdate) {
-      // Refresh the key to re-render the view
-      plugin.value.key = sampleID()
       await pluginsStore.editPlugin(props.id, plugin.value)
     } else {
       await pluginsStore.addPlugin(plugin.value)
@@ -188,6 +193,26 @@ if (props.isUpdate) {
           :placeholder="[t('plugin.menuKey'), t('plugin.menuValue')]"
         />
       </div>
+      <div
+        :class="{ 'flex-start': Object.keys(plugin.context.profiles).length !== 0 }"
+        class="form-item"
+      >
+        <div class="name">{{ t('plugin.context') }} - {{ t('router.profiles') }}</div>
+        <KeyValueEditor
+          v-model="plugin.context.profiles"
+          :placeholder="[t('plugin.menuKey'), t('plugin.menuValue')]"
+        />
+      </div>
+      <div
+        :class="{ 'flex-start': Object.keys(plugin.context.subscriptions).length !== 0 }"
+        class="form-item"
+      >
+        <div class="name">{{ t('plugin.context') }} - {{ t('router.subscriptions') }}</div>
+        <KeyValueEditor
+          v-model="plugin.context.subscriptions"
+          :placeholder="[t('plugin.menuKey'), t('plugin.menuValue')]"
+        />
+      </div>
       <Divider>{{ t('plugin.configuration') }}</Divider>
       <div v-draggable="[plugin.configuration, { ...DraggableOptions, handle: '.drag' }]">
         <template v-for="(conf, index) in plugin.configuration" :key="conf.id">

frontend/src/views/PluginsView/index.vue

@@ -226,7 +226,7 @@ const onSortUpdate = debounce(pluginsStore.savePlugins, 1000)
   >
     <Card
       v-for="p in pluginsStore.plugins"
-      :key="p.id + p.key"
+      :key="p.id"
       :title="p.name"
       :disabled="p.disabled"
       v-menu="generateMenus(p)"

frontend/src/views/ProfilesView/index.vue

@@ -12,6 +12,7 @@ import {
   useAppSettingsStore,
   useKernelApiStore,
   useSubscribesStore,
+  usePluginsStore,
 } from '@/stores'
 
 import ProfileForm from './components/ProfileForm.vue'
@@ -28,8 +29,29 @@ const profilesStore = useProfilesStore()
 const subscribesStore = useSubscribesStore()
 const appSettingsStore = useAppSettingsStore()
 const kernelApiStore = useKernelApiStore()
+const pluginsStore = usePluginsStore()
 
-const secondaryMenus: Menu[] = [
+const menuList: Menu[] = [
+  ...[
+    'profile.step.name',
+    'profile.step.general',
+    'profile.step.inbounds',
+    'profile.step.outbounds',
+    'profile.step.route',
+    'profile.step.dns',
+    'profile.step.mixin-script',
+  ].map((v, i) => {
+    return {
+      label: v,
+      handler: (id: string) => {
+        const p = profilesStore.getProfileById(id)
+        p && handleEditProfile(p, i)
+      },
+    }
+  }),
+]
+
+const secondaryMenusList: Menu[] = [
   {
     label: 'profiles.start',
     handler: async (id: string) => {
@@ -81,33 +103,58 @@ const secondaryMenus: Menu[] = [
   },
 ]
 
-const menus: Menu[] = [
-  ...[
-    'profile.step.name',
-    'profile.step.general',
-    'profile.step.inbounds',
-    'profile.step.outbounds',
-    'profile.step.route',
-    'profile.step.dns',
-    'profile.step.mixin-script',
-  ].map((v, i) => {
-    return {
-      label: v,
-      handler: (id: string) => {
-        const p = profilesStore.getProfileById(id)
-        p && handleEditProfile(p, i)
+const generateMenus = (profile: IProfile) => {
+  const moreMenus: Menu[] = secondaryMenusList.map((v) => ({
+    ...v,
+    handler: () => v.handler?.(profile.id),
+  }))
+  const builtInMenus: Menu[] = [
+    ...menuList.map((v) => ({ ...v, handler: () => v.handler?.(profile.id) })),
+    {
+      label: '',
+      separator: true,
+    },
+    {
+      label: 'common.more',
+      children: moreMenus,
+    },
+  ]
+
+  const contextMenus = pluginsStore.plugins.filter(
+    (plugin) => Object.keys(plugin.context.profiles).length !== 0,
+  )
+
+  if (contextMenus.length !== 0) {
+    moreMenus.push(
+      {
+        label: '',
+        separator: true,
       },
-    }
-  }),
-  {
-    label: '',
-    separator: true,
-  },
-  {
-    label: 'common.more',
-    children: secondaryMenus,
-  },
-]
+      ...contextMenus.reduce((prev, plugin) => {
+        const menus = Object.entries(plugin.context.profiles)
+        return prev.concat(
+          menus.map(([title, fn]) => {
+            return {
+              label: title,
+              handler: async () => {
+                try {
+                  plugin.running = true
+                  await pluginsStore.manualTrigger(plugin.id, fn as any, profile)
+                } catch (error: any) {
+                  message.error(error)
+                } finally {
+                  plugin.running = false
+                }
+              },
+            }
+          }),
+        )
+      }, [] as Menu[]),
+    )
+  }
+
+  return builtInMenus
+}
 
 const handleAddProfile = async () => {
   isUpdate.value = false
@@ -193,13 +240,7 @@ const onSortUpdate = debounce(profilesStore.saveProfiles, 1000)
       :title="p.name"
       :selected="appSettingsStore.app.kernel.profile === p.id"
       @dblclick="handleUseProfile(p)"
-      v-menu="
-        menus.map((v) => ({
-          ...v,
-          handler: () => v.handler?.(p.id),
-          children: v.children?.map((vv) => ({ ...vv, handler: () => vv.handler?.(p.id) })),
-        }))
-      "
+      v-menu="generateMenus(p)"
       class="item"
     >
       <template #title-prefix>

frontend/src/views/SubscribesView/index.vue

@@ -13,6 +13,7 @@ import {
   useSubscribesStore,
   useAppSettingsStore,
   useKernelApiStore,
+  usePluginsStore,
 } from '@/stores'
 
 import ProxiesView from './components/ProxiesView.vue'
@@ -54,6 +55,52 @@ const { message } = useMessage()
 const subscribeStore = useSubscribesStore()
 const appSettingsStore = useAppSettingsStore()
 const kernelApiStore = useKernelApiStore()
+const pluginsStore = usePluginsStore()
+
+const generateMenus = (subscription: SubscribeType) => {
+  const builtInMenus: Menu[] = menuList.map((v) => ({
+    ...v,
+    handler: () => v.handler?.(subscription.id),
+  }))
+
+  const contextMenus = pluginsStore.plugins.filter(
+    (plugin) => Object.keys(plugin.context.subscriptions).length !== 0,
+  )
+
+  if (contextMenus.length !== 0) {
+    builtInMenus.push(
+      {
+        label: '',
+        separator: true,
+      },
+      {
+        label: 'common.more',
+        children: contextMenus.reduce((prev, plugin) => {
+          const menus = Object.entries(plugin.context.subscriptions)
+          return prev.concat(
+            menus.map(([title, fn]) => {
+              return {
+                label: title,
+                handler: async () => {
+                  try {
+                    plugin.running = true
+                    await pluginsStore.manualTrigger(plugin.id, fn as any, subscription)
+                  } catch (error: any) {
+                    message.error(error)
+                  } finally {
+                    plugin.running = false
+                  }
+                },
+              }
+            }),
+          )
+        }, [] as Menu[]),
+      },
+    )
+  }
+
+  return builtInMenus
+}
 
 const handleAddSub = async () => {
   subFormIsUpdate.value = false
@@ -201,7 +248,7 @@ const onSortUpdate = debounce(subscribeStore.saveSubscribes, 1000)
       :key="s.id"
       :title="s.name"
       :disabled="s.disabled"
-      v-menu="menuList.map((v) => ({ ...v, handler: () => v.handler?.(s.id) }))"
+      v-menu="generateMenus(s)"
       class="item"
     >
       <template #title-prefix>