tagreader 6.0.3__tar.gz → 6.0.4__tar.gz

{tagreader-6.0.3 → tagreader-6.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: tagreader
-Version: 6.0.3
+Version: 6.0.4
 Summary: Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems.
 License: MIT
 Keywords: Aspen InfoPlus.21,OSIsoft PI
@@ -32,6 +32,7 @@ Requires-Dist: matplotlib (>=3.7.5,<4.0.0) ; extra == "notebooks"
 Requires-Dist: msal-bearer (>=1.3.0,<2.0.0)
 Requires-Dist: notebook (>=7.2.2,<8.0.0) ; extra == "notebooks"
 Requires-Dist: pandas (>=1)
+Requires-Dist: platformdirs (>=4.3.7,<5.0.0)
 Requires-Dist: pycryptodome (>=3.20.0,<4.0.0)
 Requires-Dist: requests (>=2,<3)
 Requires-Dist: requests-kerberos (>=0,<1)

{tagreader-6.0.3 → tagreader-6.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tagreader"
-version = "6.0.3"
+version = "6.0.4"
 description = "Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems."
 authors = ["Einar S. Idsø <eiids@equinor.com>", "Morten Dæhli Aslesen <masl@equinor.com"]
 license = "MIT"
@@ -39,6 +39,7 @@ matplotlib = { version = "^3.7.5", optional = true }
 diskcache = "^5.6.1"
 pycryptodome = "^3.20.0"
 requests-ntlm = ">=1.1,<=2.0"
+platformdirs = "^4.3.7"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3"

{tagreader-6.0.3 → tagreader-6.0.4}/tagreader/clients.py

@@ -1,4 +1,3 @@
-import os
 from datetime import datetime, timedelta, timezone, tzinfo
 from itertools import groupby
 from operator import itemgetter
@@ -16,9 +15,6 @@ from tagreader.utils import (
     ReaderType,
     convert_to_pydatetime,
     ensure_datetime_with_tz,
-    find_registry_key,
-    find_registry_key_from_name,
-    is_windows,
 )
 from tagreader.web_handlers import (
     AspenHandlerWeb,
@@ -119,83 +115,6 @@ def get_next_timeslice(
     return start, calc_end
 
 
-def get_server_address_aspen(datasource: str) -> Optional[Tuple[str, int]]:
-    """Data sources are listed under
-    HKEY_CURRENT_USER\\Software\\AspenTech\\ADSA\\Caches\\AspenADSA\\username.
-    For each data source there are multiple keys with Host entries. We start by
-    identifying the correct key to use by locating the UUID for Aspen SQLplus
-    services located under Aspen SQLplus service component. Then we find the
-    host and port based on the path above and the UUID.
-    """
-
-    # todo: is obsolete after removing ODBC
-
-    if not is_windows():
-        return None
-    import winreg
-
-    regkey_clsid = winreg.OpenKey(
-        winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\Classes\Wow6432Node\CLSID"
-    )
-    regkey, _ = find_registry_key_from_name(
-        regkey_clsid, "Aspen SQLplus service component"
-    )
-    regkey_implemented_categories = winreg.OpenKeyEx(regkey, "Implemented Categories")
-
-    _, aspen_uuid = find_registry_key_from_name(
-        regkey_implemented_categories, "Aspen SQLplus services"
-    )
-
-    reg_adsa = winreg.OpenKey(
-        winreg.HKEY_CURRENT_USER,
-        r"Software\AspenTech\ADSA\Caches\AspenADSA\\" + os.getlogin(),
-    )
-
-    try:
-        reg_site_key = winreg.OpenKey(reg_adsa, datasource + "\\" + aspen_uuid)
-        host = winreg.QueryValueEx(reg_site_key, "Host")[0]
-        port = int(winreg.QueryValueEx(reg_site_key, "Port")[0])
-        return host, port
-    except FileNotFoundError:
-        return None
-
-
-def get_server_address_pi(datasource: str) -> Optional[Tuple[str, int]]:
-    """
-    PI data sources are listed under
-    HKEY_LOCAL_MACHINE\\Software\\Wow6432Node\\PISystem\\PI-SDK\\x.x\\ServerHandles or
-    \\Software\\PISystem\\PI-SDK\\x.x\\ServerHandles.
-
-    :param datasource: Name of data source
-    :return: host, port
-    :type: tuple(string, int)
-    """
-    # todo: is obsolete after removing ODBC
-
-    if not is_windows():
-        return None
-    import winreg
-
-    try:
-        reg_key = winreg.OpenKey(
-            winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\Wow6432Node\PISystem\PI-SDK"
-        )
-        reg_key_handles = find_registry_key(reg_key, "ServerHandles")
-        reg_site_key = find_registry_key(reg_key_handles, datasource)
-        if reg_site_key is None:
-            reg_key = winreg.OpenKey(
-                winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\PISystem\PI-SDK"
-            )
-            reg_key_handles = find_registry_key(reg_key, "ServerHandles")
-            reg_site_key = find_registry_key(reg_key_handles, datasource)
-        if reg_site_key is not None:
-            host = winreg.QueryValueEx(reg_site_key, "path")[0]
-            port = int(winreg.QueryValueEx(reg_site_key, "port")[0])
-            return host, port
-    except FileNotFoundError:
-        return None
-
-
 def get_handler(
     imstype: Optional[IMSType],
     datasource: str,

{tagreader-6.0.3 → tagreader-6.0.4}/tagreader/utils.py

@@ -1,13 +1,18 @@
 import enum
+import hashlib
 import logging
 import platform
-import warnings
+import ssl
 from datetime import datetime, tzinfo
 from enum import Enum
+from pathlib import Path
 from typing import Union
 
+import certifi
 import pandas as pd
 import pytz
+import requests
+from platformdirs import user_data_dir
 
 from tagreader.logger import logger
 
@@ -27,47 +32,11 @@ def is_linux() -> bool:
 if is_windows():
     import winreg
 
-
 if is_mac():
     import socket
     import subprocess
 
 
-def find_registry_key(base_key, search_key_name: str):
-    search_key_name = search_key_name.lower()
-    if base_key is not None:
-        num_keys, _, _ = winreg.QueryInfoKey(base_key)
-        for i in range(0, num_keys):
-            key_name = winreg.EnumKey(base_key, i)
-            if key_name.lower() == search_key_name:
-                return winreg.OpenKey(base_key, key_name)
-            else:
-                key = find_registry_key(
-                    winreg.OpenKey(base_key, key_name), search_key_name
-                )
-            if key is not None:
-                return key
-    return None
-
-
-def find_registry_key_from_name(base_key, search_key_name: str):
-    search_key_name = search_key_name.lower()
-    num_keys, _, _ = winreg.QueryInfoKey(base_key)
-    key = key_string = None
-    for i in range(0, num_keys):
-        try:
-            key_string = winreg.EnumKey(base_key, i)
-            key = winreg.OpenKey(base_key, key_string)
-            _, num_vals, _ = winreg.QueryInfoKey(key)
-            if num_vals > 0:
-                (_, key_name, _) = winreg.EnumValue(key, 0)
-                if str(key_name).lower() == search_key_name:
-                    break
-        except Exception as err:
-            logging.error("{}: {}".format(i, err))
-    return key, key_string
-
-
 def convert_to_pydatetime(date_stamp: Union[datetime, str, pd.Timestamp]) -> datetime:
     if isinstance(date_stamp, datetime):
         return date_stamp
@@ -138,64 +107,82 @@ def add_equinor_root_certificate() -> bool:
     running on Equinor host.
 
     NB! This needs to be repeated after updating the cacert module.
-    NB! Will not download certificates.
 
     Returns:
         bool: True if function completes successfully
     """
-    import hashlib
-    import ssl
+    certificate = find_local_equinor_root_certificate()
 
-    import certifi
+    # If certificate is not found locally, we download it from the Equinor server
+    if certificate == "":
+        logger.debug(
+            "Unable to locate Equinor Root CA certificate on this host. Downloading from Equinor server."
+        )
+        response = requests.get("http://pki.equinor.com/aia/ecpr.crt")
 
-    EQUINOR_root_PEM_HASH = "5A206332CE73CED1D44C8A99C4C43B7CEE03DF5F"
-    ca_search = "Equinor Root CA"
+        if response.status_code != 200:
+            logger.error(
+                "Unable to find Equinor Root CA certificate locally and on Equinor server."
+            )
+            return False
 
-    found = False
-    der = None
+        certificate = response.text.replace("\r", "")
 
-    if is_linux():
+        # Write result to user data so we can read the cert from there next time
+        filepath = Path(user_data_dir("tagreader")) / "equinor_root_ca.crt"
+        try:
+            filepath.parent.mkdir(parents=True, exist_ok=True)
+            filepath.write_text(certificate)
+            logger.debug("Equinor Root CA certificate written to cache")
+        except Exception as e:
+            logger.debug(f"Failed to write Equinor Root CA certificate to cache: {e}")
+
+    if certificate in certifi.contents():
+        logger.debug("Equinor Root Certificate already exists in certifi store")
         return True
-    elif is_windows():
-        logger.debug("Scanning CA certificate in Windows cert store", end="")
+
+    ca_file = certifi.where()
+    with open(ca_file, "ab") as f:
+        f.write(bytes(certificate, "ascii"))
+    logger.debug("Equinor Root Certificate added to certifi store")
+
+
+def find_local_equinor_root_certificate() -> str:
+    equinor_root_pem_hash = "5A206332CE73CED1D44C8A99C4C43B7CEE03DF5F"
+    ca_search = "Equinor Root CA"
+
+    if is_windows():
+        logger.debug("Checking for Equinor Root CA in Windows certificate store")
         for cert in ssl.enum_certificates("CA"):
-            der = cert[0]
+            found_cert = cert[0]
             # deepcode ignore InsecureHash: <Only hashes to compare with known hash>
-            if hashlib.sha1(der).hexdigest().upper() == EQUINOR_root_PEM_HASH:
-                found = True
-                logger.debug("CA certificate found!")
-                break
+            if hashlib.sha1(found_cert).hexdigest().upper() == equinor_root_pem_hash:
+                return ssl.DER_cert_to_PEM_cert(found_cert)
+
     elif is_mac():
+        logger.debug("Checking for Equinor Root CA in MacOS certificate store")
         macos_ca_certs = subprocess.run(
             ["security", "find-certificate", "-a", "-c", ca_search, "-Z"],
             stdout=subprocess.PIPE,
         ).stdout
 
-        if EQUINOR_root_PEM_HASH in str(macos_ca_certs).upper():
+        if equinor_root_pem_hash in str(macos_ca_certs).upper():
             c = get_macos_equinor_certificates()
             for cert in c:
                 # deepcode ignore InsecureHash: <Only hashes to compare with known hash>
-                if hashlib.sha1(cert).hexdigest().upper() == EQUINOR_root_PEM_HASH:
-                    der = cert
-                    found = True
-                    break
-
-    if found and der:
-        pem = ssl.DER_cert_to_PEM_cert(der)
-        if pem in certifi.contents():
-            logger.debug(
-                "CA Certificate already exists in certifi store. Nothing to do."
-            )
-        else:
-            logger.debug("Writing certificate to certifi store.")
-            ca_file = certifi.where()
-            with open(ca_file, "ab") as f:
-                f.write(bytes(pem, "ascii"))
-            logger.debug("Completed")
-    else:
-        warnings.warn("Unable to locate root certificate on this host.")
+                if hashlib.sha1(cert).hexdigest().upper() == equinor_root_pem_hash:
+                    return ssl.DER_cert_to_PEM_cert(cert)
+
+    # If the certificate is not found in the local cert store, look in the tagreader cache
+    filepath = Path(user_data_dir("tagreader")) / "equinor_root_ca.crt"
+
+    try:
+        if filepath.exists():
+            return filepath.read_text()
+    except Exception as e:
+        logger.debug(f"Failed to read Equinor Root CA certificate from cache: {e}")
 
-    return found
+    return ""
 
 
 def get_macos_equinor_certificates():

{tagreader-6.0.3 → tagreader-6.0.4}/tagreader/web_handlers.py

@@ -19,7 +19,7 @@ from urllib3.exceptions import InsecureRequestWarning
 
 from tagreader.cache import BucketCache, SmartCache
 from tagreader.logger import logger
-from tagreader.utils import IMSType, ReaderType, is_mac, is_windows, urljoin
+from tagreader.utils import ReaderType, is_mac, is_windows, urljoin
 
 
 class MD4:
@@ -258,11 +258,6 @@ class AspenHandlerWeb(BaseHandlerWeb):
         self._max_rows = options.get("max_rows", 100000)
         self._connection_string = ""  # Used for raw SQL queries
 
-    @staticmethod
-    def generate_connection_string(host, *_, **__):
-        # todo: is obsolete after removing ODBC
-        raise NotImplementedError
-
     @staticmethod
     def generate_search_query(
         tag: Optional[str],
@@ -670,27 +665,6 @@ class AspenHandlerWeb(BaseHandlerWeb):
         connection_string += f"<![CDATA[{query}]]></SQL>"
         return connection_string
 
-    def initialize_connection_string(
-        # todo: is obsolete after removing ODBC
-        self,
-        host: Optional[str] = None,
-        port: int = 10014,
-        connection_string: Optional[str] = None,
-    ):
-        # todo: is obsolete after removing ODBC
-        if connection_string:
-            self._connection_string = connection_string
-        else:
-            if host is None:
-                from tagreader.clients import get_server_address_aspen
-
-                host = get_server_address_aspen(self.datasource)
-            self._connection_string = (
-                f"DRIVER=AspenTech SQLPlus;HOST={host};"
-                f"PORT={port};CHARINT=N;CHARFLOAT=N;"
-                "CHARTIME=N;CONVERTERRORS=N"
-            )
-
     def query_sql(self, query: str, parse: bool = True) -> Union[str, pd.DataFrame]:
         url = urljoin(self.base_url, "SQL")
         if self._connection_string is None:
@@ -758,11 +732,6 @@ class PIHandlerWeb(BaseHandlerWeb):
     def _time_to_UTC_string(time: datetime) -> str:
         return time.astimezone(pytz.UTC).strftime("%d-%b-%y %H:%M:%S")
 
-    @staticmethod
-    def generate_connection_string(host, *_, **__):
-        # todo: is obsolete after removing ODBC
-        raise NotImplementedError
-
     @staticmethod
     def escape(s: str) -> str:
         # https://techsupport.osisoft.com/Documentation/PI-Web-API/help/topics/search-queries.html