fiftyone-devicedetection-onpremise 4.5.0a25__tar.gz → 4.5.0a27__tar.gz

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiftyone_devicedetection_onpremise
-Version: 4.5.0a25
+Version: 4.5.0a27
 Summary: This project contains 51Degrees Device Detection OnPremise engine that can be used with the 51Degrees Pipeline API. The Pipeline is a generic web request intelligence and data processing solution with the ability to add a range of 51Degrees and/or custom plug ins (Engines)
 Author: 51Degrees Engineering
 Author-email: engineering@51degrees.com

fiftyone_devicedetection_onpremise-4.5.0a27/setup.py

@@ -0,0 +1,215 @@
+# *********************************************************************
+# This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+# Copyright 2025 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.
+# *********************************************************************
+
+"""
+setup.py file for SWIG
+"""
+import sys
+import platform
+from setuptools import setup, Extension
+from setuptools.command import develop
+from distutils import sysconfig
+from Cython.Distutils import build_ext
+from glob import glob
+import os
+import io
+
+# Read a text file and return the content as a string.
+def read(file_name):
+
+    """Read a text file and return the content as a string."""
+    try:
+        with io.open(
+            os.path.join(os.path.dirname(__file__), file_name), encoding="utf-8"
+        ) as f:
+            return f.read().strip()
+    except:
+        return "0.0.0"
+
+def get_version():
+
+    version = None
+
+    # Try to get the correct version from platform.
+    is_64bits = sys.maxsize > 2**32
+    if is_64bits:
+        if 'Windows' in platform.system():
+            version = "win_64_"
+        if 'Linux' in platform.system():
+            version = "linux_64_"
+        if 'Darwin' in platform.system():
+            version = "darwin_64_"
+    else:
+        if 'Windows' in platform.system():
+            version = "win_32_"
+        if 'Linux' in platform.system():
+            version = "linux_32_"
+        if 'Darwin' in platform.system():
+            # No 32 bit python on Mac
+            version = None
+            raise Exception("Sorry, No 32 bit Python on Mac")
+
+    python_version = str(sys.version_info[0])
+    return version + python_version
+
+class NoSuffixBuilder(build_ext):
+    def get_ext_filename(self, ext_name):
+        filename = super().get_ext_filename(ext_name)
+        suffix = sysconfig.get_config_var('EXT_SUFFIX')
+        if suffix is None:
+            suffix = sysconfig.get_config_var('SO')
+
+        print("**" + filename + "**\r\n")
+        print("**" + suffix + "**\r\n")
+
+        # Get the version from the suffix.
+        version = get_version()
+
+        ext = os.path.splitext(filename)[1]
+
+        if self.inplace:
+            return "./" + filename.replace(suffix, "") + ext
+        else:
+            return filename.replace(suffix, "") + ext
+
+define_macros = []
+extra_compile_args = []
+extra_link_args = []
+# Extra compilation flags for C library
+cflags = []
+
+if sys.platform != "win32":
+    extra_compile_args.extend([
+        '-fPIC',
+        '-std=gnu++17',
+        '-Wall',
+        # '-Werror'
+    ])
+    cflags.extend([
+        '-std=gnu11',
+        '-Wall',
+        # '-Werror',
+        '-Wno-strict-prototypes',
+        '-Wno-unused-variable',
+        '-Wno-missing-braces',
+        '-Wno-strict-aliasing'
+    ])
+
+
+if sys.platform == "win32":
+    extra_compile_args.extend([
+        '/std:c++17',
+        '/D_CRT_SECURE_NO_WARNINGS',
+        '/D_UNICODE',
+        '/DUNICODE',
+        '/W4',
+        # '/WX',
+        '/wd4127',
+        '/wd4456',
+        '/wd4701',
+        '/wd4703',
+        '/wd4706'
+    ])
+    cflags.extend([
+        '/D_CRT_SECURE_NO_WARNINGS',
+        '/D_UNICODE',
+        '/DUNICODE',
+        '/W4',
+        # '/WX'
+    ])
+    extra_link_args.extend([
+        '/WX'
+    ])
+
+if sys.platform == "linux":
+    extra_link_args.extend([
+        '-latomic'
+    ])
+
+if sys.platform == 'darwin':
+    # This is flaged in CPython
+    extra_compile_args.extend([
+        '-DGCC_ENABLE_CPP_EXCEPTIONS=YES'
+    ])
+    if sys.version_info[0] == 3 and sys.version_info[1] == 8:
+        extra_compile_args.extend([
+            '-Wno-deprecated-declarations'
+    ])
+    cflags.extend([
+        '-Wno-atomic-alignment'
+    ])
+
+DeviceDetectionHashEngineModule = Extension('_DeviceDetectionHashEngineModule',
+        sources=[
+        # Python Wrapper
+        # "fiftyone_devicedetection_onpremise/hash_python.i"
+        "src/fiftyone_devicedetection_onpremise/hash_python_wrap.cxx"
+        ],
+        define_macros=define_macros,
+        extra_compile_args=extra_compile_args,
+        extra_link_args=extra_link_args,
+        language='c++',
+    )
+
+cpplib = ('cpplib', {
+        'sources': [
+            # Common C++
+            *glob("src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/*.cpp"),
+            # Device Detection C++
+            *glob("src/fiftyone_devicedetection_onpremise/cxx/src/*.cpp"),
+            # Hash C++
+            *glob("src/fiftyone_devicedetection_onpremise/cxx/src/hash/*.cpp"),
+            ],
+        'cflags': extra_compile_args
+    })
+
+clib = ('clib', {
+        'sources': [
+            # Common C
+            *glob("src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/*.c"),
+            # Device Detection C
+            *glob("src/fiftyone_devicedetection_onpremise/cxx/src/*.c"),
+            # Hash C
+            *glob("src/fiftyone_devicedetection_onpremise/cxx/src/hash/*.c"),
+        ],
+        'cflags': cflags
+    })
+
+setup(
+    cmdclass={"build_ext": NoSuffixBuilder},
+    name="fiftyone_devicedetection_onpremise",
+    version=read("version.txt"),
+    author="51Degrees Engineering",
+    author_email="engineering@51degrees.com",
+    description = """This project contains 51Degrees Device Detection OnPremise engine that can be used with the 51Degrees Pipeline API. The Pipeline is a generic web request intelligence and data processing solution with the ability to add a range of 51Degrees and/or custom plug ins (Engines)""",
+    long_description=read("readme.md"),
+    long_description_content_type="text/markdown",
+    python_requires=">=3.8",
+    license="EUPL-1.2",
+    libraries=[cpplib, clib],
+    ext_package="fiftyone_devicedetection_onpremise",
+    ext_modules=[DeviceDetectionHashEngineModule],
+    py_modules=["fiftyone_devicedetection_onpremise"],
+    packages=["fiftyone_devicedetection_onpremise"],
+    package_dir={"": "src"},
+    install_requires=["fiftyone_devicedetection_shared", "fiftyone_pipeline_engines_fiftyone"],
+)

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/EngineBase.cpp

@@ -23,6 +23,7 @@
 #include "EngineBase.hpp"
 
 #include "fiftyone.h"
+#include "string_pp.hpp"
 
 using namespace FiftyoneDegrees::Common;
 
@@ -66,7 +67,7 @@ void EngineBase::initOverrideKeys(
 			if (overrideProperties->prefix == true) {
 				key.append("51D_");
 			}
-			tempKey = STRING(
+			tempKey = STRING( // name is string
 				overrideProperties->items[i].available->name.data.ptr);
 			if (tempKey != nullptr) {
 				key.append(tempKey);
@@ -79,7 +80,7 @@ void EngineBase::initOverrideKeys(
 			if (overrideProperties->prefix == true) {
 				key.append("51D_");
 			}
-			tempKey = STRING(
+			tempKey = STRING( // name is string
 				overrideProperties->items[i].available->name.data.ptr);
 			if (tempKey != nullptr) {
 				key.append(tempKey);
@@ -150,17 +151,39 @@ bool EngineBase::getIsThreadSafe() const {
 	return ThreadingGetIsThreadSafe();
 }
 
-void EngineBase::appendString(
+void EngineBase::appendValue(
 	stringstream &stream,
 	fiftyoneDegreesCollection *strings,
-	uint32_t offset) const {
+	uint32_t offset,
+	PropertyValueType storedValueType) const {
 	EXCEPTION_CREATE;
 	Item item;
 	DataReset(&item.data);
-	String *string = StringGet(strings, offset, &item, exception);
-	if (string != NULL && EXCEPTION_OKAY) {
-		stream << STRING(string);
+	const StoredBinaryValue * const binaryValue = StoredBinaryValueGet(
+		strings,
+		offset,
+		storedValueType,
+		&item,
+		exception);
+	if (binaryValue != nullptr && EXCEPTION_OKAY) {
+		writeStoredBinaryValueToStringStream(
+			binaryValue,
+			storedValueType,
+			stream,
+			MAX_DOUBLE_DECIMAL_PLACES,
+			exception);
 		COLLECTION_RELEASE(strings, &item);
 	}
 	EXCEPTION_THROW;
+}
+
+void EngineBase::appendString(
+	stringstream &stream,
+	fiftyoneDegreesCollection *strings,
+	uint32_t offset) const {
+	appendValue(
+		stream,
+		strings,
+		offset,
+		FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_STRING); // legacy contract
 }

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/EngineBase.hpp

@@ -275,6 +275,19 @@ namespace FiftyoneDegrees {
 			/** Keys which should be added to evidence. */
 			vector<string> keys;
 
+			/**
+			 * Gets a string from a strings collection, and appends to a stream.
+			 * @param stream to append the string to
+			 * @param strings collection to get the string from
+			 * @param offset of the string in the collection
+			 * @param storedValueType format of byte array representation.
+			 */
+			virtual void appendValue(
+				stringstream &stream,
+				fiftyoneDegreesCollection *strings,
+				uint32_t offset,
+				fiftyoneDegreesPropertyValueType storedValueType) const;
+
 			/**
 			 * Gets a string from a strings collection, and appends to a stream.
 			 * @param stream to append the string to

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/EntityMetaDataBuilder.hpp

@@ -26,7 +26,10 @@
 #include <string>
 #include "Exceptions.hpp"
 #include "collection.h"
+#include "constants.h"
+#include "storedBinaryValue.h"
 #include "string.h"
+#include "string_pp.hpp"
 
 
 using namespace FiftyoneDegrees;
@@ -57,23 +60,51 @@ namespace FiftyoneDegrees {
 			static string getString(
 				fiftyoneDegreesCollection *stringsCollection,
 				uint32_t offset) {
+				return getValue(
+					stringsCollection,
+					offset,
+					FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_STRING); // legacy contract
+			}
+
+			/**
+			 * Get a copy of a binary value (as string) from the strings collection at the offset
+			 * provided.
+			 * @param stringsCollection pointer to the collection to copy the
+			 * value (as string) from
+			 * @param offset offset in the strings collection of the binary value to
+			 * copy (as string)
+			 * @param storedValueType format of byte array representation.
+			 * @return string describing contents of binary value the offset provided
+			 */
+			static string getValue(
+				fiftyoneDegreesCollection *stringsCollection,
+				uint32_t offset,
+				fiftyoneDegreesPropertyValueType storedValueType) {
 				FIFTYONE_DEGREES_EXCEPTION_CREATE;
 				string result;
 				fiftyoneDegreesCollectionItem item;
-				fiftyoneDegreesString *str;
 				fiftyoneDegreesDataReset(&item.data);
-				str = fiftyoneDegreesStringGet(
+				const fiftyoneDegreesStoredBinaryValue * const binaryValue = fiftyoneDegreesStoredBinaryValueGet(
 					stringsCollection,
 					offset,
+					storedValueType,
 					&item,
 					exception);
 				FIFTYONE_DEGREES_EXCEPTION_THROW;
-					if (str != nullptr) {
-						result.append(&str->value);
-					}
-					FIFTYONE_DEGREES_COLLECTION_RELEASE(
-						stringsCollection,
-						&item);
+				if (binaryValue != nullptr) {
+					std::stringstream stream;
+					writeStoredBinaryValueToStringStream(
+						binaryValue,
+						storedValueType,
+						stream,
+						FIFTYONE_DEGREES_MAX_DOUBLE_DECIMAL_PLACES,
+						exception);
+					FIFTYONE_DEGREES_EXCEPTION_THROW;
+					result.append(stream.str());
+				}
+				FIFTYONE_DEGREES_COLLECTION_RELEASE(
+					stringsCollection,
+					&item);
 				return result;
 			}
 

fiftyone_devicedetection_onpremise-4.5.0a27/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/IpAddress.cpp

@@ -0,0 +1,85 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2025 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.
+ * ********************************************************************* */
+
+#include <cstring>
+#include <string>
+#include <stdexcept>
+#include "memory.h"
+#include "IpAddress.hpp"
+#include "Exceptions.hpp"
+#include "fiftyone.h"
+
+using namespace std;
+using namespace FiftyoneDegrees::IpIntelligence;
+
+FiftyoneDegrees::IpIntelligence::IpAddress::IpAddress() {
+    memset(this->ipAddress, 0, IPV6_LENGTH);
+    this->type = IP_TYPE_INVALID;
+}
+
+FiftyoneDegrees::IpIntelligence::IpAddress::IpAddress(
+    const unsigned char ipAddressData[],
+    IpType addressType) {
+    init(ipAddressData, addressType);
+}
+
+FiftyoneDegrees::IpIntelligence::IpAddress::IpAddress(
+    const char * const ipAddressString) {
+    ::IpAddress eIpAddress;
+    const bool parsed =
+		IpAddressParse(
+			ipAddressString,
+			ipAddressString + strlen(ipAddressString),
+			&eIpAddress);
+    // Make sure the ip address has been parsed successfully
+	if (!parsed) {
+		throw Common::StatusCodeException(INCORRECT_IP_ADDRESS_FORMAT);
+	}
+    // Initialize the IP address object
+    init(eIpAddress.value, static_cast<IpType>(eIpAddress.type));
+}
+
+void FiftyoneDegrees::IpIntelligence::IpAddress::init(
+    const unsigned char * const ipAddressData,
+    const IpType addressType) {
+    switch (addressType) {
+    case IP_TYPE_IPV4:
+        memcpy(ipAddress, ipAddressData, IPV4_LENGTH);
+        break;
+    case IP_TYPE_IPV6:
+        memcpy(ipAddress, ipAddressData, IPV6_LENGTH);
+        break;
+    default:
+        memset(ipAddress, 0, IPV6_LENGTH);
+        break;
+    }
+    type = addressType;
+}
+
+void FiftyoneDegrees::IpIntelligence::IpAddress::getCopyOfIpAddress(
+    unsigned char copy[], const uint32_t size) const {
+    const uint32_t dataSize = ((type == IP_TYPE_IPV4)
+        ? IPV4_LENGTH
+        : IPV6_LENGTH);
+	const uint32_t copySize = (size < dataSize) ? size : dataSize;
+	memcpy(copy, ipAddress, copySize);
+}

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/MetaData.cpp

@@ -21,8 +21,12 @@
  * ********************************************************************* */
 
 #include "MetaData.hpp"
+
+#include <sstream>
+
 #include "Exceptions.hpp"
 #include "fiftyone.h"
+#include "string_pp.hpp"
 
 using namespace FiftyoneDegrees::Common;
 
@@ -33,23 +37,30 @@ MetaData::MetaData(shared_ptr<fiftyoneDegreesResourceManager> manager) {
 MetaData::~MetaData() {
 }
 
-string MetaData::getString(
+string MetaData::getValue(
 	fiftyoneDegreesCollection *strings,
-	uint32_t offset) {
+	uint32_t offset,
+	fiftyoneDegreesPropertyValueType storedValueType) {
 	EXCEPTION_CREATE;
-	string result;
 	Item item;
-	String *str;
+	StoredBinaryValue *binaryValue;
 	DataReset(&item.data);
-	str = StringGet(
+	binaryValue = StoredBinaryValueGet(
 		strings,
 		offset,
+		storedValueType,
 		&item,
 		exception);
 	EXCEPTION_THROW;
-	if (str != nullptr) {
-		result.append(&str->value);
+	std::stringstream ss;
+	if (binaryValue != nullptr) {
+		writeStoredBinaryValueToStringStream(
+			binaryValue,
+			storedValueType,
+			ss,
+			(uint8_t)ss.precision(),
+			exception);
 	}
 	COLLECTION_RELEASE(strings, &item);
-	return result;
+	return ss.str();
 }

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/MetaData.hpp

@@ -225,16 +225,18 @@ namespace FiftyoneDegrees {
 			shared_ptr<fiftyoneDegreesResourceManager> manager;
 
 			/**
-			 * Get a string from the collection and copy it to a C++ string
+			 * Get a value from the collection and copy it as string to a C++ string
 			 * instance. This method releases the collection item before
 			 * returning.
 			 * @param strings pointer to the collection containing the string
 			 * @param offset of the string in the collection
-			 * @return copy of the requested string from the collection
+			 * @param storedValueType format of byte array representation.
+			 * @return copy of the requested value from the collection as string
 			 */
-			string getString(
+			string getValue(
 				fiftyoneDegreesCollection *strings,
-				uint32_t offset);
+				uint32_t offset,
+				fiftyoneDegreesPropertyValueType storedValueType);
 		};
 	}
 }

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/ResultsBase.cpp

@@ -62,7 +62,7 @@ string ResultsBase::getPropertyName(
 	const char *cName;
 	if (requiredPropertyIndex >= 0 &&
 		requiredPropertyIndex < (int)available->count) {
-		cName = STRING(PropertiesGetNameFromRequiredIndex(
+		cName = STRING(PropertiesGetNameFromRequiredIndex( // name is string
 			available,
 			requiredPropertyIndex));
 		if (cName != nullptr) {

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/collection.c

@@ -107,6 +107,7 @@ static void releaseCache(Item *item) {
 	if (item->handle != NULL) {
 		CacheRelease((CacheNode*)item->handle);
 		item->handle = NULL;
+		DataReset(&item->data); // data is not owned by the item
 	}
 }
 
@@ -1051,7 +1052,7 @@ static void* readFileVariable(
 
 		// Read the item header minus the last part of the structure 
 		// that may not always be included with every item.
-		if (fread(initial, initialSize, 1, handle->file) == 1) {
+		if ((!initialSize) || (fread(initial, initialSize, 1, handle->file) == 1)) {
 
 			// Calculate the number of bytes needed to store the item.
 			bytesNeeded = getFinalSize(initial);

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/component.c

@@ -55,11 +55,12 @@ fiftyoneDegreesString* fiftyoneDegreesComponentGetName(
 	fiftyoneDegreesComponent *component,
 	fiftyoneDegreesCollectionItem *item,
 	fiftyoneDegreesException *exception) {
-	return StringGet(
+	return &StoredBinaryValueGet(
 		stringsCollection, 
-		component->nameOffset, 
+		component->nameOffset,
+		FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_STRING, // name is string
 		item,
-		exception);
+		exception)->stringValue;
 }
 
 const fiftyoneDegreesComponentKeyValuePair* 

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a27}/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/constants.h

@@ -31,4 +31,14 @@
  */
 static const uint8_t fiftyoneDegreesIpAddressStringMaxLength = 50;
 
+/**
+ * The length for the buffer most WKT strings are expected to fit into.
+ */
+#define FIFTYONE_DEGREES_REASONABLE_WKT_STRING_LENGTH 128
+
+/**
+ * Max. number of decimal places to be printed for a double.
+ */
+#define FIFTYONE_DEGREES_MAX_DOUBLE_DECIMAL_PLACES 15
+
 #endif //FIFTYONE_DEGREES_CONSTANTS_H