fiftyone.devicedetection.onpremise 4.4.69 → 4.4.71

package/constants.js

@@ -1,26 +1,29 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 module.exports = {
+  /* Default params */
+  dataUpdateUrl: 'https://distributor.51degrees.com/api/v2/download',
+
   /* Match metrics description */
   deviceIdDescription: 'Consists of four components separated by a ' +
     'hyphen symbol: Hardware-Platform-Browser-IsCrawler where each ' +

package/deviceDetectionDataFile.js

@@ -1,23 +1,23 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 const querystring = require('querystring');
@@ -31,8 +31,13 @@ const DataFile = engines.DataFile;
  * update url which contains the product, type and licensekeys.
  * These paramaters are passed in to the datafile constructor's
  * updateURLParams parameter
+ * @param {string} options.useUrlFormatter whether to append default URL params for Data File download
  **/
 class DeviceDetectionDataFile extends DataFile {
+  constructor ({ useUrlFormatter = true, ...rest}) {
+    super({...rest});
+    this.useUrlFormatter = useUrlFormatter;
+  }
   /**
    * Uses the product, type and licensekey parameters the datafile
    * was constructed with to generate a querystring used in the datafile
@@ -44,14 +49,19 @@ class DeviceDetectionDataFile extends DataFile {
     const queryParams = {
       Product: this.updateURLParams.product,
       Type: this.updateURLParams.Type
-
     };
 
+    let URL = this.updateURLParams.baseURL;
+
     if (this.updateURLParams.licenseKeys) {
       queryParams.licenseKeys = this.updateURLParams.licenseKeys;
     }
 
-    return this.updateURLParams.baseURL + '?' + querystring.stringify(queryParams);
+    if(this.useUrlFormatter){
+      URL += '?' + querystring.stringify(queryParams);
+    }
+
+    return URL;
   }
 }
 

package/deviceDetectionOnPremise.js

@@ -181,8 +181,10 @@ class DeviceDetectionOnPremise extends Engine {
    * @param {DataKeyedCache} options.cache an instance of the Cache class from
    * Fiftyone.Pipeline.Engines. NOTE: This is no longer supported for
    * on-premise engine.
-   * @param {string} options.dataFileUpdateBaseUrl base url for the datafile
+   * @param {string} options.dataUpdateUrl base url for the datafile
    * update service
+   * @param {boolean} options.dataUpdateVerifyMd5 whether to check MD5 of datafile
+   * @param {boolean} options.dataUpdateUseUrlFormatter whether to append default URL params for Data File download
    * @param {Array} options.restrictedProperties list of properties the engine
    * will be restricted to
    * @param {string} options.licenceKeys license key(s) used by the
@@ -235,7 +237,9 @@ class DeviceDetectionOnPremise extends Engine {
       dataFilePath,
       autoUpdate,
       cache,
-      dataFileUpdateBaseUrl = 'https://distributor.51degrees.com/api/v2/download',
+      dataUpdateUrl = constants.dataUpdateUrl,
+      dataUpdateVerifyMd5 = true,
+      dataUpdateUseUrlFormatter= true,
       restrictedProperties,
       licenceKeys,
       download,
@@ -457,18 +461,20 @@ class DeviceDetectionOnPremise extends Engine {
 
     // Disable features that require a license key if one was
     // not supplied.
-    if (licenceKeys) {
-      autoUpdate = autoUpdate && licenceKeys.length > 0;
-      updateOnStart = updateOnStart && licenceKeys.length > 0;
-    } else {
-      autoUpdate = false;
-      updateOnStart = false;
+    if(dataUpdateUrl === constants.dataUpdateUrl) {
+      if (licenceKeys) {
+        autoUpdate = autoUpdate && licenceKeys.length > 0;
+        updateOnStart = updateOnStart && licenceKeys.length > 0;
+      } else {
+        autoUpdate = false;
+        updateOnStart = false;
+      }
     }
 
     // Construct datafile
     const dataFileSettings = {
       flowElement: this,
-      verifyMD5: true,
+      verifyMD5: dataUpdateVerifyMd5,
       autoUpdate,
       updateOnStart,
       decompress: true,
@@ -476,7 +482,8 @@ class DeviceDetectionOnPremise extends Engine {
       download,
       fileSystemWatcher,
       pollingInterval,
-      updateTimeMaximumRandomisation
+      updateTimeMaximumRandomisation,
+      useUrlFormatter: dataUpdateUseUrlFormatter
     };
 
     dataFileSettings.getDatePublished = function () {
@@ -514,7 +521,7 @@ class DeviceDetectionOnPremise extends Engine {
       params.licenseKeys = licenceKeys;
     }
 
-    params.baseURL = dataFileUpdateBaseUrl;
+    params.baseURL = dataUpdateUrl;
 
     dataFileSettings.updateURLParams = params;
 

package/deviceDetectionOnPremisePipelineBuilder.js

@@ -1,28 +1,29 @@
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 const os = require('os');
 const core = require('fiftyone.pipeline.core');
 const DeviceDetectionOnPremise = require('./deviceDetectionOnPremise');
+const constants = require('./constants');
 const PipelineBuilder = core.PipelineBuilder;
 const ShareUsageElement = require('fiftyone.pipeline.engines.fiftyone').ShareUsage;
 const errorMessages = require('fiftyone.devicedetection.shared').errorMessages;
@@ -43,7 +44,10 @@ class DeviceDetectionOnPremisePipelineBuilder extends PipelineBuilder {
    * an empty string, but this will cause automatic updates
    * to be disabled.
    * @param {string} options.dataFile dataFile path for the on premise engine
+   * @param {boolean} options.dataUpdateVerifyMd5 whether to check MD5 of datafile
+   * @param {boolean} options.dataUpdateUseUrlFormatter whether to append default URL params for Data File download
    * @param {boolean} options.autoUpdate whether to autoUpdate the dataFile
+   * @param {string} options.dataUpdateUrl base url for the datafile
    * @param {number} options.pollingInterval How often to poll for
    * updates to the datafile (minutes)
    * @param {number} options.updateTimeMaximumRandomisation
@@ -101,7 +105,10 @@ class DeviceDetectionOnPremisePipelineBuilder extends PipelineBuilder {
       dataFileUpdateService = null,
       licenceKeys = null,
       dataFile = null,
+      dataUpdateVerifyMd5 = true,
+      dataUpdateUseUrlFormatter= true,
       autoUpdate = true,
+      dataUpdateUrl = null,
       pollingInterval = 30,
       updateTimeMaximumRandomisation = 10,
       shareUsage = true,
@@ -129,14 +136,20 @@ class DeviceDetectionOnPremisePipelineBuilder extends PipelineBuilder {
       this.flowElements.push(new ShareUsageElement());
     }
 
+    if (dataUpdateUrl == null) {
+      dataUpdateUrl = constants.dataUpdateUrl;
+    }
+
     if (cacheSize) {
       throw errorMessages.cacheNotSupport;
     }
-
     this.flowElements.push(new DeviceDetectionOnPremise(
       {
         dataFilePath: dataFile,
         autoUpdate,
+        dataUpdateUrl,
+        dataUpdateVerifyMd5,
+        dataUpdateUseUrlFormatter,
         fileSystemWatcher,
         pollingInterval,
         updateTimeMaximumRandomisation,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.devicedetection.onpremise",
-  "version": "4.4.69",
+  "version": "4.4.71",
   "description": "Device detection on-premise services for the 51Degrees Pipeline API",
   "main": "index.js",
   "directories": {