Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

File Save RPC #805

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions gui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"identity-obj-proxy": "^3.0.0",
"intl-pluralrules": "^1.3.1",
"ip-num": "^1.4.1",
"mime-types": "^2.1.35",
"postcss-flexbugs-fixes": "^5.0.2",
"postcss-normalize": "^10.0.1",
"postcss-preset-env": "^7.0.1",
Expand Down Expand Up @@ -68,6 +69,7 @@
"@tailwindcss/forms": "^0.5.3",
"@tauri-apps/cli": "^1.4.0",
"@types/file-saver": "^2.0.5",
"@types/mime-types": "^2.1.1",
"@types/react": "18.0.25",
"@types/react-dom": "^18.0.5",
"@types/react-modal": "3.13.1",
Expand Down
45 changes: 43 additions & 2 deletions gui/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { Serial } from './components/settings/pages/Serial';
import { SettingsLayoutRoute } from './components/settings/SettingsLayout';
import {
useProvideWebsocketApi,
useWebsocketAPI,
WebSocketApiContext,
} from './hooks/websocket-api';

Expand Down Expand Up @@ -48,10 +49,17 @@ import { CalibrationTutorialPage } from './components/onboarding/pages/Calibrati
import { AssignmentTutorialPage } from './components/onboarding/pages/assignment-preparation/AssignmentTutorial';
import { open } from '@tauri-apps/api/shell';
import semver from 'semver';
import { useBreakpoint } from './hooks/breakpoint';
import { useBreakpoint, useIsTauri } from './hooks/breakpoint';
import { VRModePage } from './components/vr-mode/VRModePage';
import { InterfaceSettings } from './components/settings/pages/InterfaceSettings';
import { error, log } from './utils/logging';
import {
ComputerDirectory,
RpcMessage,
SaveFileNotificationT,
} from 'solarxr-protocol';
import mime from 'mime-types';
import { resolveDir, saveFile } from './utils/a11y';

export const GH_REPO = 'SlimeVR/SlimeVR-Server';
export const VersionContext = createContext('');
Expand All @@ -60,10 +68,43 @@ export const SLIMEVR_DISCORD = 'https://discord.gg/slimevr';

function Layout() {
const { loading } = useConfig();
const { isMobile } = useBreakpoint('mobile');
const isTauri = useIsTauri();
const { useRPCPacket } = useWebsocketAPI();

useRPCPacket(
RpcMessage.SaveFileNotification,
async (fileSave: SaveFileNotificationT) => {
if (!fileSave.data) return;
let filename =
typeof fileSave.expectedFilename === 'string'
? fileSave.expectedFilename
: 'data';

let mimeType = 'application/octet-stream';
if (typeof fileSave.fileExtension === 'string') {
filename += fileSave.fileExtension;
} else if (typeof fileSave.mimeType === 'string') {
mimeType = fileSave.mimeType;
filename += mime.extension(mimeType);
}

const file = new File([Uint8Array.from(fileSave.data)], filename, {
type: mimeType,
});

saveFile({
isTauri,
file,
defaultPath: await resolveDir(
fileSave.expectedDir ?? ComputerDirectory.Documents
).catch(() => undefined),
});
}
);

if (loading) return <></>;

const { isMobile } = useBreakpoint('mobile');
return (
<>
<SerialDetectionModal></SerialDetectionModal>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,9 @@ import {
SkeletonConfigRequestT,
} from 'solarxr-protocol';
import { useWebsocketAPI } from '../../../../hooks/websocket-api';
import saveAs from 'file-saver';
import { save } from '@tauri-apps/api/dialog';
import { writeTextFile } from '@tauri-apps/api/fs';
import { useIsTauri } from '../../../../hooks/breakpoint';
import { useAppContext } from '../../../../hooks/app';
import { error } from '../../../../utils/logging';
import { saveFile } from '../../../../utils/a11y';

export const MIN_HEIGHT = 0.4;
export const MAX_HEIGHT = 4;
Expand Down Expand Up @@ -51,28 +48,19 @@ export function ProportionsChoose() {
useRPCPacket(
RpcMessage.SkeletonConfigResponse,
(data: SkeletonConfigResponseT) => {
const blob = new Blob([JSON.stringify(data)], {
const file = new File([JSON.stringify(data)], 'body-proportions.json', {
type: 'application/json',
});
if (isTauri) {
save({
filters: [
{
name: l10n.getString('onboarding-choose_proportions-file_type'),
extensions: ['json'],
},
],
defaultPath: 'body-proportions.json',
})
.then((path) =>
path ? writeTextFile(path, JSON.stringify(data)) : undefined
)
.catch((err) => {
error(err);
});
} else {
saveAs(blob, 'body-proportions.json');
}
saveFile({
isTauri,
file,
filters: [
{
name: l10n.getString('onboarding-choose_proportions-file_type'),
extensions: ['json'],
},
],
});
}
);

Expand Down
58 changes: 58 additions & 0 deletions gui/src/utils/a11y.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
import { DialogFilter, save } from '@tauri-apps/api/dialog';
import { error } from './logging';
import saveAs from 'file-saver';
import { writeBinaryFile } from '@tauri-apps/api/fs';
import { ComputerDirectory } from 'solarxr-protocol';
import { documentDir } from '@tauri-apps/api/path';

export function a11yClick(event: React.KeyboardEvent | React.MouseEvent) {
if (event.type === 'click') {
return true;
Expand All @@ -6,3 +13,54 @@ export function a11yClick(event: React.KeyboardEvent | React.MouseEvent) {
return keyboard.key === 'Enter' || keyboard.key === ' ';
}
}

export async function saveFile({
isTauri,
file,
filters,
defaultPath,
}: {
isTauri: boolean;
file: File;
filters?: DialogFilter[];
defaultPath?: string;
}): Promise<void> {
if (isTauri) {
await save({
filters,
defaultPath: defaultPath ? `${defaultPath}/${file.name}` : file.name,
})
.then(async (path) =>
path ? writeBinaryFile(path, await file.arrayBuffer()) : undefined
)
.catch((err) => {
error(err);
});
} else {
if ('share' in navigator) {
let canShare: boolean | null = null;
if ('canShare' in navigator) {
canShare = navigator.canShare({ files: [file] });
}
if (canShare || canShare === null) {
const shared = await navigator
.share({ files: [file] })
.then(() => true)
.catch((err) => {
error(err);
return false;
});

if (shared) return;
}
}
saveAs(file, file.name);
}
}

export function resolveDir(dir: ComputerDirectory): Promise<string> {
switch(dir) {
case ComputerDirectory.Documents:
return documentDir();
}
}
22 changes: 17 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion solarxr-protocol
Submodule solarxr-protocol updated 26 files
+245 −5 protocol/cpp/include/solarxr_protocol/generated/all_generated.h
+17 −0 protocol/java/src/solarxr_protocol/rpc/ComputerDirectory.java
+2 −1 protocol/java/src/solarxr_protocol/rpc/RpcMessage.java
+4 −0 protocol/java/src/solarxr_protocol/rpc/RpcMessageHeader.java
+2 −0 protocol/java/src/solarxr_protocol/rpc/RpcMessageUnion.java
+112 −0 protocol/java/src/solarxr_protocol/rpc/SaveFileNotification.java
+46 −0 protocol/java/src/solarxr_protocol/rpc/SaveFileNotificationT.java
+86 −0 protocol/java/src/solarxr_protocol/rpc/SaveFileRequest.java
+34 −0 protocol/java/src/solarxr_protocol/rpc/SaveFileRequestT.java
+16 −0 protocol/kotlin/src/solarxr_protocol/rpc/ComputerDirectory.kt
+2 −1 protocol/kotlin/src/solarxr_protocol/rpc/RpcMessage.kt
+106 −0 protocol/kotlin/src/solarxr_protocol/rpc/SaveFileNotification.kt
+80 −0 protocol/kotlin/src/solarxr_protocol/rpc/SaveFileRequest.kt
+6 −0 protocol/rust/src/generated/mod.rs
+93 −0 protocol/rust/src/generated/solarxr_protocol/rpc/computer_directory_generated.rs
+7 −3 protocol/rust/src/generated/solarxr_protocol/rpc/rpc_message_generated.rs
+23 −0 protocol/rust/src/generated/solarxr_protocol/rpc/rpc_message_header_generated.rs
+182 −0 protocol/rust/src/generated/solarxr_protocol/rpc/save_file_notification_generated.rs
+146 −0 protocol/rust/src/generated/solarxr_protocol/rpc/save_file_request_generated.rs
+3 −0 protocol/typescript/src/all_generated.ts
+8 −0 protocol/typescript/src/solarxr-protocol/rpc/computer-directory.ts
+2 −1 protocol/typescript/src/solarxr-protocol/rpc/rpc-message-header.ts
+9 −5 protocol/typescript/src/solarxr-protocol/rpc/rpc-message.ts
+158 −0 protocol/typescript/src/solarxr-protocol/rpc/save-file-notification.ts
+117 −0 protocol/typescript/src/solarxr-protocol/rpc/save-file-request.ts
+30 −0 schema/rpc.fbs