mirror/api
1
0
Fork 0
mirror of https://github.com/unraid/api.git synced 2026-04-26 09:18:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

refactor: callback progress

Browse Source
This commit is contained in:
Zack Spear
2023-06-05 19:11:01 -07:00
committed by Zack Spear
parent e884b051f4
commit 17ca9adc79
18 changed files with 476 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files
store/account.ts
+66
View File
@@ -0,0 +1,66 @@
import { useToggle } from '@vueuse/core';
import { defineStore, createPinia, setActivePinia } from "pinia";
import { useCallbackStore } from './callback';
import { useServerStore } from './server';
/**
* @see https://stackoverflow.com/questions/73476371/using-pinia-with-vue-js-web-components
* @see https://github.com/vuejs/pinia/discussions/1085
*/
setActivePinia(createPinia());
export const useAccountStore = defineStore('account', () => {
const callbackStore = useCallbackStore();
const serverStore = useServerStore();
// State
const accountVisible = ref<boolean>(false);
// Actions
const recover = () => {
console.debug('[recover]');
callbackStore.send('https://account.unraid.net', {
...serverStore.serverAccountPayload,
type: 'recover',
});
};
const replace = () => {
console.debug('[replace]');
callbackStore.send('https://account.unraid.net', {
...serverStore.serverAccountPayload,
type: 'replace',
});
};
const signIn = () => {
console.debug('[signIn]');
callbackStore.send('https://account.unraid.net', {
...serverStore.serverAccountPayload,
type: 'signIn',
});
};
const signOut = () => {
console.debug('[signOut]');
callbackStore.send('https://account.unraid.net', {
...serverStore.serverAccountPayload,
type: 'signOut',
});
};
const accountHide = () => accountVisible.value = false;
const accountShow = () => accountVisible.value = true;
const accountToggle = useToggle(accountVisible);
watch(accountVisible, (newVal, _oldVal) => {
console.debug('[accountVisible]', newVal, _oldVal);
});
return {
// State
accountVisible,
accountHide,
accountShow,
// Actions
recover,
replace,
signIn,
signOut,
accountToggle,
};
});
store/callback.ts
+35 -11
View File
@@ -1,7 +1,11 @@
import AES from 'crypto-js/aes';
import Utf8 from 'crypto-js/enc-utf8';
import { defineStore, createPinia, setActivePinia } from "pinia";
import { useServerStore } from './server';
import type { CallbackSendPayload } from '~/types/callback';
import type {
ServerAccountCallbackSendPayload,
ServerPurchaseCallbackSendPayload,
} from '~/types/server';
/**
* @see https://stackoverflow.com/questions/73476371/using-pinia-with-vue-js-web-components
* @see https://github.com/vuejs/pinia/discussions/1085
@@ -9,22 +13,19 @@ import { useServerStore } from './server';
setActivePinia(createPinia());
export const useCallbackStore = defineStore('callback', () => {
const serverStore = useServerStore();
// store helpers
// const config = useRuntimeConfig(); // results in a nuxt error after web components are built
// const encryptKey = config.public.callbackKey;
const encryptKey = 'Uyv2o8e*FiQe8VeLekTqyX6Z*8XonB';
console.debug('[useCallbackStore]', { encryptKey });
// state
const encryptedMessage = ref('');
const callbackFeedbackVisible = ref<boolean>(false);
const decryptedData = ref();
// getters
const encryptedMessage = ref('');
// actions
const send = (url: string = 'https://unraid.ddev.site/init-purchase') => {
const send = (url: string = 'https://unraid.ddev.site/init-purchase', payload: CallbackSendPayload) => {
console.debug('[send]');
const stringifiedData = JSON.stringify({
...serverStore.server,
...payload,
sender: window.location.href,
});
// @todo don't save to store
@@ -42,14 +43,16 @@ export const useCallbackStore = defineStore('callback', () => {
console.debug('[watcher]', currentUrl);
const callbackValue = currentUrl.searchParams.get('data');
if (!callbackValue) {
console.debug('[watcher] no callback to handle');
return;
return console.debug('[watcher] no callback to handle');
}
const decryptedMessage = AES.decrypt(callbackValue, encryptKey);
decryptedData.value = JSON.parse(decryptedMessage.toString(Utf8));
console.debug('[watcher]', decryptedMessage, decryptedData.value);
if (!decryptedData.value) return console.error('Callback Watcher: Data not present');
if (!decryptedData.value.action) return console.error('Callback Watcher: Required "action" not present');
// Display the feedback modal
show();
// Parse the data and perform actions
switch (decryptedData.value.action) {
case 'install':
console.debug(`Installing key ${decryptedData.value.keyUrl}\n\nOEM: ${decryptedData.value.oem}\n\nSender: ${decryptedData.value.sender}`);
@@ -63,5 +66,26 @@ export const useCallbackStore = defineStore('callback', () => {
}
};
return { send, watcher, decryptedData };
const hide = () => callbackFeedbackVisible.value = false;
const show = () => callbackFeedbackVisible.value = true;
const toggle = useToggle(callbackFeedbackVisible);
/**
* @todo consider removing query string once actions are done
*/
watch(callbackFeedbackVisible, (newVal, _oldVal) => {
console.debug('[callbackFeedbackVisible]', newVal, _oldVal);
});
return {
// state
decryptedData,
callbackFeedbackVisible,
// actions
send,
watcher,
hide,
show,
toggle,
};
});
store/purchase.ts
+58
View File
@@ -0,0 +1,58 @@
import { useToggle } from '@vueuse/core';
import { defineStore, createPinia, setActivePinia } from "pinia";
import { useCallbackStore } from './callback';
import { useServerStore } from './server';
/**
* @see https://stackoverflow.com/questions/73476371/using-pinia-with-vue-js-web-components
* @see https://github.com/vuejs/pinia/discussions/1085
*/
setActivePinia(createPinia());
export const usePurchaseStore = defineStore('purchase', () => {
const callbackStore = useCallbackStore();
const serverStore = useServerStore();
// State
const purchaseVisible = ref<boolean>(false);
// Actions
const redeem = () => {
console.debug('[redeem]');
callbackStore.send('https://unraid.ddev.site/init-purchase', {
...serverStore.serverPurchasePayload,
type: 'redeem',
});
};
const purchase = () => {
console.debug('[purchase]');
callbackStore.send('https://unraid.ddev.site/init-purchase', {
...serverStore.serverPurchasePayload,
type: 'purchase',
});
};
const upgrade = () => {
console.debug('[upgrade]');
callbackStore.send('https://unraid.ddev.site/init-purchase', {
...serverStore.serverPurchasePayload,
type: 'upgrade',
});
};
const purchaseHide = () => purchaseVisible.value = false;
const purchaseShow = () => purchaseVisible.value = true;
const purchaseToggle = useToggle(purchaseVisible);
watch(purchaseVisible, (newVal, _oldVal) => {
console.debug('[purchaseVisible]', newVal, _oldVal);
});
return {
// State
purchaseVisible,
purchaseHide,
purchaseShow,
// Actions
purchaseToggle,
redeem,
purchase,
upgrade,
};
});
store/server.ts
+78 -33
View File
@@ -1,7 +1,13 @@
import { defineStore, createPinia, setActivePinia } from "pinia";
import { ArrowRightOnRectangleIcon, GlobeAltIcon, KeyIcon } from '@heroicons/vue/24/solid';
import { useAccountStore } from './account';
import { usePurchaseStore } from "./purchase";
import { useTrialStore } from './trial';
import type {
Server,
ServerAccountCallbackSendPayload,
ServerPurchaseCallbackSendPayload,
ServerState,
ServerStateData,
ServerStateDataAction,
@@ -13,6 +19,9 @@ import type {
setActivePinia(createPinia());
export const useServerStore = defineStore('server', () => {
const accountStore = useAccountStore();
const purchaseStore = usePurchaseStore();
const trialStore = useTrialStore();
/**
* State
*/
@@ -80,64 +89,85 @@ export const useServerStore = defineStore('server', () => {
}
});
const serverPurchasePayload = computed((): ServerPurchaseCallbackSendPayload => {
return {
deviceCount: deviceCount.value,
guid: guid.value,
}
});
const serverAccountPayload = computed((): ServerAccountCallbackSendPayload => {
return {
description: description.value,
expireTime: expireTime.value,
flashProduct: flashProduct.value,
flashVendor: flashVendor.value,
guid: guid.value,
keyfile: keyfile.value,
name: name.value,
state: state.value,
wanFQDN: wanFQDN.value,
}
});
const purchaseAction: ServerStateDataAction = {
click: () => { console.debug('purchase') },
click: () => { purchaseStore.purchase() },
external: true,
icon: KeyIcon,
name: 'purchase',
text: 'Purchase Key',
};
const upgradeAction: ServerStateDataAction = {
click: () => { console.debug('upgrade') },
click: () => { purchaseStore.upgrade() },
external: true,
icon: KeyIcon,
name: 'upgrade',
text: 'Upgrade Key',
};
const recoverAction: ServerStateDataAction = {
click: () => { console.debug('recover') },
click: () => { accountStore.recover() },
external: true,
icon: KeyIcon,
name: 'recover',
text: 'Recover Key',
};
const redeemAction: ServerStateDataAction = {
click: () => { console.debug('redeem') },
click: () => { purchaseStore.redeem() },
external: true,
icon: KeyIcon,
name: 'redeem',
text: 'Redeem Activation Code',
};
const replaceAction: ServerStateDataAction = {
click: () => { console.debug('replace') },
click: () => { accountStore.replace() },
external: true,
icon: KeyIcon,
name: 'replace',
text: 'Replace Key',
};
const signInAction: ServerStateDataAction = {
click: () => { console.debug('signIn') },
click: () => { accountStore.signIn() },
external: true,
icon: GlobeAltIcon,
name: 'signIn',
text: 'Sign In with Unraid.net Account',
};
const signOutAction: ServerStateDataAction = {
click: () => { console.debug('signOut') },
click: () => { accountStore.signOut() },
external: true,
icon: ArrowRightOnRectangleIcon,
name: 'signOut',
text: 'Sign Out of Unraid.net',
};
const trialExtendAction: ServerStateDataAction = {
click: () => { console.debug('trialExtend') },
click: () => { trialStore.extend() },
external: true,
icon: ArrowRightOnRectangleIcon,
name: 'trialExtend',
text: 'Extend Trial',
};
const trialStartAction: ServerStateDataAction = {
click: () => { console.debug('trialStart') },
click: () => { trialStore.start() },
external: true,
icon: ArrowRightOnRectangleIcon,
name: 'trialStart',
@@ -176,6 +206,7 @@ export const useServerStore = defineStore('server', () => {
...(trialExtensionEligible.value ? [trialExtendAction] : []),
...(registered.value ? [signOutAction] : []),
],
error: true,
humanReadable: 'Trial Expired',
heading: 'Your Trial has expired',
message: trialExtensionEligible.value
@@ -236,6 +267,7 @@ export const useServerStore = defineStore('server', () => {
...([purchaseAction, redeemAction, replaceAction]),
...(registered.value ? [signOutAction] : []),
],
error: true,
humanReadable: 'Flash GUID Error',
heading: 'Registration key / USB Flash GUID mismatch',
message: messageEGUID,
@@ -247,10 +279,11 @@ export const useServerStore = defineStore('server', () => {
...(registered.value ? [purchaseAction, redeemAction] : []),
...(registered.value ? [signOutAction] : []),
],
error: true,
humanReadable: 'Multiple License Keys Present',
heading: 'Multiple License Keys Present',
message: 'There are multiple license key files present on your USB flash device and none of them correspond to the USB Flash boot device. Please remove all key files, except the one you want to replace, from the /config directory on your USB Flash boot device. Alternately you may purchase a license key for this USB flash device. If you want to replace one of your license keys with a new key bound to this USB Flash device, please first remove all other key files first.',
// signInToFix: true, // @todo
// signInToFix: true, // @todo is this needed?
};
case 'ENOKEYFILE2':
return {
@@ -259,6 +292,7 @@ export const useServerStore = defineStore('server', () => {
...([purchaseAction, redeemAction]),
...(registered.value ? [recoverAction, signOutAction] : []),
],
error: true,
humanReadable: 'Missing key file',
heading: 'Missing key file',
message: 'It appears that your license key file is corrupted or missing. The key file should be located in the /config directory on your USB Flash boot device. If you do not have a backup copy of your license key file you may install the Connect (beta) plugin to attempt to recover your key. If this was an expired Trial installation, you may purchase a license key.',
@@ -270,6 +304,7 @@ export const useServerStore = defineStore('server', () => {
...([purchaseAction, redeemAction]),
...(registered.value ? [signOutAction] : []),
],
error: true,
humanReadable: 'Invalid installation',
heading: 'Invalid installation',
message: 'It is not possible to use a Trial key with an existing Unraid OS installation. You may purchase a license key corresponding to this USB Flash device to continue using this installation.',
@@ -281,6 +316,7 @@ export const useServerStore = defineStore('server', () => {
...([purchaseAction, redeemAction]),
...(registered.value ? [signOutAction] : []),
],
error: true,
humanReadable: 'No Keyfile',
heading: 'No USB flash configuration data',
message: 'There is a problem with your USB Flash device',
@@ -294,36 +330,42 @@ export const useServerStore = defineStore('server', () => {
case 'ENOFLASH6':
case 'ENOFLASH7':
return {
error: true,
humanReadable: 'No Flash',
heading: 'Cannot access your USB Flash boot device',
message: 'There is a physical problem accessing your USB Flash boot device',
};
case 'EBLACKLISTED':
return {
error: true,
humanReadable: 'BLACKLISTED',
heading: 'Blacklisted USB Flash GUID',
message: 'This USB Flash boot device has been blacklisted. This can occur as a result of transferring your license key to a replacement USB Flash device, and you are currently booted from your old USB Flash device. A USB Flash device may also be blacklisted if we discover the serial number is not unique – this is common with USB card readers.',
};
case 'EBLACKLISTED1':
return {
error: true,
humanReadable: 'BLACKLISTED',
heading: 'USB Flash device error',
message: 'This USB Flash device has an invalid GUID. Please try a different USB Flash device',
};
case 'EBLACKLISTED2':
return {
error: true,
humanReadable: 'BLACKLISTED',
heading: 'USB Flash has no serial number',
message: 'This USB Flash boot device has been blacklisted. This can occur as a result of transferring your license key to a replacement USB Flash device, and you are currently booted from your old USB Flash device. A USB Flash device may also be blacklisted if we discover the serial number is not unique – this is common with USB card readers.',
};
case 'ENOCONN':
return {
error: true,
humanReadable: 'Trial Requires Internet Connection',
heading: 'Cannot validate Unraid Trial key',
message: 'Your Trial key requires an internet connection. Please check Settings > Network',
};
default:
return {
error: true,
humanReadable: 'Stale',
heading: 'Stale Server',
message: 'Please refresh the page to ensure you load your latest configuration',
@@ -347,29 +389,30 @@ export const useServerStore = defineStore('server', () => {
* Actions
*/
const setServer = (data: Server) => {
console.debug('[setServer]', data);
if (data?.apiKey) apiKey.value = data.apiKey;
if (data?.avatar) avatar.value = data.avatar;
if (data?.description) description.value = data.description;
if (data?.deviceCount) deviceCount.value = data.deviceCount;
if (data?.expireTime) expireTime.value = data.expireTime;
if (data?.flashProduct) flashProduct.value = data.flashProduct;
if (data?.flashVendor) flashVendor.value = data.flashVendor;
if (data?.guid) guid.value = data.guid;
if (data?.keyfile) keyfile.value = data.keyfile;
if (data?.lanIp) lanIp.value = data.lanIp;
if (data?.license) license.value = data.license;
if (data?.locale) locale.value = data.locale;
if (data?.name) name.value = data.name;
if (data?.pluginInstalled) pluginInstalled.value = data.pluginInstalled;
if (data?.registered) registered.value = data.registered;
if (data?.regGen) regGen.value = data.regGen;
if (data?.regGuid) regGuid.value = data.regGuid;
if (data?.site) site.value = data.site;
if (data?.state) state.value = data.state;
if (data?.uptime) uptime.value = data.uptime;
if (data?.username) username.value = data.username;
if (data?.wanFQDN) wanFQDN.value = data.wanFQDN;
console.debug('[setServer] data', data);
if (typeof data?.apiKey !== 'undefined') apiKey.value = data.apiKey;
if (typeof data?.avatar !== 'undefined') avatar.value = data.avatar;
if (typeof data?.description !== 'undefined') description.value = data.description;
if (typeof data?.deviceCount !== 'undefined') deviceCount.value = data.deviceCount;
if (typeof data?.expireTime !== 'undefined') expireTime.value = data.expireTime;
if (typeof data?.flashProduct !== 'undefined') flashProduct.value = data.flashProduct;
if (typeof data?.flashVendor !== 'undefined') flashVendor.value = data.flashVendor;
if (typeof data?.guid !== 'undefined') guid.value = data.guid;
if (typeof data?.keyfile !== 'undefined') keyfile.value = data.keyfile;
if (typeof data?.lanIp !== 'undefined') lanIp.value = data.lanIp;
if (typeof data?.license !== 'undefined') license.value = data.license;
if (typeof data?.locale !== 'undefined') locale.value = data.locale;
if (typeof data?.name !== 'undefined') name.value = data.name;
if (typeof data?.pluginInstalled !== 'undefined') pluginInstalled.value = data.pluginInstalled;
if (typeof data?.registered !== 'undefined') registered.value = data.registered;
if (typeof data?.regGen !== 'undefined') regGen.value = data.regGen;
if (typeof data?.regGuid !== 'undefined') regGuid.value = data.regGuid;
if (typeof data?.site !== 'undefined') site.value = data.site;
if (typeof data?.state !== 'undefined') state.value = data.state;
if (typeof data?.uptime !== 'undefined') uptime.value = data.uptime;
if (typeof data?.username !== 'undefined') username.value = data.username;
if (typeof data?.wanFQDN !== 'undefined') wanFQDN.value = data.wanFQDN;
console.debug('[setServer] server.value', server.value);
};
return {
@@ -397,6 +440,8 @@ export const useServerStore = defineStore('server', () => {
keyActions,
pluginOutdated,
server,
serverAccountPayload,
serverPurchasePayload,
stateData,
// actions
setServer,
store/trial.ts
+37
View File
@@ -0,0 +1,37 @@
import { useToggle } from '@vueuse/core';
import { defineStore, createPinia, setActivePinia } from "pinia";
import { useCallbackStore } from './callback';
import { useServerStore } from './server';
/**
* @see https://stackoverflow.com/questions/73476371/using-pinia-with-vue-js-web-components
* @see https://github.com/vuejs/pinia/discussions/1085
*/
setActivePinia(createPinia());
export const useTrialStore = defineStore('trial', () => {
const callbackStore = useCallbackStore();
const serverStore = useServerStore();
const extend = () => {
console.debug('[extend]');
callbackStore.send('https://account.unraid.net', {
...serverStore.serverAccountPayload,
type: 'trialExtend',
});
};
const start = () => {
console.debug('[start]');
callbackStore.send('https://account.unraid.net', {
...serverStore.serverAccountPayload,
type: 'trialStart',
});
};
return {
// State
// Actions
extend,
start,
};
});