TRMM/tacticalrmm-web
1
0
Fork 0
mirror of https://github.com/jpros/tacticalrmm-web.git synced 2026-01-19 19:40:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: env vars

Browse Source
This commit is contained in:
wh1te909
2022-12-01 00:44:56 +00:00
parent ba14ed348e
commit 9c033c1c90
12 changed files with 152 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/components/checks/ScriptCheck.vue
View File

@@ -39,6 +39,19 @@
new-value-mode="add"
/>
</q-card-section>
<q-card-section>
<q-select
dense
:label="envVarsLabel"
filled
v-model="state.env_vars"
use-input
use-chips
multiple
hide-dropdown-icon
new-value-mode="add"
/>
</q-card-section>
<q-card-section>
<tactical-dropdown
label="Informational return codes (press Enter after typing each code)"
@@ -115,6 +128,7 @@ import { useDialogPluginComponent } from "quasar";
import { useCheckModal } from "@/composables/checks";
import { useScriptDropdown } from "@/composables/scripts";
import { validateRetcode } from "@/utils/validation";
import { envVarsLabel } from "@/constants/constants"
// ui imports
import TacticalDropdown from "@/components/ui/TacticalDropdown.vue";
@@ -132,7 +146,7 @@ export default {
const { dialogRef, onDialogHide, onDialogOK } = useDialogPluginComponent();
// setup script dropdown
const { script, scriptOptions, defaultTimeout, defaultArgs } =
const { script, scriptOptions, defaultTimeout, defaultArgs, defaultEnvVars } =
useScriptDropdown(props.check ? props.check.script : undefined, {
onMount: true,
});
@@ -145,6 +159,7 @@ export default {
...props.parent,
script,
script_args: defaultArgs,
env_vars: defaultEnvVars,
timeout: defaultTimeout,
check_type: "script",
fails_b4_alert: 1,
@@ -163,6 +178,7 @@ export default {
failOptions,
scriptOptions,
severityOptions,
envVarsLabel,
// methods
submit,

17
src/components/modals/agents/BulkAction.vue
View File

@@ -102,6 +102,18 @@
new-value-mode="add"
/>
</q-card-section>
<q-card-section v-if="mode === 'script'" class="q-pt-none">
<tactical-dropdown
v-model="state.env_vars"
:label="envVarsLabel"
filled
use-input
multiple
hide-dropdown-icon
input-debounce="0"
new-value-mode="add"
/>
</q-card-section>
<q-card-section v-if="mode === 'command'">
<p>Shell</p>
@@ -208,7 +220,7 @@ import { runBulkAction } from "@/api/agents";
import { notifySuccess } from "@/utils/notify";
import { cmdPlaceholder } from "@/composables/agents";
import { removeExtraOptionCategories } from "@/utils/format";
import { runAsUserToolTip } from "@/constants/constants";
import { envVarsLabel, runAsUserToolTip } from "@/constants/constants";
// ui imports
import TacticalDropdown from "@/components/ui/TacticalDropdown.vue";
@@ -284,6 +296,7 @@ export default {
scriptOptions,
defaultTimeout,
defaultArgs,
defaultEnvVars,
getScriptOptions,
} = useScriptDropdown();
const { agents, agentOptions, getAgentOptions } = useAgentDropdown();
@@ -307,6 +320,7 @@ export default {
script,
timeout: defaultTimeout,
args: defaultArgs,
env_vars: defaultEnvVars,
run_as_user: false,
});
const loading = ref(false);
@@ -404,6 +418,7 @@ export default {
targetOptions,
patchModeOptions,
runAsUserToolTip,
envVarsLabel,
//computed
modalTitle,

18
src/components/modals/agents/RunScript.vue
View File

@@ -77,6 +77,18 @@
new-value-mode="add"
/>
</q-card-section>
<q-card-section>
<tactical-dropdown
v-model="state.env_vars"
:label="envVarsLabel"
filled
use-input
multiple
hide-dropdown-icon
input-debounce="0"
new-value-mode="add"
/>
</q-card-section>
<q-card-section>
<q-option-group
v-model="state.output"
@@ -178,7 +190,7 @@ import { useScriptDropdown } from "@/composables/scripts";
import { useCustomFieldDropdown } from "@/composables/core";
import { runScript } from "@/api/agents";
import { notifySuccess } from "@/utils/notify";
import { runAsUserToolTip } from "@/constants/constants";
import { envVarsLabel, runAsUserToolTip } from "@/constants/constants";
import {
formatScriptSyntax,
removeExtraOptionCategories,
@@ -209,7 +221,7 @@ export default {
const { dialogRef, onDialogHide } = useDialogPluginComponent();
// setup dropdowns
const { script, scriptOptions, defaultTimeout, defaultArgs, syntax, link } =
const { script, scriptOptions, defaultTimeout, defaultArgs, defaultEnvVars, syntax, link } =
useScriptDropdown(props.script, {
onMount: true,
filterByPlatform: props.agent.plat,
@@ -225,6 +237,7 @@ export default {
save_all_output: false,
script,
args: defaultArgs,
env_vars: defaultEnvVars,
timeout: defaultTimeout,
run_as_user: false,
});
@@ -281,6 +294,7 @@ export default {
// non-reactive data
outputOptions,
runAsUserToolTip,
envVarsLabel,
//methods
formatScriptSyntax,

32
src/components/modals/alerts/AlertTemplateForm.vue
View File

@@ -204,6 +204,20 @@
new-value-mode="add"
/>
<q-select
class="q-mb-sm"
dense
label="Failure action environment vars (press Enter after typing each key=value pair)"
filled
v-model="template.action_env_vars"
use-input
use-chips
multiple
hide-dropdown-icon
input-debounce="0"
new-value-mode="add"
/>
<q-input
class="q-mb-sm"
label="Failure action timeout (seconds)"
@@ -277,6 +291,20 @@
new-value-mode="add"
/>
<q-select
class="q-mb-sm"
dense
label="Resolved action environment vars (press Enter after typing each key=value pair)"
filled
v-model="template.resolved_action_env_vars"
use-input
use-chips
multiple
hide-dropdown-icon
input-debounce="0"
new-value-mode="add"
/>
<q-input
class="q-mb-sm"
label="Resolved action timeout (seconds)"
@@ -696,9 +724,11 @@ export default {
is_active: true,
action: null,
action_args: [],
action_env_vars: [],
action_timeout: 15,
resolved_action: null,
resolved_action_args: [],
resolved_action_env_vars: [],
resolved_action_timeout: 15,
email_recipients: [],
email_from: "",
@@ -762,11 +792,13 @@ export default {
(i) => i.value === this.template.action
);
this.template.action_args = script.args;
this.template.action_env_vars = script.env_vars;
} else if (type === "resolved") {
const script = this.scriptOptions.find(
(i) => i.value === this.template.resolved_action
);
this.template.resolved_action_args = script.args;
this.template.resolved_action_env_vars = script.env_vars;
}
},
toggleAddEmail() {

16
src/components/scripts/ScriptFormModal.vue
View File

@@ -118,6 +118,17 @@
new-value-mode="add"
:readonly="readonly"
/>
<tactical-dropdown
v-model="formScript.env_vars"
:label="envVarsLabel"
filled
use-input
multiple
hide-dropdown-icon
input-debounce="0"
new-value-mode="add"
:readonly="readonly"
/>
<q-input
type="number"
filled
@@ -137,7 +148,7 @@
'Run As User' checkboxes in the UI and force this script to
always be run in the context of the logged in user. If no user
is logged in, the script will not run and an error will be
returned. Not supported on Windows Server.
returned.
</q-tooltip>
</q-checkbox>
<q-input
@@ -229,6 +240,7 @@ import "ace-builds/src-noconflict/theme-tomorrow";
// static data
import { shellOptions } from "@/composables/scripts";
import { envVarsLabel } from "@/constants/constants";
export default {
name: "ScriptFormModal",
@@ -266,6 +278,7 @@ export default {
args: [],
script_body: "",
run_as_user: false,
env_vars: [],
});
if (props.clone) script.value.name = `(Copy) ${script.value.name}`;
@@ -363,6 +376,7 @@ export default {
// non-reactive data
shellOptions,
agentPlatformOptions,
envVarsLabel,
//computed
title,

14
src/components/scripts/ScriptUploadModal.vue
View File

@@ -93,6 +93,20 @@
/>
</q-card-section>
<q-card-section>
<tactical-dropdown
v-model="script.env_vars"
label="Environment Variables"
placeholder="(press Enter after typing each key=value pair)"
filled
use-input
multiple
hide-dropdown-icon
input-debounce="0"
new-value-mode="add"
/>
</q-card-section>
<q-card-section>
<q-input
label="Default Timeout"

1
src/components/scripts/TestScriptModal.vue
View File

@@ -45,6 +45,7 @@ export default {
args: props.script.args,
shell: props.script.shell,
run_as_user: props.script.run_as_user,
env_vars: props.script.env_vars,
};
try {
ret.value = await testScript(props.agent, data);

29
src/components/tasks/AutomatedTaskForm.vue
View File

@@ -102,7 +102,7 @@
<tactical-dropdown
v-if="actionType === 'script'"
class="col-4"
class="col-3"
label="Select script"
v-model="script"
:options="scriptOptions"
@@ -113,7 +113,7 @@
<q-select
v-if="actionType === 'script'"
class="col-5"
class="col-3"
dense
label="Script Arguments (press Enter after typing each argument)"
filled
@@ -126,6 +126,21 @@
new-value-mode="add"
/>
<q-select
v-if="actionType === 'script'"
class="col-3"
dense
:label="envVarsLabel"
filled
v-model="defaultEnvVars"
use-input
use-chips
multiple
hide-dropdown-icon
input-debounce="0"
new-value-mode="add"
/>
<q-input
v-if="actionType === 'script'"
class="col-2"
@@ -210,6 +225,9 @@
<q-item-label caption>
Arguments: {{ element.script_args }}
</q-item-label>
<q-item-label caption>
Env Vars: {{ element.env_vars }}
</q-item-label>
<q-item-label caption>
Timeout: {{ element.timeout }}
</q-item-label>
@@ -727,6 +745,7 @@ import { useCheckDropdown } from "@/composables/checks";
import { useCustomFieldDropdown } from "@/composables/core";
import { notifySuccess, notifyError } from "@/utils/notify";
import { validateTimePeriod } from "@/utils/validation";
import { envVarsLabel } from "@/constants/constants";
import {
convertPeriodToSeconds,
convertToBitArray,
@@ -817,7 +836,7 @@ export default {
const { dialogRef, onDialogHide, onDialogOK } = useDialogPluginComponent();
// setup dropdowns
const { script, scriptOptions, defaultTimeout, defaultArgs } =
const { script, scriptOptions, defaultTimeout, defaultArgs, defaultEnvVars } =
useScriptDropdown(undefined, {
onMount: true,
});
@@ -914,6 +933,7 @@ export default {
script: script.value,
timeout: defaultTimeout.value,
script_args: defaultArgs.value,
env_vars: defaultEnvVars.value,
});
} else if (actionType.value === "cmd") {
task.value.actions.push({
@@ -927,6 +947,7 @@ export default {
// clear fields after add
script.value = null;
defaultArgs.value = [];
defaultEnvVars.value = [];
defaultTimeout.value = 30;
command.value = "";
}
@@ -1089,6 +1110,7 @@ export default {
script,
defaultTimeout,
defaultArgs,
defaultEnvVars,
actionType,
command,
shell,
@@ -1116,6 +1138,7 @@ export default {
monthOptions,
taskTypeOptions,
taskInstancePolicyOptions,
envVarsLabel,
// methods
submit,

3
src/composables/scripts.js
View File

@@ -8,6 +8,7 @@ export function useScriptDropdown(setScript = null, { onMount = false } = {}) {
const scriptOptions = ref([]);
const defaultTimeout = ref(30);
const defaultArgs = ref([]);
const defaultEnvVars = ref([]);
const script = ref(setScript);
const syntax = ref("");
const link = ref("");
@@ -29,6 +30,7 @@ export function useScriptDropdown(setScript = null, { onMount = false } = {}) {
);
defaultTimeout.value = tmpScript.timeout;
defaultArgs.value = tmpScript.args;
defaultEnvVars.value = tmpScript.env_vars,
syntax.value = tmpScript.syntax;
link.value =
tmpScript.script_type === "builtin"
@@ -49,6 +51,7 @@ export function useScriptDropdown(setScript = null, { onMount = false } = {}) {
scriptOptions,
defaultTimeout,
defaultArgs,
defaultEnvVars,
syntax,
link,

21
src/constants/constants.ts
View File

@@ -1,15 +1,10 @@
const GOARCH_AMD64 = "amd64";
const GOARCH_i386 = "386";
const GOARCH_ARM64 = "arm64";
const GOARCH_ARM32 = "arm";
export const GOARCH_AMD64 = "amd64";
export const GOARCH_i386 = "386";
export const GOARCH_ARM64 = "arm64";
export const GOARCH_ARM32 = "arm";
const runAsUserToolTip =
"Run in the context of the logged in user. If no user is logged in, the script will not run and an error will be returned. Not supported on Windows Server.";
export const runAsUserToolTip =
"Run in the context of the logged in user. If no user is logged in, the script will not run and an error will be returned.";
export {
GOARCH_AMD64,
GOARCH_i386,
GOARCH_ARM64,
GOARCH_ARM32,
runAsUserToolTip,
};
export const envVarsLabel =
"Environment vars (press Enter after typing each key=value pair)"

2
src/mixins/mixins.js
View File

@@ -193,6 +193,7 @@ export default {
value: script.id,
timeout: script.default_timeout,
args: script.args,
env_vars: script.env_vars,
});
} else if (cat === "Unassigned" && !script.category) {
tmp.push({
@@ -200,6 +201,7 @@ export default {
value: script.id,
timeout: script.default_timeout,
args: script.args,
env_vars: script.env_vars,
});
}
});

2
src/utils/format.js
View File

@@ -68,6 +68,7 @@ export function formatScriptOptions(data) {
value: script.id,
timeout: script.default_timeout,
args: script.args,
env_vars: script.env_vars,
filename: script.filename,
syntax: script.syntax,
script_type: script.script_type,
@@ -80,6 +81,7 @@ export function formatScriptOptions(data) {
value: script.id,
timeout: script.default_timeout,
args: script.args,
env_vars: script.env_vars,
filename: script.filename,
syntax: script.syntax,
script_type: script.script_type,