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

Metadata Editing/Permissions #184

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
5 changes: 1 addition & 4 deletions client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dive-dsa",
"version": "1.10.18",
"version": "1.10.19",
"author": {
"name": "Kitware, Inc.",
"email": "[email protected]"
Expand Down Expand Up @@ -29,8 +29,6 @@
"@flatten-js/interval-tree": "^1.0.11",
"@girder/components": "^3.2.0",
"@mdi/font": "^6.2.95",
"@sentry/browser": "^5.24.2",
"@sentry/integrations": "^5.24.2",
"axios": "^1.6.7",
"color-hash": "^1.0.3",
"core-js": "^3.22.2",
Expand All @@ -50,7 +48,6 @@
"vuex": "^3.0.1"
},
"devDependencies": {
"@sentry/webpack-plugin": "^1.18.3",
"@types/axios": "^0.14.0",
"@types/body-parser": "^1.19.0",
"@types/color-hash": "^1.0.0",
Expand Down
96 changes: 96 additions & 0 deletions client/platform/web-girder/api/divemetadata.service.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import girderRest from 'platform/web-girder/plugins/girder';
import { GirderModelBase } from 'vue-girder-slicer-cli-ui/dist/girderTypes';
import { StringKeyObject } from 'vue-media-annotator/BaseAnnotation';

export interface MetadataFilterItem {
Expand Down Expand Up @@ -35,6 +36,7 @@ export interface DIVEMetadataFilterValueResults {
created: string;
root: string;
metadataKeys: Record<string, MetadataFilterKeysItem>;
unlocked: string[];
}

export interface DIVEMetadataResults {
Expand Down Expand Up @@ -73,8 +75,102 @@ function createDiveMetadataClone(folder: string, filters: DIVEMetadataFilter, de
});
}

export interface createDiveMetadataResponse {
'results': string,
'errors': string[];
// eslint-disable-next-line @typescript-eslint/no-explicit-any
'metadataKeys': any[];
'folderId': string;

}

function createDiveMetadataFolder(
parentFolder: string,
name: string,
rootFolderId: string,
categoricalLimit = 50,
displayConfig = {
display: ['DIVE_DatasetId', 'DIVE_Name'],
},
ffprobeMetadata = {
import: true, keys: ['width', 'height', 'display_aspect_ratio'],
},
) {
return girderRest.post<createDiveMetadataResponse>(`dive_metadata/create_metadata_folder/${parentFolder}`, null, {
params: {
name, rootFolderId, categoricalLimit, displayConfig, ffprobeMetadata,
},
});
}

function modifyDiveMetadataPermission(rootMetadataFolder: string, key: string, unlocked: boolean) {
return girderRest.patch(`dive_metadata/${rootMetadataFolder}/modify_key_permission`, null, {
params: {
key, unlocked,
},
});
}

function addDiveMetadataKey(rootMetadataFolder: string, key: string, category: 'numerical' | 'categorical' | 'search' | 'boolean', unlocked = false, valueList: string[] = [], defaultValue?: number | string | boolean) {
const values = valueList.length ? valueList : undefined;
return girderRest.put(`dive_metadata/${rootMetadataFolder}/add_key`, null, {
params: {
key, category, unlocked, values, default_value: defaultValue,
},
});
}

function deleteDiveMetadataKey(rootMetadataFolder:string, key: string) {
return girderRest.delete(`dive_metadata/${rootMetadataFolder}/delete_key`, {
params: {
key,
},
});
}

function deleteDiveDatasetMetadataKey(diveDatasetId: string, key: string) {
return girderRest.delete(`dive_metadata/${diveDatasetId}`, { params: { key } });
}
function setDiveDatasetMetadataKey(diveDatasetId: string, key: string, updateValue?: number | string | boolean) {
const value = updateValue === undefined ? null : updateValue;
return girderRest.patch(`dive_metadata/${diveDatasetId}`, null, {
params: {
key, value,
},
});
}

async function updateDiveMetadataDisplay(folderId: string, key: string, state: 'display' | 'hidden' | 'none') {
const resp = await girderRest.get<GirderModelBase>(`folder/${folderId}`);
const DIVEMetadataFilter = resp.data.meta.DIVEMetadataFilter as {display: string[], hide: string[], categoricalLimit: number};
if (DIVEMetadataFilter) {
const { display } = DIVEMetadataFilter;
const { hide } = DIVEMetadataFilter;
if (display.includes(key)) {
display.splice(display.findIndex((item) => item === key), 1);
}
if (hide.includes(key)) {
hide.splice(hide.findIndex((item) => item === key), 1);
}
if (state === 'display') {
display.push(key);
}
if (state === 'hidden') {
hide.push(key);
}
await girderRest.put(`folder/${folderId}/metadata`, { DIVEMetadataFilter });
}
}

export {
getMetadataFilterValues,
filterDiveMetadata,
createDiveMetadataClone,
createDiveMetadataFolder,
modifyDiveMetadataPermission,
addDiveMetadataKey,
deleteDiveMetadataKey,
deleteDiveDatasetMetadataKey,
setDiveDatasetMetadataKey,
updateDiveMetadataDisplay,
};
17 changes: 17 additions & 0 deletions client/platform/web-girder/api/girder.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,22 @@ function getFolder(folderId: string) {
return girderRest.get<GirderModel>(`folder/${folderId}`);
}

export interface AccessType {
flags: string[];
id: string;
level: number;
login: string;
name: string;
}
export interface FolderAccessType {
groups: AccessType[];
users: AccessType[];
}

function getFolderAccess(folderId: string) {
return girderRest.get<FolderAccessType>(`folder/${folderId}/access`);
}

function setUsePrivateQueue(userId: string, value = false) {
return girderRest.put<{
user_private_queue_enabled: boolean;
Expand All @@ -42,4 +58,5 @@ export {
getItemsInFolder,
getFolder,
setUsePrivateQueue,
getFolderAccess,
};
11 changes: 0 additions & 11 deletions client/platform/web-girder/main.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import Vue from 'vue';
import VueGtag from 'vue-gtag';
import { init as SentryInit } from '@sentry/browser';
import { Vue as SentryVue } from '@sentry/integrations';

import registerNotifications from 'vue-media-annotator/notificatonBus';
import promptService from 'dive-common/vue-utilities/prompt-service';
Expand All @@ -22,15 +20,6 @@ if (
process.env.NODE_ENV === 'production'
&& window.location.hostname !== 'localhost'
) {
SentryInit({
dsn: process.env.VUE_APP_SENTRY_DSN,
integrations: [
new SentryVue({ Vue, logErrors: true }),
],
release: process.env.VUE_APP_GIT_HASH,
environment: (window.location.hostname === 'viame.kitware.com')
? 'production' : 'development',
});
Vue.use(VueGtag, {
config: { id: process.env.VUE_APP_GTAG },
}, router);
Expand Down
17 changes: 17 additions & 0 deletions client/platform/web-girder/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import DataShared from './views/DataShared.vue';
import DataBrowser from './views/DataBrowser.vue';
import Summary from './views/Summary.vue';
import DIVEMetadataSearchVue from './views/DIVEMetadataSearch.vue';
import DiveMetadataEditVue from './views/DIVEMetadataEdit.vue';

Vue.use(Router);

Expand Down Expand Up @@ -88,6 +89,22 @@ const router = new Router({
},
beforeEnter,
},
{
path: '/metadata-edit/:id/',
name: 'metadata-edit',
component: DiveMetadataEditVue,
props: (route) => {
if (route.query.filter) {
return {
id: route.params.id, // Map route parameter to prop
};
}
return {
id: route.params.id,
};
},
beforeEnter,
},
{
path: '',
component: Home,
Expand Down
Loading
Loading