Merge branch 'dev' into 'master'

Dev

See merge request server/openapi/openapi-python-sdk!156

Author: tigersk

.gitignore

@@ -139,3 +139,4 @@ cython_debug/
 
 .idea
 .DS_Store
+*.properties

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.3.0 (2023-02-16)
+### New
+- 支持配置文件
+- 支持2FA token
+
+
 ## 2.2.9 (2023-02-09)
 ### Fix
 - 修复tick数据推送报错的问题

requirements.txt

@@ -8,4 +8,5 @@ rsa
 stomp.py
 getmac
 cryptography
-backoff
+backoff
+jproperties

tigeropen/__init__.py

@@ -4,4 +4,4 @@
 
 @author: gaoan
 """
-__VERSION__ = '2.2.9'
+__VERSION__ = '2.3.0'

tigeropen/common/consts/service_types.py

@@ -4,7 +4,9 @@
 
 @author: gaoan
 """
+USER_TOKEN_REFRESH = "user_token_refresh"
 
+# 订单
 ORDER_NO = "order_no"
 PREVIEW_ORDER = "preview_order"
 PLACE_ORDER = "place_order"

tigeropen/common/util/web_utils.py

@@ -69,11 +69,13 @@ def do_request(method, url, query_string=None, headers=None, params=None, timeou
         connection.connect()
     except Exception as e:
         raise RequestException('[' + THREAD_LOCAL.uuid + ']' + method + ' connect failed. url: ' + url
+                               + ' headers: ' + str(headers)
                                + ' params: ' + str(params) + ' detail: ' + str(e))
     try:
         connection.request(method, url, body=json.dumps(params), headers=headers)
     except Exception as e:
         raise RequestException('[' + THREAD_LOCAL.uuid + ']' + method + ' request failed. url: ' + url
+                               + ' headers: ' + str(headers)
                                + ' params: ' + str(params) + ' detail: ' + str(e))
     response = connection.getresponse()
     result = response.read()
@@ -82,7 +84,8 @@ def do_request(method, url, query_string=None, headers=None, params=None, timeou
         if charset:
             result = result.decode(charset)
         raise ResponseException('[' + THREAD_LOCAL.uuid + ']invalid http status ' + str(response.status) +
-                                ',detail body:' + result + ' params: ' + str(params))
+                                ' headers: ' + str(headers) +
+                                ' detail body:' + result + ' params: ' + str(params))
     try:
         response.close()
         connection.close()

tigeropen/tiger_open_client.py

@@ -8,14 +8,16 @@
 import json
 import logging
 import uuid
+from threading import Timer
 
 import backoff
 
 from tigeropen import __VERSION__
 from tigeropen.common.consts import OPEN_API_SERVICE_VERSION, THREAD_LOCAL
 from tigeropen.common.consts.params import P_TIMESTAMP, P_TIGER_ID, P_METHOD, P_CHARSET, P_VERSION, P_SIGN_TYPE, \
     P_DEVICE_ID, P_NOTIFY_URL, COMMON_PARAM_KEYS, P_SIGN
-from tigeropen.common.consts.service_types import USER_LICENSE, PLACE_ORDER, CANCEL_ORDER, MODIFY_ORDER
+from tigeropen.common.consts.service_types import USER_LICENSE, PLACE_ORDER, CANCEL_ORDER, MODIFY_ORDER, \
+    USER_TOKEN_REFRESH
 from tigeropen.common.exceptions import ResponseException, RequestException
 from tigeropen.common.request import OpenApiRequest
 from tigeropen.common.response import TigerResponse
@@ -33,14 +35,21 @@ def get_mac_address():
 SKIP_RETRY_SERVICES = {PLACE_ORDER, CANCEL_ORDER, MODIFY_ORDER}
 
 
+_SCHEDULE_STATE = {'is_running': False}
+TOKEN_CHECK_INTERVAL = 300
+
+
 class TigerOpenClient:
     """
     client_config：客户端配置，包含tiger_id、应用私钥、老虎公钥等
     logger：日志对象，客户端执行信息会通过此日志对象输出
     """
-
     def __init__(self, client_config, logger=None):
         self.__config = client_config
+        if not client_config.private_key:
+            raise Exception('private key can not be empty')
+        if not client_config.tiger_id:
+            raise Exception('tiger id can not be empty')
         if logger:
             if client_config.log_level:
                 logger.setLevel(logging.getLevelName(client_config.log_level))
@@ -58,6 +67,8 @@ def __init__(self, client_config, logger=None):
         self.__device_id = self.__get_device_id()
         self.__init_license()
         self.__refresh_server_info()
+        if self.__config.token and self.__config.license:
+            self.__schedule_thread()
 
     def __init_license(self):
         if self.__config.license is None and self.__config.enable_dynamic_domain:
@@ -156,6 +167,9 @@ def __parse_response(self, response_str, timestamp=None):
 
         return response_content
 
+    def _update_header(self):
+        self.__headers['Authorization'] = self.__config.token
+
     def _get_retry_deco(self, service):
         if service not in SKIP_RETRY_SERVICES and self.__config.retry_max_tries > 0:
             return backoff.on_exception(backoff.fibo,
@@ -169,6 +183,8 @@ def _get_retry_deco(self, service):
     执行接口请求
     """
     def execute(self, request, url=None):
+        if self.__config.token:
+            self._update_header()
         if url is None:
             url = self.__config.server_url
         THREAD_LOCAL.uuid = str(uuid.uuid1())
@@ -198,3 +214,42 @@ def query_license(self):
             if response.is_success():
                 return json.loads(response.data).get('license')
         self.__logger.error(f"failed to query license, response: {response_content}")
+
+    def refresh_token(self):
+        request = OpenApiRequest(method=USER_TOKEN_REFRESH)
+
+        response_content = None
+        try:
+            response_content = self.execute(request)
+        except Exception as e:
+            self.__logger.error(e, exc_info=True)
+        if response_content:
+            response = TigerResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return json.loads(response.data).get('token')
+        self.__logger.error(f"failed to refresh token, response: {response_content}")
+        return None
+
+    def token_refresh_task(self):
+        try:
+            if self.__config.should_token_refresh():
+                new_token = self.refresh_token()
+                if new_token:
+                    self.__logger.info(f"refresh token, old:{self.__config.token}, new:{new_token}")
+                    self.__config.load_or_store_token(new_token)
+        except Exception as e:
+            self.__logger.error(e, exc_info=True)
+
+    def __schedule_thread(self):
+        if not _SCHEDULE_STATE['is_running']:
+            _SCHEDULE_STATE['is_running'] = True
+            self.__logger.info('Starting schedule thread...')
+            daemon = RepeatTimer(TOKEN_CHECK_INTERVAL, self.token_refresh_task)
+            daemon.start()
+
+
+class RepeatTimer(Timer):
+    def run(self):
+        while not self.finished.wait(self.interval):
+            self.function(*self.args, **self.kwargs)

tigeropen/tiger_open_config.py

@@ -4,9 +4,13 @@
 
 @author: gaoan
 """
+import base64
 import json
 import logging
+import os
+import time
 
+from jproperties import Properties
 from pytz import timezone
 from tigeropen.common.consts import Language, ServiceType
 from tigeropen.common.util.account_util import AccountUtil
@@ -47,9 +51,13 @@
                            'MidihTvHHf+tJ0PYD0o3PruI0hl3qhEjHTAxb75T5YD3SGK4IBhHn/Rk6mhqlGgI+bBrBVYaXixm' \
                            'HfRo75RpUUuWACyeqQkZckgR0McxuW9xRMIa2cXZOoL1E4SL4lXKGhKoWbwIDAQAB'
 
+DEFAULT_PROPS_FILE = 'tiger_openapi_config.properties'
+DEFAULT_TOKEN_FILE = 'tiger_openapi_token.properties'
+TOKEN_REFRESH_DURATION = 24 * 60 * 60  # seconds
+
 
 class TigerOpenClientConfig:
-    def __init__(self, sandbox_debug=False, enable_dynamic_domain=True):
+    def __init__(self, sandbox_debug=None, enable_dynamic_domain=True, props_path='.'):
         # 开发者应用id
         self._tiger_id = ''
         # 授权账户
@@ -80,23 +88,27 @@ def __init__(self, sandbox_debug=False, enable_dynamic_domain=True):
         self._server_url = SERVER_URL
         self._quote_server_url = SERVER_URL
         self._socket_host_port = SOCKET_HOST_PORT
-        if sandbox_debug:
+
+        self.log_level = None
+        self.log_path = None
+        self.retry_max_time = 60
+        self.retry_max_tries = 5
+        self.props_path = props_path
+        self.token = None
+        self._load_props()
+        self.load_or_store_token()
+
+        self.domain_conf = dict()
+        self.enable_dynamic_domain = enable_dynamic_domain
+        if self._sandbox_debug:
             self._tiger_public_key = SANDBOX_TIGER_PUBLIC_KEY
             self._server_url = SANDBOX_SERVER_URL
             self._quote_server_url = SANDBOX_SERVER_URL
             self._socket_host_port = SANDBOX_SOCKET_HOST_PORT
-
-        self.domain_conf = dict()
-        self.enable_dynamic_domain = enable_dynamic_domain
-        if enable_dynamic_domain:
+        if self.enable_dynamic_domain:
             self.domain_conf = self.query_domains()
             self.refresh_server_info()
 
-        self.log_level = None
-        self.log_path = None
-        self.retry_max_time = 60
-        self.retry_max_tries = 5
-
     @property
     def tiger_id(self):
         return self._tiger_id
@@ -221,6 +233,70 @@ def secret_key(self):
     def secret_key(self, value):
         self._secret_key = value
 
+    @property
+    def token(self):
+        return self._token
+
+    @token.setter
+    def token(self, value):
+        self._token = value
+
+    def _get_props_path(self, filename):
+        if self.props_path is not None:
+            if os.path.isdir(self.props_path):
+                full_path = os.path.join(self.props_path, filename)
+            else:
+                dirname = os.path.dirname(self.props_path)
+                full_path = os.path.join(dirname, filename)
+            return full_path
+        return None
+
+    def _load_props(self):
+        full_path = self._get_props_path(DEFAULT_PROPS_FILE)
+        if full_path and os.path.exists(full_path):
+            try:
+                p = Properties()
+                with open(full_path, "rb") as f:
+                    p.load(f, "utf-8")
+                    if not self.tiger_id:
+                        self.tiger_id = getattr(p.get('tiger_id'), 'data', '')
+                    if not self.private_key:
+                        self.private_key = getattr(p.get('private_key_pk1'), 'data', '')
+                    if not self.account:
+                        self.account = getattr(p.get('account'), 'data', '')
+                    if not self.license:
+                        self.license = getattr(p.get('license'), 'data', '')
+                    if not self._sandbox_debug:
+                        is_sandbox_env = getattr(p.get('env'), 'data', '').upper() == 'SANDBOX'
+                        self._sandbox_debug = is_sandbox_env
+            except Exception as e:
+                logging.error(e, exc_info=True)
+
+    def load_or_store_token(self, token=None):
+        full_path = self._get_props_path(DEFAULT_TOKEN_FILE)
+        if full_path and os.path.exists(full_path):
+            try:
+                p = Properties()
+                with open(full_path, "r+b") as f:
+                    if token:
+                        self.token = token
+                        p['token'] = token
+                        p.store(f, encoding='utf-8')
+                    else:
+                        p.load(f, "utf-8")
+                        if not self.token:
+                            self.token = getattr(p.get('token'), 'data', '')
+            except Exception as e:
+                logging.error(e, exc_info=True)
+
+    def should_token_refresh(self, duration=TOKEN_REFRESH_DURATION):
+        if self.token:
+            tokeninfo = base64.b64decode(self.token)
+            gen_ts, expire_ts = tokeninfo[:27].decode('utf-8').split(',')
+            if (int(time.time()) - int(gen_ts) // 1000) > duration:
+                return True
+            return False
+
     def refresh_server_info(self):
         if self.enable_dynamic_domain and self.domain_conf:
             if self.license: