feat(transferSyntax): Add customizable Transfer syntax through datasource config (#3406)

platform/app/public/config/aws.js

@@ -4,7 +4,7 @@ window.config = {
   modes: [],
   showStudyList: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
+
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -30,6 +30,7 @@ window.config = {
         supportsFuzzyMatching: false,
         supportsWildcard: false,
         staticWado: true,
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/default.js

@@ -11,7 +11,6 @@ window.config = {
   // some windows systems have issues with more than 3 web workers
   maxNumberOfWebWorkers: 3,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -51,7 +50,6 @@ window.config = {
         wadoUriRoot: 'https://d33do7qe4w26qo.cloudfront.net/dicomweb',
         qidoRoot: 'https://d33do7qe4w26qo.cloudfront.net/dicomweb',
         wadoRoot: 'https://d33do7qe4w26qo.cloudfront.net/dicomweb',
-
         qidoSupportsIncludeField: false,
         supportsReject: false,
         imageRendering: 'wadors',
@@ -68,6 +66,7 @@ window.config = {
           enabled: true,
           relativeResolution: 'studies',
         },
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/demo.js

@@ -4,7 +4,6 @@ window.config = {
   extensions: [],
   showStudyList: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   strictZSpacingForVolumeViewport: true,
   showCPUFallbackMessage: true,
@@ -25,6 +24,7 @@ window.config = {
         bulkDataURI: {
           enabled: false,
         },
+        omitQuotationForMultipartRequest: true,
       },
     },
   ],

platform/app/public/config/dicomweb-server.js

@@ -4,7 +4,6 @@ window.config = {
   modes: [],
   showStudyList: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -28,6 +27,7 @@ window.config = {
         enableStudyLazyLoad: true,
         supportsFuzzyMatching: false,
         supportsWildcard: false,
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/dicomweb_relative.js

@@ -5,7 +5,6 @@ window.config = {
   showStudyList: true,
   maxNumberOfWebWorkers: 3,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -31,6 +30,7 @@ window.config = {
         supportsWildcard: true,
         staticWado: true,
         singlepart: 'bulkdata,video,pdf',
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/docker_nginx-orthanc.js

@@ -4,7 +4,6 @@ window.config = {
   extensions: [],
   modes: [],
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -23,6 +22,7 @@ window.config = {
         qidoSupportsIncludeField: false,
         imageRendering: 'wadors',
         thumbnailRendering: 'wadors',
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/docker_openresty-orthanc-keycloak.js

@@ -2,7 +2,6 @@ window.config = {
   routerBasename: '/',
   showStudyList: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -18,6 +17,7 @@ window.config = {
         qidoSupportsIncludeField: false,
         imageRendering: 'wadors',
         thumbnailRendering: 'wadors',
+        omitQuotationForMultipartRequest: true,
         // REQUIRED TAG:
         // TODO: Remove tag after https://github.com/OHIF/ohif-core/pull/19 is merged and we bump version
         // requestOptions: {

platform/app/public/config/docker_openresty-orthanc.js

@@ -4,7 +4,7 @@ window.config = {
   extensions: [],
   modes: [],
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
+
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -23,6 +23,7 @@ window.config = {
         qidoSupportsIncludeField: false,
         imageRendering: 'wadors',
         thumbnailRendering: 'wadors',
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/e2e.js

@@ -4,7 +4,6 @@ window.config = {
   modes: ['@ohif/mode-test'],
   showStudyList: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   maxNumberOfWebWorkers: 3,
   showWarningMessageForCrossOrigin: false,
   showCPUFallbackMessage: false,
@@ -31,6 +30,7 @@ window.config = {
         supportsFuzzyMatching: false,
         supportsWildcard: true,
         singlepart: 'video,thumbnail,pdf',
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/google.js

@@ -6,7 +6,6 @@ window.config = {
   },
   enableGoogleCloudAdapter: false,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -55,6 +54,7 @@ window.config = {
         supportsFuzzyMatching: true,
         supportsWildcard: false,
         dicomUploadEnabled: true,
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/idc.js

@@ -2,7 +2,6 @@ window.config = {
   routerBasename: '/',
   enableGoogleCloudAdapter: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,

platform/app/public/config/local_dcm4chee.js

@@ -8,7 +8,6 @@ window.config = {
   extensions: [],
   modes: [],
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -39,6 +38,7 @@ window.config = {
         bulkDataURI: {
           enabled: true,
         },
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/local_static.js

@@ -8,7 +8,6 @@ window.config = {
   showStudyList: true,
   maxNumberOfWebWorkers: 4,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -33,6 +32,7 @@ window.config = {
         supportsWildcard: true,
         staticWado: true,
         singlepart: 'bulkdata,video,pdf',
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/multiple.js

@@ -16,7 +16,6 @@ window.config = {
   showStudyList: true,
   maxNumberOfWebWorkers: 4,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -42,6 +41,7 @@ window.config = {
         supportsWildcard: true,
         staticWado: true,
         singlepart: 'bulkdata,video,pdf',
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/netlify.js

@@ -4,7 +4,6 @@ window.config = {
   modes: [],
   showStudyList: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -38,6 +37,7 @@ window.config = {
           enabled: true,
           relativeResolution: 'studies',
         },
+        omitQuotationForMultipartRequest: true,
       },
     },
     {

platform/app/public/config/public_dicomweb.js

@@ -2,7 +2,6 @@ window.config = {
   routerBasename: '/',
   showStudyList: true,
   // below flag is for performance reasons, but it might not work for all servers
-  omitQuotationForMultipartRequest: true,
   showWarningMessageForCrossOrigin: true,
   showCPUFallbackMessage: true,
   showLoadingIndicator: true,
@@ -18,6 +17,7 @@ window.config = {
         imageRendering: 'wadors',
         thumbnailRendering: 'wadors',
         supportsFuzzyMatching: true,
+        omitQuotationForMultipartRequest: true,
       },
     ],
   },

platform/core/src/utils/generateAcceptHeader.ts

@@ -0,0 +1,58 @@
+const generateAcceptHeader = (
+  configAcceptHeader = [],
+  requestTransferSyntaxUID = null,
+  omitQuotationForMultipartRequest = false
+): string[] => {
+  //if acceptedHeader is passed by config use it as it.
+  if (configAcceptHeader.length > 0) {
+    return configAcceptHeader;
+  }
+
+  let acceptHeader = ['multipart/related'];
+  if (requestTransferSyntaxUID && typeForTS[requestTransferSyntaxUID]) {
+    const type = typeForTS[requestTransferSyntaxUID];
+    acceptHeader.push('type=' + type);
+    acceptHeader.push('transfer-syntax=' + requestTransferSyntaxUID);
+  } else {
+    acceptHeader.push('type=application/octet-stream');
+  }
+
+  if (!omitQuotationForMultipartRequest) {
+    //need to add quotation for each mime type of each accept entry
+    acceptHeader = acceptHeader.map(mime => {
+      if (mime.startsWith('type=')) {
+        const quotedParam = 'type="' + mime.substring(5, mime.length) + '"';
+        return quotedParam;
+      }
+      if (mime.startsWith('transfer-syntax=')) {
+        const quotedParam =
+          'transfer-syntax="' + mime.substring(16, mime.length) + '"';
+        return quotedParam;
+      } else {
+        return mime;
+      }
+    });
+  }
+
+  return [acceptHeader.join('; ')];
+};
+
+const typeForTS = {
+  '*': 'application/octet-stream',
+  '1.2.840.10008.1.2.1': 'application/octet-stream',
+  '1.2.840.10008.1.2': 'application/octet-stream',
+  '1.2.840.10008.1.2.2': 'application/octet-stream',
+  '1.2.840.10008.1.2.4.70': 'image/jpeg',
+  '1.2.840.10008.1.2.4.50': 'image/jpeg',
+  '1.2.840.10008.1.2.4.51': 'image/dicom+jpeg',
+  '1.2.840.10008.1.2.4.57': 'image/jpeg',
+  '1.2.840.10008.1.2.5': 'image/dicom-rle',
+  '1.2.840.10008.1.2.4.80': 'image/jls',
+  '1.2.840.10008.1.2.4.81': 'image/jls',
+  '1.2.840.10008.1.2.4.90': 'image/jp2',
+  '1.2.840.10008.1.2.4.91': 'image/jp2',
+  '1.2.840.10008.1.2.4.92': 'image/jpx',
+  '1.2.840.10008.1.2.4.93': 'image/jpx',
+};
+
+export default generateAcceptHeader;

platform/core/src/utils/index.js

@@ -13,6 +13,7 @@ import Queue from './Queue';
 import isDicomUid from './isDicomUid';
 import formatDate from './formatDate';
 import formatPN from './formatPN';
+import generateAcceptHeader from './generateAcceptHeader';
 import resolveObjectPath from './resolveObjectPath';
 import hierarchicalListUtils from './hierarchicalListUtils';
 import progressTrackingUtils from './progressTrackingUtils';
@@ -74,6 +75,7 @@ const utils = {
   subscribeToNextViewportGridChange,
   splitComma,
   getSplitParam,
+  generateAcceptHeader,
 };
 
 export {
@@ -105,6 +107,7 @@ export {
   downloadCSVReport,
   splitComma,
   getSplitParam,
+  generateAcceptHeader,
 };
 
 export default utils;

platform/core/src/utils/index.test.js

@@ -24,6 +24,7 @@ describe('Top level exports', () => {
       'b64toBlob',
       'formatDate',
       'formatPN',
+      'generateAcceptHeader',
       'isEqualWithin',
       //'loadAndCacheDerivedDisplaySets',
       'isDisplaySetReconstructable',

platform/docs/docs/configuration/configurationFiles.md

@@ -48,6 +48,7 @@ window.config = {
         enableStudyLazyLoad: true,
         supportsFuzzyMatching: true,
         supportsWildcard: true,
+        omitQuotationForMultipartRequest: true,
       },
     },
   ],
@@ -97,6 +98,7 @@ window.config = ({ servicesManager } = {}) => {
         enableStudyLazyLoad: true,
         supportsFuzzyMatching: true,
         supportsWildcard: true,
+        omitQuotationForMultipartRequest: true,
       },
     },
   ],
@@ -112,6 +114,8 @@ Here are a list of some options available:
 - `maxNumberOfWebWorkers`: The maximum number of web workers to use for
   decoding. Defaults to minimum of `navigator.hardwareConcurrency` and
   what is specified by `maxNumberOfWebWorkers`. Some windows machines require smaller values.
+- `acceptHeader` : accept header to request specific dicom transfer syntax ex : [ 'multipart/related; type=image/jls; q=1', 'multipart/related; type=application/octet-stream; q=0.1' ]
+- `requestTransferSyntaxUID` : Request a specific Tansfer syntax from dicom web server ex: 1.2.840.10008.1.2.4.80  (applyed only if acceptHeader is not set)
 - `omitQuotationForMultipartRequest`: Some servers (e.g., .NET) require the `multipart/related` request to be sent without quotation marks. Defaults to `false`. If your server doesn't require this, then setting this flag to `true` might improve performance (by removing the need for preflight requests). Also note that
 if auth headers are used, a preflight request is required.
 - `maxNumRequests`: The maximum number of requests to allow in parallel. It is an object with keys of `interaction`, `thumbnail`, and `prefetch`. You can specify a specific number for each type.