token file

Author: tigersk

CHANGELOG.md

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

tigeropen/__init__.py

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

tigeropen/tiger_open_client.py

@@ -8,6 +8,7 @@
 import json
 import logging
 import uuid
+from threading import Timer
 
 import backoff
 
@@ -34,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))
@@ -59,7 +67,8 @@ def __init__(self, client_config, logger=None):
         self.__device_id = self.__get_device_id()
         self.__init_license()
         self.__refresh_server_info()
-        self.__refresh_token()
+        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:
@@ -174,7 +183,8 @@ def _get_retry_deco(self, service):
     执行接口请求
     """
     def execute(self, request, url=None):
-        self._update_header()
+        if self.__config.token:
+            self._update_header()
         if url is None:
             url = self.__config.server_url
         THREAD_LOCAL.uuid = str(uuid.uuid1())
@@ -205,7 +215,7 @@ def query_license(self):
                 return json.loads(response.data).get('license')
         self.__logger.error(f"failed to query license, response: {response_content}")
 
-    def __refresh_token(self):
+    def refresh_token(self):
         request = OpenApiRequest(method=USER_TOKEN_REFRESH)
 
         response_content = None
@@ -219,4 +229,27 @@ def __refresh_token(self):
             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,11 @@
 
 @author: gaoan
 """
+import base64
 import json
 import logging
 import os
+import time
 
 from jproperties import Properties
 from pytz import timezone
@@ -51,10 +53,11 @@
 
 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, props_path='.'):
+    def __init__(self, sandbox_debug=None, enable_dynamic_domain=True, props_path='.'):
         # 开发者应用id
         self._tiger_id = ''
         # 授权账户
@@ -85,11 +88,6 @@ def __init__(self, sandbox_debug=False, enable_dynamic_domain=True, props_path='
         self._server_url = SERVER_URL
         self._quote_server_url = SERVER_URL
         self._socket_host_port = SOCKET_HOST_PORT
-        if 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.log_level = None
         self.log_path = None
@@ -98,11 +96,16 @@ def __init__(self, sandbox_debug=False, enable_dynamic_domain=True, props_path='
         self.props_path = props_path
         self.token = None
         self._load_props()
-        self._load_token()
+        self.load_or_store_token()
 
         self.domain_conf = dict()
         self.enable_dynamic_domain = enable_dynamic_domain
-        if 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
+        if self.enable_dynamic_domain:
             self.domain_conf = self.query_domains()
             self.refresh_server_info()
 
@@ -239,11 +242,12 @@ def token(self, value):
         self._token = value
 
     def _get_props_path(self, filename):
-        if self.props_path is not None and os.path.exists(self.props_path):
+        if self.props_path is not None:
             if os.path.isdir(self.props_path):
                 full_path = os.path.join(self.props_path, filename)
             else:
-                full_path = self.props_path
+                dirname = os.path.dirname(self.props_path)
+                full_path = os.path.join(dirname, filename)
             return full_path
         return None
 
@@ -262,21 +266,37 @@ def _load_props(self):
                         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_token(self):
+    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:
-                    p.load(f, "utf-8")
-                    if not self.token:
-                        self.token = getattr(p.get('token'), 'data', '')
+                    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: