Dive metadata

client/platform/web-girder/api/divemetadata.service.ts

@@ -0,0 +1,76 @@
+import girderRest from 'platform/web-girder/plugins/girder';
+import { StringKeyObject } from 'vue-media-annotator/BaseAnnotation';
+
+export interface MetadataFilterItem {
+    category: 'search' | 'categorical' | 'numerical' | 'boolean',
+    value?: boolean | string | string[] | number | number[]
+    range?: number[]
+}
+
+export interface FilterDisplayConfig {
+    display: string[];
+    hide: string[];
+}
+
+export interface MetadataFilterKeysItem {
+    category: 'search' | 'categorical' | 'numerical' | 'boolean';
+    count: number;
+    set?: string[] | number[];
+    range?: {
+        min: number,
+        max: number;
+    };
+
+}
+
+export interface DIVEMetadaFilter {
+    search?: string;
+    metadataFilters?: Record<string, MetadataFilterItem>;
+}
+
+export interface DIVEMetadataFilterValueResults {
+    _id: string;
+    created: string;
+    root: string;
+    metadataKeys: Record<string, MetadataFilterKeysItem>;
+}
+
+export interface DIVEMetadataResults {
+    pageResults: MetadataResultItem[];
+    totalPages: number;
+}
+
+export interface MetadataResultItem {
+    DIVEDataset: string;
+    filename: string;
+    root: string;
+    metadata: StringKeyObject;
+}
+
+function getMetadataFilterValues(folderId: string, keys?: string[]) {
+  return girderRest.get<DIVEMetadataFilterValueResults>(`dive_metadata/${folderId}/metadata_keys`, {
+    params: { keys },
+  });
+}
+
+function filterDiveMetadata(folderId: string, filters: DIVEMetadaFilter, offset = 0, limit = 50, sort = 'filename', sortdir = -1) {
+  return girderRest.get<DIVEMetadataResults>(`dive_metadata/${folderId}/filter`, {
+    params: {
+      filters, offset, limit, sort, sortdir,
+    },
+  });
+}
+
+function createDiveMetadataClone(folder: string, filters: DIVEMetadaFilter, destFolder: string) {
+  return girderRest.post<string>(`dive_metadata/${folder}/clone_filter`, null, {
+    params: {
+      baseFolder: folder, filters, destFolder,
+    },
+  });
+}
+
+export {
+  getMetadataFilterValues,
+  filterDiveMetadata,
+  createDiveMetadataClone,
+};

client/platform/web-girder/router.ts

@@ -11,6 +11,7 @@ import ViewerLoader from './views/ViewerLoader.vue';
 import DataShared from './views/DataShared.vue';
 import DataBrowser from './views/DataBrowser.vue';
 import Summary from './views/Summary.vue';
+import DIVEMetadataSearchVue from './views/DIVEMetadataSearch.vue';
 
 Vue.use(Router);
 
@@ -70,6 +71,13 @@ const router = new Router({
           component: Jobs,
           beforeEnter,
         },
+        {
+          path: '/metadata/:id/',
+          name: 'metadata',
+          component: DIVEMetadataSearchVue,
+          props: true,
+          beforeEnter,
+        },
         {
           path: '',
           component: Home,

client/platform/web-girder/views/DIVEMetadataClone.vue

@@ -0,0 +1,128 @@
+<script lang="ts">
+import {
+  computed, defineComponent, Ref, ref, PropType,
+} from 'vue';
+import { GirderFileManager, GirderModelType } from '@girder/components/src';
+import useRequest from 'dive-common/use/useRequest';
+import { RootlessLocationType } from 'platform/web-girder/store/types';
+import { useGirderRest } from 'platform/web-girder/plugins/girder';
+import { useRouter } from 'vue-router/composables';
+import { DIVEMetadaFilter, createDiveMetadataClone } from 'platform/web-girder/api/divemetadata.service';
+
+export default defineComponent({
+  components: { GirderFileManager },
+
+  props: {
+    baseId: {
+      type: String,
+      required: true,
+    },
+    filter: {
+      // Filter to apply to the dataset
+      type: Object as PropType<DIVEMetadaFilter>,
+      required: true,
+    },
+  },
+
+  setup(props) {
+    const router = useRouter();
+    const girderRest = useGirderRest();
+    const location: Ref<RootlessLocationType> = ref({
+      _modelType: ('user' as GirderModelType),
+      _id: girderRest.user._id,
+    });
+
+    const locationIsFolder = computed(() => (location.value._modelType === 'folder'));
+
+    function setLocation(newLoc: RootlessLocationType) {
+      if (!('meta' in newLoc && newLoc.meta.annotate)) {
+        location.value = newLoc;
+      }
+    }
+
+    const { request: _cloneRequest, error: cloneError, loading: cloneLoading } = useRequest();
+    const doClone = () => _cloneRequest(async () => {
+      const newDataset = await createDiveMetadataClone(props.baseId, props.filter, location.value._id);
+      router.push({ path: `/folder/${newDataset.data}`, replace: true });
+    });
+
+    return {
+      cloneError,
+      cloneLoading,
+      location,
+      locationIsFolder,
+      /* methods */
+      doClone,
+      setLocation,
+    };
+  },
+});
+</script>
+
+<template>
+  <v-card>
+    <v-divider />
+    <v-card-title>
+      Create a new clone
+    </v-card-title>
+    <v-card-text>
+      <v-alert
+        v-if="cloneError"
+        type="error"
+        dismissible
+      >
+        {{ cloneError }}
+      </v-alert>
+      Create a copy of this filter in your personal workspace.  You will be able
+      to edit annotations and run pipelines on the cloned datasets.  This operation does not
+      copy, but instead directly references the source media.
+      <v-card
+        outlined
+        flat
+      >
+        <GirderFileManager
+          new-folder-enabled
+          root-location-disabled
+          no-access-control
+          :location="location"
+          @update:location="setLocation"
+        >
+          <template #row="{ item }">
+            <span>{{ item.name }}</span>
+            <v-chip
+              v-if="(item.meta && item.meta.annotate)"
+              color="white"
+              x-small
+              outlined
+              class="mx-3"
+            >
+              dataset
+            </v-chip>
+          </template>
+        </GirderFileManager>
+      </v-card>
+      <v-btn
+        depressed
+        block
+        color="primary"
+        class="mt-4"
+        :loading="cloneLoading"
+        :disabled="!locationIsFolder || cloneLoading"
+        @click="doClone"
+      >
+        <span v-if="!locationIsFolder">
+          Choose a destination folder...
+        </span>
+        <span v-else-if="'name' in location">
+          Clone into {{ location.name }}
+        </span>
+        <span v-else>
+          Something went wrong
+        </span>
+      </v-btn>
+    </v-card-text>
+  </v-card>
+</template>
+
+<style scoped>
+</style>