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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiftyone_devicedetection_onpremise
-Version: 4.5.0a25
+Version: 4.5.0a26
 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.0a26/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.0a26/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.0a26/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/coordinate.c

@@ -0,0 +1,41 @@
+/* *********************************************************************
+ * 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.
+ * ********************************************************************* */
+
+#include "float.h"
+#include "string.h"
+#include "status.h"
+#include "coordinate.h"
+
+fiftyoneDegreesCoordinate fiftyoneDegreesIpiGetCoordinate(
+	const fiftyoneDegreesCollectionItem *item,
+	fiftyoneDegreesException *exception) {
+	fiftyoneDegreesString *value = (fiftyoneDegreesString *)item->data.ptr;
+	fiftyoneDegreesCoordinate coordinate = { 0, 0 };
+	if (value->value == FIFTYONE_DEGREES_STRING_COORDINATE) {
+		coordinate.lat = FIFTYONE_DEGREES_FLOAT_TO_NATIVE(value->trail.coordinate.lat);
+		coordinate.lon = FIFTYONE_DEGREES_FLOAT_TO_NATIVE(value->trail.coordinate.lon);
+	}
+	else {
+		FIFTYONE_DEGREES_EXCEPTION_SET(FIFTYONE_DEGREES_STATUS_CORRUPT_DATA);
+	}
+	return coordinate;
+}

fiftyone_devicedetection_onpremise-4.5.0a26/src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/wkbtot.cpp

@@ -0,0 +1,88 @@
+/* *********************************************************************
+ * 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 "wkbtot.hpp"
+
+#include <memory>
+
+#include "fiftyone.h"
+
+namespace FiftyoneDegrees::Common {
+    /**
+     * The length for the buffer most WKT strings are expected to fit into.
+     */
+    static constexpr size_t reasonableWktStringLength = 128;
+
+    WkbtotResult writeWkbStringToStringStream(
+        const String * const wkbString,
+        std::stringstream &stream,
+        const uint8_t decimalPlaces,
+        Exception * const exception) {
+
+        WkbtotResult toWktResult = {
+            0,
+            false,
+        };
+
+        if (!wkbString || !exception) {
+            EXCEPTION_SET(FIFTYONE_DEGREES_STATUS_NULL_POINTER);
+            return toWktResult;
+        }
+        const auto * const wkbBytes = FIFTYONE_DEGREES_WKB(wkbString);
+        if (!wkbBytes) {
+            EXCEPTION_SET(FIFTYONE_DEGREES_STATUS_INVALID_INPUT);
+            return toWktResult;
+        }
+
+        {
+            char buffer[reasonableWktStringLength];
+            toWktResult = ConvertWkbToWkt(
+                wkbBytes,
+                buffer,
+                reasonableWktStringLength,
+                decimalPlaces,
+                exception
+                );
+            if (EXCEPTION_OKAY && !toWktResult.bufferTooSmall) {
+                stream << buffer;
+                return toWktResult;
+            }
+        }
+        if (toWktResult.bufferTooSmall) {
+            EXCEPTION_CLEAR;
+            const size_t requiredSize = toWktResult.written + 1;
+            const std::unique_ptr<char[]> buffer = std::make_unique<char[]>(requiredSize);
+            toWktResult = fiftyoneDegreesConvertWkbToWkt(
+                wkbBytes,
+                buffer.get(),
+                requiredSize,
+                decimalPlaces,
+                exception
+                );
+            if (EXCEPTION_OKAY && !toWktResult.bufferTooSmall) {
+                stream << buffer.get();
+                return toWktResult;
+            }
+        }
+        return toWktResult;
+    }
+}

fiftyone_devicedetection_onpremise-4.5.0a26/src/fiftyone_devicedetection_onpremise/cxx/src/hash/ResultsHashSerializer.cpp

@@ -0,0 +1,61 @@
+/* *********************************************************************
+ * 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.
+ * ********************************************************************* */
+
+#include "../../src/common-cxx/Exceptions.hpp"
+#include "ResultsHashSerializer.hpp"
+#include <algorithm>
+
+using namespace FiftyoneDegrees::DeviceDetection::Hash;
+ResultsHashSerializer::ResultsHashSerializer(size_t bufferSize): bufferSize(bufferSize) {
+    realloc();
+}
+
+void ResultsHashSerializer::realloc() {
+    // note even if bufferSize = 0 unique_ptr will hold a past-the-end object pointer
+    buffer = std::make_unique<char[]>(bufferSize);
+}
+
+std::string ResultsHashSerializer::allValuesJson(ResultsHash *results) {
+    FIFTYONE_DEGREES_EXCEPTION_CREATE;
+    // a loop is needed to ensure we reallocate the buffer if it was too small to hold the whole JSON output
+    // a precondition check is needed to not dereference a null pointer
+    while(results && results->results && buffer) {
+        size_t written = fiftyoneDegreesResultsHashGetValuesJson(results->results, buffer.get(), bufferSize, exception);
+        // nothing has been written, something went wrong
+        if (written <= 0) break;
+        if (written <= bufferSize) {
+            // happy path
+            // remove the \0 in the end otherwise it will appear as an escaped character
+            return string(buffer.get(), written - 1);
+        } else {
+            // increase the buffer size and retry on the next iteration of the loop
+            bufferSize = std::max<size_t>(bufferSize * 2, written);
+            try {
+                realloc();
+            } catch (const std::bad_alloc &) { 
+                // reallocation failed - we just exit this loop
+                break;
+            }
+        }
+    }
+    return "";
+}

{fiftyone_devicedetection_onpremise-4.5.0a25 → fiftyone_devicedetection_onpremise-4.5.0a26}/src/fiftyone_devicedetection_onpremise.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiftyone-devicedetection-onpremise
-Version: 4.5.0a25
+Version: 4.5.0a26
 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.0a25 → fiftyone_devicedetection_onpremise-4.5.0a26}/src/fiftyone_devicedetection_onpremise.egg-info/SOURCES.txt

@@ -69,6 +69,7 @@ src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/Exceptions.cpp
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/Exceptions.hpp
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/Exceptions.i
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/FiftyoneDegrees.hpp
+src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/IpAddress.cpp
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/IpAddress.hpp
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/IpAddress.i
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/JavaTypes.i
@@ -106,6 +107,7 @@ src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/component.c
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/component.h
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/config.h
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/constants.h
+src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/coordinate.c
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/coordinate.h
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/data.c
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/data.h
@@ -165,6 +167,7 @@ src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/tree.h
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/value.c
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/value.h
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/wkbtot.c
+src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/wkbtot.cpp
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/wkbtot.h
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/wkbtot.hpp
 src/fiftyone_devicedetection_onpremise/cxx/src/common-cxx/yamlfile.c
@@ -207,6 +210,7 @@ src/fiftyone_devicedetection_onpremise/cxx/src/hash/PropertyMetaDataCollectionHa
 src/fiftyone_devicedetection_onpremise/cxx/src/hash/ResultsHash.cpp
 src/fiftyone_devicedetection_onpremise/cxx/src/hash/ResultsHash.hpp
 src/fiftyone_devicedetection_onpremise/cxx/src/hash/ResultsHash.i
+src/fiftyone_devicedetection_onpremise/cxx/src/hash/ResultsHashSerializer.cpp
 src/fiftyone_devicedetection_onpremise/cxx/src/hash/ResultsHashSerializer.hpp
 src/fiftyone_devicedetection_onpremise/cxx/src/hash/ResultsHashSerializer.i
 src/fiftyone_devicedetection_onpremise/cxx/src/hash/ValueMetaDataBuilderHash.cpp

fiftyone_devicedetection_onpremise-4.5.0a26/version.txt

@@ -0,0 +1 @@
+4.5.0-alpha.26