Files
tacticalrmm-web/src/components/scripts/ScriptManager.vue
2022-10-23 08:04:32 +00:00

918 lines
25 KiB
Vue

<template>
<q-dialog ref="dialogRef" @hide="onDialogHide">
<q-card
class="q-dialog-plugin"
id="script-manager-card"
:style="{
width: `${$q.screen.width - 100}px`,
'max-width': `${$q.screen.width - 100}px`,
height: `${$q.screen.height - 100}px`,
'max-height': `${$q.screen.height - 100}px`,
}"
>
<q-bar>
<q-btn
@click="getScripts"
class="q-mr-sm"
dense
flat
push
icon="refresh"
/>Script Manager
<q-space />
<q-btn dense flat icon="close" v-close-popup>
<q-tooltip class="bg-white text-primary">Close</q-tooltip>
</q-btn>
</q-bar>
<div class="row q-pt-xs q-pl-xs">
<q-btn-dropdown icon="add" label="New" no-caps dense flat>
<q-list dense>
<q-item clickable v-close-popup @click="newScriptModal">
<q-item-section side>
<q-icon size="xs" name="add" />
</q-item-section>
<q-item-section>
<q-item-label>New Script</q-item-label>
</q-item-section>
</q-item>
<q-item clickable v-close-popup @click="uploadScriptModal">
<q-item-section side>
<q-icon size="xs" name="cloud_upload" />
</q-item-section>
<q-item-section>
<q-item-label>Upload Script</q-item-label>
</q-item-section>
</q-item>
</q-list>
</q-btn-dropdown>
<q-btn
no-caps
dense
flat
class="q-ml-sm"
label="Script Snippets"
icon="mdi-script"
@click="ScriptSnippetModal"
/>
<q-btn
dense
flat
no-caps
class="q-ml-sm"
:label="tableView ? 'Folder View' : 'Table View'"
:icon="tableView ? 'folder' : 'list'"
@click="tableView = !tableView"
/>
<q-btn
dense
flat
no-caps
class="q-ml-sm"
:label="
showCommunityScripts
? 'Hide Community Scripts'
: 'Show Community Scripts'
"
:icon="showCommunityScripts ? 'visibility_off' : 'visibility'"
@click="setShowCommunityScripts(!showCommunityScripts)"
/>
<q-btn
dense
flat
no-caps
class="q-ml-sm"
:label="
showHiddenScripts ? 'Hide Hidden Scripts' : 'Show Hidden Scripts'
"
:icon="showHiddenScripts ? 'visibility_off' : 'visibility'"
@click="showHiddenScripts = !showHiddenScripts"
/>
<q-space />
<q-input
v-model="search"
style="width: 300px"
label="Search"
dense
outlined
clearable
class="q-pr-md q-pb-xs"
>
<template v-slot:prepend>
<q-icon name="search" color="primary" />
</template>
</q-input>
</div>
<!-- List View -->
<div
v-if="!tableView"
class="scroll q-pl-xs"
:style="{
'max-height': `${$q.screen.height - 182}px`,
'min-height': `${$q.screen.height - 382}px`,
}"
>
<q-tree
ref="folderTree"
:nodes="tree"
:filter="search"
no-connectors
node-key="id"
v-model:expanded="expanded"
no-results-label="No Scripts Found"
no-nodes-label="No Scripts Found"
>
<template v-slot:header-script="props">
<div
class="cursor-pointer"
@dblclick="
props.node.script_type === 'builtin'
? viewCodeModal(props.node)
: editScriptModal(props.node)
"
>
<q-icon
v-if="props.node.favorite"
color="yellow-8"
name="star"
size="sm"
class="q-px-sm"
/>
<q-icon
v-else
color="yellow-8"
name="star_outline"
size="sm"
class="q-px-sm"
/>
<q-icon
v-if="props.node.shell === 'powershell'"
name="mdi-powershell"
color="primary"
>
<q-tooltip> Powershell </q-tooltip>
</q-icon>
<q-icon
v-else-if="props.node.shell === 'python'"
name="mdi-language-python"
color="primary"
>
<q-tooltip> Python </q-tooltip>
</q-icon>
<q-icon
v-else-if="props.node.shell === 'cmd'"
name="mdi-microsoft-windows"
color="primary"
>
<q-tooltip> Batch </q-tooltip>
</q-icon>
<q-icon
v-else-if="props.node.shell === 'shell'"
name="mdi-bash"
color="primary"
>
<q-tooltip> Shell </q-tooltip>
</q-icon>
<span
class="q-pl-xs text-weight-bold"
:style="{ color: props.node.hidden ? 'grey' : '' }"
>{{ props.node.name }}</span
>
<span class="q-pl-xs">{{ props.node.description }}</span>
</div>
<!-- context menu -->
<q-menu context-menu>
<q-list dense style="min-width: 200px">
<q-item
clickable
v-close-popup
@click="viewCodeModal(props.node)"
>
<q-item-section side>
<q-icon name="remove_red_eye" />
</q-item-section>
<q-item-section>View Code</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="cloneScriptModal(props.node)"
>
<q-item-section side>
<q-icon name="content_copy" />
</q-item-section>
<q-item-section>Clone</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="editScriptModal(props.node)"
:disable="props.node.script_type === 'builtin'"
>
<q-item-section side>
<q-icon name="edit" />
</q-item-section>
<q-item-section>Edit</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="deleteScript(props.node)"
:disable="props.node.script_type === 'builtin'"
>
<q-item-section side>
<q-icon name="delete" />
</q-item-section>
<q-item-section>Delete</q-item-section>
</q-item>
<q-separator></q-separator>
<q-item
clickable
v-close-popup
@click="favoriteScript(props.node)"
>
<q-item-section side>
<q-icon name="star" />
</q-item-section>
<q-item-section>{{
props.node.favorite
? "Remove as Favorite"
: "Add as Favorite"
}}</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="exportScript(props.node)"
>
<q-item-section side>
<q-icon name="cloud_download" />
</q-item-section>
<q-item-section>Download Script</q-item-section>
</q-item>
<q-separator />
<q-item clickable v-close-popup @click="hideScript(props.node)">
<q-item-section side>
<q-icon
:name="
props.node.hidden ? 'visibility' : 'visibility_off'
"
/>
</q-item-section>
<q-item-section>{{
props.node.hidden ? "Show Script" : "Hide Script"
}}</q-item-section>
</q-item>
<q-separator></q-separator>
<q-item clickable v-close-popup>
<q-item-section>Close</q-item-section>
</q-item>
</q-list>
</q-menu>
</template>
</q-tree>
</div>
<q-table
v-if="tableView"
dense
:table-class="{
'table-bgcolor': !$q.dark.isActive,
'table-bgcolor-dark': $q.dark.isActive,
}"
:style="{ 'max-height': `${$q.screen.height - 182}px` }"
class="tbl-sticky"
:rows="visibleScripts"
:columns="columns"
:loading="loading"
:pagination="{ rowsPerPage: 0, sortBy: 'favorite', descending: true }"
:filter="search"
row-key="id"
binary-state-sort
virtual-scroll
:rows-per-page-options="[0]"
>
<template v-slot:header-cell-favorite="props">
<q-th :props="props" auto-width>
<q-icon name="star" color="yellow-8" size="sm" />
</q-th>
</template>
<template v-slot:header-cell-shell="props">
<q-th :props="props" auto-width> Shell </q-th>
</template>
<template v-slot:no-data> No Scripts Found </template>
<template v-slot:body="props">
<!-- Table View -->
<q-tr
:props="props"
@dblclick="
props.row.script_type === 'builtin'
? viewCodeModal(props.row)
: editScriptModal(props.row)
"
class="cursor-pointer"
>
<!-- Context Menu -->
<q-menu context-menu>
<q-list dense style="min-width: 200px">
<q-item
clickable
v-close-popup
@click="viewCodeModal(props.row)"
>
<q-item-section side>
<q-icon name="remove_red_eye" />
</q-item-section>
<q-item-section>View Code</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="cloneScriptModal(props.row)"
>
<q-item-section side>
<q-icon name="content_copy" />
</q-item-section>
<q-item-section>Clone</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="editScriptModal(props.row)"
:disable="props.row.script_type === 'builtin'"
>
<q-item-section side>
<q-icon name="edit" />
</q-item-section>
<q-item-section>Edit</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="deleteScript(props.row)"
:disable="props.row.script_type === 'builtin'"
>
<q-item-section side>
<q-icon name="delete" />
</q-item-section>
<q-item-section>Delete</q-item-section>
</q-item>
<q-separator></q-separator>
<q-item
clickable
v-close-popup
@click="favoriteScript(props.row)"
>
<q-item-section side>
<q-icon name="star" />
</q-item-section>
<q-item-section>{{
props.row.favorite
? "Remove as Favorite"
: "Add as Favorite"
}}</q-item-section>
</q-item>
<q-item
clickable
v-close-popup
@click="exportScript(props.row)"
>
<q-item-section side>
<q-icon name="cloud_download" />
</q-item-section>
<q-item-section>Download Script</q-item-section>
</q-item>
<q-separator />
<q-item clickable v-close-popup @click="hideScript(props.row)">
<q-item-section side>
<q-icon
:name="props.row.hidden ? 'visibility' : 'visibility_off'"
/>
</q-item-section>
<q-item-section>{{
props.row.hidden ? "Show Script" : "Hide Script"
}}</q-item-section>
</q-item>
<q-separator></q-separator>
<q-item clickable v-close-popup>
<q-item-section>Close</q-item-section>
</q-item>
</q-list>
</q-menu>
<!-- favorite -->
<q-td>
<q-icon
v-if="props.row.favorite"
color="yellow-8"
name="star"
size="sm"
/>
</q-td>
<!-- shell icon -->
<q-td>
<q-icon
v-if="props.row.shell === 'powershell'"
name="mdi-powershell"
color="primary"
size="sm"
>
<q-tooltip> Powershell </q-tooltip>
</q-icon>
<q-icon
v-else-if="props.row.shell === 'python'"
name="mdi-language-python"
color="primary"
size="sm"
>
<q-tooltip> Python </q-tooltip>
</q-icon>
<q-icon
v-else-if="props.row.shell === 'cmd'"
name="mdi-microsoft-windows"
color="primary"
size="sm"
>
<q-tooltip> Batch </q-tooltip>
</q-icon>
<q-icon
v-else-if="props.row.shell === 'shell'"
size="sm"
name="mdi-bash"
color="primary"
>
<q-tooltip> Shell </q-tooltip>
</q-icon>
</q-td>
<!-- supported platforms -->
<q-td>
<q-badge
v-if="
!props.row.supported_platforms ||
props.row.supported_platforms.length === 0
"
>All</q-badge
>
<q-badge
v-else
v-for="plat in props.row.supported_platforms"
:key="plat"
color="primary"
class="q-pr-xs"
>{{ capitalize(plat) }}</q-badge
>
</q-td>
<!-- name -->
<q-td :style="{ color: props.row.hidden ? 'grey' : '' }">
{{ truncateText(props.row.name, 50) }}
<q-tooltip
v-if="props.row.name.length >= 50"
style="font-size: 12px"
>
{{ props.row.name }}
</q-tooltip>
</q-td>
<!-- args -->
<q-td>
<span v-if="props.row.args.length > 0">
{{ truncateText(props.row.args.toString(), 30) }}
<q-tooltip
v-if="props.row.args.toString().length >= 30"
style="font-size: 12px"
>
{{ props.row.args }}
</q-tooltip>
</span>
</q-td>
<q-td>{{ props.row.category }}</q-td>
<q-td>
{{ truncateText(props.row.description, 30) }}
<q-tooltip
v-if="props.row.description.length >= 30"
style="font-size: 12px"
>{{ props.row.description }}</q-tooltip
>
</q-td>
<q-td>{{ props.row.default_timeout }}</q-td>
</q-tr>
</template>
</q-table>
</q-card>
</q-dialog>
</template>
<script>
// composition imports
import { ref, computed, watch, onMounted } from "vue";
import { useStore } from "vuex";
import { useQuasar, useDialogPluginComponent, exportFile } from "quasar";
import {
fetchScripts,
editScript,
downloadScript,
removeScript,
} from "@/api/scripts";
import { capitalize } from "@/utils/format";
import { truncateText } from "@/utils/format";
import { notifySuccess } from "@/utils/notify";
// ui imports
import ScriptUploadModal from "@/components/scripts/ScriptUploadModal.vue";
import ScriptFormModal from "@/components/scripts/ScriptFormModal.vue";
import ScriptSnippets from "@/components/scripts/ScriptSnippets.vue";
// static data
const columns = [
{
name: "favorite",
label: "",
field: "favorite",
align: "left",
sortable: true,
},
{
name: "shell",
label: "Shell",
field: "shell",
align: "left",
sortable: true,
},
{
name: "supported_platforms",
label: "Platforms",
field: "supported_platforms",
align: "left",
sortable: true,
},
{
name: "name",
label: "Name",
field: "name",
align: "left",
sortable: true,
},
{
name: "args",
label: "Default Args",
field: "args",
align: "left",
sortable: true,
},
{
name: "category",
label: "Category",
field: "category",
align: "left",
sortable: true,
},
{
name: "desc",
label: "Description",
field: "description",
align: "left",
sortable: false,
},
{
name: "default_timeout",
label: "Default Timeout (seconds)",
field: "default_timeout",
align: "left",
sortable: true,
},
];
export default {
name: "ScriptManager",
emits: [...useDialogPluginComponent.emits],
setup() {
// setup vuex store
const store = useStore();
const showCommunityScripts = computed(
() => store.state.showCommunityScripts
);
// setup quasar plugins
const { dialogRef, onDialogHide } = useDialogPluginComponent();
const $q = useQuasar();
// script manager logic
const scripts = ref([]);
const showHiddenScripts = ref(false);
async function getScripts() {
loading.value = true;
try {
scripts.value = await fetchScripts({ showHiddenScripts: true });
} catch (e) {
console.error(e);
}
loading.value = false;
}
async function favoriteScript(script) {
loading.value = true;
const notifyText = !script.favorite
? "Script was favorited!"
: "Script was removed as a favorite!";
try {
await editScript({
id: script.id,
favorite: !script.favorite,
});
await getScripts();
notifySuccess(notifyText);
} catch (e) {}
loading.value = false;
}
async function hideScript(script) {
loading.value = true;
const notifyText = !script.hidden
? "Script was hidden!"
: "Script was unhidden!";
try {
await editScript({
id: script.id,
hidden: !script.hidden,
});
await getScripts();
notifySuccess(notifyText);
} catch (e) {}
loading.value = false;
}
function deleteScript(script) {
$q.dialog({
title: `Delete script: ${script.name}?`,
cancel: true,
ok: { label: "Delete", color: "negative" },
}).onOk(async () => {
loading.value = true;
try {
const data = await removeScript(script.id);
notifySuccess(data);
getScripts();
} catch (e) {}
loading.value = false;
});
}
async function exportScript(script) {
loading.value = true;
try {
const { code, filename } = await downloadScript(script.id);
exportFile(filename, new Blob([code]), {
mimeType: "text/plain;charset=utf-8",
});
} catch (e) {
console.error(e);
}
loading.value = false;
}
// table and tree view setup
const search = ref("");
const tableView = ref(true);
const expanded = ref([]);
const loading = ref(false);
const visibleScripts = computed(() => {
if (showHiddenScripts.value) {
return showCommunityScripts.value
? scripts.value
: scripts.value.filter((i) => i.script_type !== "builtin");
} else {
return showCommunityScripts.value
? scripts.value.filter((i) => !i.hidden)
: scripts.value.filter(
(i) => i.script_type !== "builtin" && !i.hidden
);
}
});
const categories = computed(() => {
let list = [];
visibleScripts.value.forEach((script) => {
if (!!script.category && !list.includes(script.category)) {
list.push(script.category);
}
});
return list;
});
const tree = computed(() => {
if (tableView.value || visibleScripts.value.length === 0) {
return [];
} else {
let nodes = [];
// copy scripts and categories to new array
let scriptsTemp = Object.assign([], visibleScripts.value);
let categoriesTemp = Object.assign([], categories.value);
// add Unassigned category
categoriesTemp.push("Unassigned");
const sortedCategories = categoriesTemp.sort();
// sort by name property
const sortedScripts = scriptsTemp.sort(function (a, b) {
const nameA = a.name.toUpperCase();
const nameB = b.name.toUpperCase();
if (nameA < nameB) {
return -1;
}
if (nameA > nameB) {
return 1;
}
// names must be equal
return 0;
});
sortedCategories.forEach((category) => {
let temp = {
icon: "folder",
iconColor: "yellow-9",
label: category,
selectable: false,
id: category,
children: [],
};
for (let x = 0; x < sortedScripts.length; x++) {
if (sortedScripts[x].category === category) {
temp.children.push({
label: sortedScripts[x].name,
header: "script",
...sortedScripts[x],
});
} else if (
category === "Unassigned" &&
!sortedScripts[x].category
) {
temp.children.push({
label: sortedScripts[x].name,
header: "script",
...sortedScripts[x],
});
}
}
nodes.push(temp);
});
return nodes;
}
});
watch(tableView, () => {
expanded.value = [];
});
// dialog open functions
function viewCodeModal(script) {
$q.dialog({
component: ScriptFormModal,
componentProps: {
script: script,
readonly: true,
},
});
}
function newScriptModal() {
$q.dialog({
component: ScriptFormModal,
componentProps: {
categories: categories.value,
readonly: false,
},
}).onOk(() => {
getScripts();
});
}
function editScriptModal(script) {
$q.dialog({
component: ScriptFormModal,
componentProps: {
script: script,
categories: categories.value,
readonly: false,
},
}).onOk(() => {
getScripts();
});
}
function cloneScriptModal(script) {
$q.dialog({
component: ScriptFormModal,
componentProps: {
script: script,
categories: categories.value,
readonly: false,
clone: true,
},
}).onOk(() => {
getScripts();
});
}
function uploadScriptModal() {
$q.dialog({
component: ScriptUploadModal,
componentProps: {
categories: categories.value,
},
}).onOk(() => {
getScripts();
});
}
function ScriptSnippetModal() {
$q.dialog({
component: ScriptSnippets,
});
}
// component life cycle hooks
onMounted(getScripts);
return {
// reactive data
search,
tableView,
expanded,
loading,
showCommunityScripts,
showHiddenScripts,
// computed
visibleScripts,
// non-reactive data
columns,
// api methods
getScripts,
deleteScript,
favoriteScript,
hideScript,
exportScript,
// dialog methods
viewCodeModal,
newScriptModal,
editScriptModal,
cloneScriptModal,
uploadScriptModal,
ScriptSnippetModal,
// table and tree view methods
tree,
setShowCommunityScripts: (show) =>
store.dispatch("setShowCommunityScripts", show),
// helper methods
truncateText,
capitalize,
// quasar dialog plugin
dialogRef,
onDialogHide,
};
},
};
</script>