feat(config): 优化配置文件加载逻辑,支持用户目录和系统目录 (NewFuture#468)

* feat(config): Optimize configuration file loading logic
当前目录 config.json
用户目录 ~/.ddns/config.json
系统目录 /etc/ddns/config.json

Author: NewFuture

_config.yml

@@ -1,4 +1,8 @@
 markdown: kramdown
+
+favicon: /doc/img/ddns.svg
+site_favicon: /doc/img/ddns.svg
+
 kramdown:
   parse_block_html: true
 

run.py

@@ -47,7 +47,7 @@ def get_ip(ip_type, index="default"):
         debug("get_ip(%s, %s)", ip_type, index)
         if index is False:  # disabled
             return False
-        elif isinstance(index, list):  # 如果获取到的规则是列表，则依次判断列表中每一个规则，直到找到一个可以正确获取到的IP
+        elif isinstance(index, list):  # 如果获取到的规则是列表，则依次判断列表中每一个规则，直到获取到IP
             for i in index:
                 value = get_ip(ip_type, i)
                 if value:
@@ -66,7 +66,7 @@ def get_ip(ip_type, index="default"):
         else:
             value = getattr(ip, index + "_v" + ip_type)()
     except Exception as e:
-        error(e)
+        error("Failed to get %s address: %s", ip_type, e)
     return value
 
 
@@ -81,7 +81,7 @@ def change_dns_record(dns, proxy_list, **kw):
         try:
             return dns.update_record(domain, kw['ip'], record_type=record_type)
         except Exception as e:
-            error(e)
+            error("Failed to update %s record for %s: %s", record_type, domain, e)
     return False
 
 
@@ -136,11 +136,11 @@ def main():
 
     info("DDNS[ %s ] run: %s %s", __version__, os_name, sys.platform)
     if get_config("config"):
-        info("loaded Config from: %s", path.abspath(get_config('config')))
+        info('loaded Config from: %s', path.abspath(get_config('config')))
 
     proxy = get_config('proxy') or 'DIRECT'
     proxy_list = proxy if isinstance(
-        proxy, list) else proxy.strip('; ').replace(',', ';').split(';')
+        proxy, list) else proxy.strip(';').replace(',', ';').split(';')
 
     cache_config = get_config('cache', True)
     if cache_config is False:
@@ -151,12 +151,12 @@ def main():
         cache = Cache(cache_config)
 
     if cache is False:
-        info("Cache is disabled!")
-    elif get_config("config_modified_time") is None or get_config("config_modified_time") >= cache.time:
-        warning("Cache file is out of dated.")
+        info('Cache is disabled!')
+    elif not get_config('config_modified_time') or get_config('config_modified_time') >= cache.time:
+        warning('Cache file is out of dated.')
         cache.clear()
     else:
-        debug("Cache is empty.")
+        debug('Cache is empty.')
     update_ip('4', cache, dns, proxy_list)
     update_ip('6', cache, dns, proxy_list)
 

util/config.py

@@ -2,11 +2,9 @@
 # -*- coding:utf-8 -*-
 from argparse import Action, ArgumentParser, Namespace, RawTextHelpFormatter
 from json import load as loadjson, dump as dumpjson
-from os import stat, environ
+from os import stat, environ, path
 from logging import error, getLevelName
 
-from time import time
-
 import sys
 
 
@@ -46,89 +44,77 @@ def init_config(description, doc, version):
                             epilog=doc, formatter_class=RawTextHelpFormatter)
     parser.add_argument('-v', '--version',
                         action='version', version=version)
-    parser.add_argument('-c', '--config', help="run with config file [配置文件路径]")
+    parser.add_argument('-c', '--config', help='run with config file [配置文件路径]')
 
     # 参数定义
-    parser.add_argument('--dns', help="DNS Provider [DNS服务提供商]", choices=[
+    parser.add_argument('--dns', help='DNS Provider [DNS服务提供商]', choices=[
                         'alidns', 'cloudflare', 'dnscom', 'dnspod', 'dnspod_com', 'he', 'huaweidns', 'callback'])
-    parser.add_argument('--id', help="api ID [授权账户]")
-    parser.add_argument('--token', help="api token or Secret key [授权访问凭证或密钥]")
-    parser.add_argument('--index4', nargs="*", action=ExtendAction,
-                        help="list to get ipv4 [IPV4 获取方式]")
-    parser.add_argument('--index6', nargs="*", action=ExtendAction,
-                        help="list to get ipv6 [IPV6获取方式]")
-    parser.add_argument('--ipv4', nargs="*", action=ExtendAction,
-                        help="ipv4 domain list [IPV4域名列表]")
-    parser.add_argument('--ipv6', nargs="*", action=ExtendAction,
-                        help="ipv6 domain list [IPV6域名列表]")
-    parser.add_argument('--ttl', type=int, help="ttl for DNS [DNS 解析 TTL 时间]")
-    parser.add_argument('--proxy', nargs="*", action=ExtendAction,
-                        help="https proxy [设置http 代理，多代理逐个尝试直到成功]")
+    parser.add_argument('--id', help='api ID [授权账户]')
+    parser.add_argument('--token', help='api token or Secret key [授权访问凭证或密钥]')
+    parser.add_argument('--index4', nargs='*', action=ExtendAction,
+                        help='list to get ipv4 [IPV4 获取方式]')
+    parser.add_argument('--index6', nargs='*', action=ExtendAction,
+                        help='list to get ipv6 [IPV6获取方式]')
+    parser.add_argument('--ipv4', nargs='*', action=ExtendAction,
+                        help='ipv4 domain list [IPV4域名列表]')
+    parser.add_argument('--ipv6', nargs='*', action=ExtendAction,
+                        help='ipv6 domain list [IPV6域名列表]')
+    parser.add_argument('--ttl', type=int, help='ttl for DNS [DNS 解析 TTL 时间]')
+    parser.add_argument('--proxy', nargs='*', action=ExtendAction,
+                        help='https proxy [设置http 代理，多代理逐个尝试直到成功]')
     parser.add_argument('--cache',  type=str2bool, nargs='?',
-                        const=True, help="cache flag [启用缓存，可配配置路径或开关]")
-    parser.add_argument('--log.file', metavar="LOG_FILE",
-                        help="log file [日志文件，默认标准输出]")
+                        const=True, help='cache flag [启用缓存，可配配置路径或开关]')
+    parser.add_argument('--log.file', metavar='LOG_FILE',
+                        help='log file [日志文件，默认标准输出]')
     parser.add_argument('--log.level', type=log_level,
-                        metavar="|".join(log_levels))
+                        metavar='|'.join(log_levels))
 
     __cli_args = parser.parse_args()
-    is_configfile_optional = get_config("token") or get_config("id")
+    is_configfile_required = not get_config("token") and not get_config("id")
     config_file = get_config("config")
-    if not is_configfile_optional or config_file is not None:
-        __load_config(config_file or "config.json", is_configfile_optional)
-        __cli_args.config = config_file or "config.json"
+    if not config_file:
+        # 未指定配置文件且需要读取文件时，依次查找
+        cfgs = [
+            path.abspath('config.json'),
+            path.expanduser('~/.ddns/config.json'),
+            '/etc/ddns/config.json'
+        ]
+        config_file = next((cfg for cfg in cfgs if path.isfile(cfg)), cfgs[0])
+
+    if path.isfile(config_file):
+        __load_config(config_file)
+        __cli_args.config = config_file
+    elif is_configfile_required:
+        error('Config file is required, but not found: %s', config_file)
+        # 如果需要配置文件但没有指定，则自动生成
+        if generate_config(config_file):
+            sys.stdout.write(
+                'Default configure file %s is generated.\n' % config_file)
+            sys.exit(1)
+        else:
+            sys.exit('fail to load config from file: %s\n' % config_file)
 
 
-def __load_config(path="config.json", skip_auto_generation=False):
+def __load_config(config_path):
     """
     加载配置
     """
     global __config
     try:
-        with open(path) as configfile:
+        with open(config_path, 'r') as configfile:
             __config = loadjson(configfile)
-            __config["config_modified_time"] = stat(path).st_mtime
+            __config["config_modified_time"] = stat(config_path).st_mtime
             if 'log' in __config:
                 if 'level' in __config['log'] and __config['log']['level'] is not None:
                     __config['log.level'] = log_level(__config['log']['level'])
                 if 'file' in __config['log']:
                     __config['log.file'] = __config['log']['file']
             elif 'log.level' in __config:
                 __config['log.level'] = log_level(__config['log.level'])
-    except IOError:
-        if skip_auto_generation:
-            __config["config_modified_time"] = time()
-            return
-        error(' Config file `%s` does not exist!' % path)
-        with open(path, 'w') as configfile:
-            configure = {
-                "$schema": "https://ddns.newfuture.cc/schema/v4.0.json",
-                "id": "YOUR ID or EMAIL for DNS Provider",
-                "token": "YOUR TOKEN or KEY for DNS Provider",
-                "dns": "dnspod",
-                "ipv4": [
-                    "newfuture.cc",
-                    "ddns.newfuture.cc"
-                ],
-                "ipv6": [
-                    "newfuture.cc",
-                    "ipv6.ddns.newfuture.cc"
-                ],
-                "index4": "default",
-                "index6": "default",
-                "ttl": None,
-                "proxy": None,
-                "log": {
-                    "level": "INFO",
-                    "file": None
-                }
-            }
-            dumpjson(configure, configfile, indent=2, sort_keys=True)
-            sys.stdout.write(
-                "New template configure file `%s` is generated.\n" % path)
-            sys.exit(1)
     except Exception as e:
-        sys.exit('fail to load config from file: %s\n%s' % (path, e))
+        error('Failed to load config file `%s`: %s', config_path, e)
+        raise
+        # 重新抛出异常
 
 
 def get_config(key, default=None):
@@ -167,3 +153,41 @@ def __call__(self, parser, namespace, values, option_string=None):
         else:
             items.append(values)
         setattr(namespace, self.dest, items)
+
+
+def generate_config(config_path):
+    """
+    生成配置文件
+    """
+    configure = {
+        '$schema': 'https://ddns.newfuture.cc/schema/v4.0.json',
+        'id': 'YOUR ID or EMAIL for DNS Provider',
+        'token': 'YOUR TOKEN or KEY for DNS Provider',
+        'dns': 'dnspod',
+        'ipv4': [
+            'newfuture.cc',
+            'ddns.newfuture.cc'
+        ],
+        'ipv6': [
+            'newfuture.cc',
+            'ipv6.ddns.newfuture.cc'
+        ],
+        'index4': 'default',
+        'index6': 'default',
+        'ttl': None,
+        'proxy': None,
+        'log': {
+            'level': 'INFO',
+            'file': None
+        }
+    }
+    try:
+        with open(config_path, 'w') as f:
+            dumpjson(configure, f, indent=2, sort_keys=True)
+            return True
+    except IOError:
+        error('Cannot open config file to write: `%s`!', config_path)
+        return False
+    except Exception as e:
+        error('Failed to write config file `%s`: %s', config_path, e)
+        return False