ddns 3.1.5__py2.py3-none-any.whl → 4.0.0__py2.py3-none-any.whl

ddns/util/config.py

@@ -0,0 +1,317 @@
+# -*- coding:utf-8 -*-
+from argparse import Action, ArgumentParser, Namespace, RawTextHelpFormatter
+from json import load as loadjson, dump as dumpjson
+from os import stat, environ, path
+from logging import critical, error, getLevelName
+from ast import literal_eval
+
+import platform
+import sys
+
+
+__cli_args = Namespace()
+__config = {}  # type: dict
+log_levels = [
+    "CRITICAL",  # 50
+    "ERROR",  # 40
+    "WARNING",  # 30
+    "INFO",  # 20
+    "DEBUG",  # 10
+    "NOTSET",  # 0
+]
+
+# 支持数组的参数列表
+ARRAY_PARAMS = ["index4", "index6", "ipv4", "ipv6", "proxy"]
+# 简单数组，支持’,’, ‘;’ 分隔的参数列表
+SIMPLE_ARRAY_PARAMS = ["ipv4", "ipv6", "proxy"]
+
+
+def str2bool(v):
+    """
+    parse string to boolean
+    """
+    if isinstance(v, bool):
+        return v
+    if v.lower() in ("yes", "true", "t", "y", "1"):
+        return True
+    elif v.lower() in ("no", "false", "f", "n", "0"):
+        return False
+    else:
+        return v
+
+
+def log_level(value):
+    """
+    parse string to log level
+    or getattr(logging, value.upper())
+    """
+    return getLevelName(value.upper())
+
+
+def parse_array_string(value, enable_simple_split):
+    """
+    解析数组字符串
+    仅当 trim 之后以 '[' 开头以 ']' 结尾时，才尝试使用 ast.literal_eval 解析
+    默认返回原始字符串
+    """
+    if not isinstance(value, str):
+        return value
+
+    trimmed = value.strip()
+    if trimmed.startswith("[") and trimmed.endswith("]"):
+        try:
+            # 尝试使用 ast.literal_eval 解析数组
+            parsed_value = literal_eval(trimmed)
+            # 确保解析结果是列表或元组
+            if isinstance(parsed_value, (list, tuple)):
+                return list(parsed_value)
+        except (ValueError, SyntaxError) as e:
+            # 解析失败时返回原始字符串
+            error("Failed to parse array string: %s. Exception: %s", value, e)
+    elif enable_simple_split:
+        # 尝试使用逗号或分号分隔符解析
+        sep = None
+        if ',' in trimmed:
+            sep = ','
+        elif ';' in trimmed:
+            sep = ';'
+        if sep:
+            return [item.strip() for item in trimmed.split(sep) if item.strip()]
+    return value
+
+
+def get_system_info_str():
+    system = platform.system()
+    release = platform.release()
+    machine = platform.machine()
+    arch = platform.architecture()[0]  # '64bit' or '32bit'
+
+    return "{}-{} {} ({})".format(system, release, machine, arch)
+
+
+def get_python_info_str():
+    version = platform.python_version()
+    branch, py_build_date = platform.python_build()
+    return "Python-{} {} ({})".format(version, branch, py_build_date)
+
+
+def init_config(description, doc, version, date):
+    """
+    配置
+    """
+    global __cli_args
+    parser = ArgumentParser(
+        description=description, epilog=doc, formatter_class=RawTextHelpFormatter
+    )
+    sysinfo = get_system_info_str()
+    pyinfo = get_python_info_str()
+    version_str = "v{} ({})\n{}\n{}".format(version, date, pyinfo, sysinfo)
+    parser.add_argument("-v", "--version", action="version", version=version_str)
+    parser.add_argument(
+        "-c", "--config", metavar="FILE", help="load config file [配置文件路径]"
+    )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="debug mode [调试模式等效 --log.level=DEBUG]",
+    )
+
+    # 参数定义
+    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 or email [对应账号ID或邮箱]")
+    parser.add_argument("--token", help="API token or key [授权凭证或密钥]")
+    parser.add_argument(
+        "--index4",
+        nargs="*",
+        action=ExtendAction,
+        metavar="RULE",
+        help="IPv4 rules [获取IPv4方式, 多次可配置多规则]",
+    )
+    parser.add_argument(
+        "--index6",
+        nargs="*",
+        action=ExtendAction,
+        metavar="RULE",
+        help="IPv6 rules [获取IPv6方式, 多次可配置多规则]",
+    )
+    parser.add_argument(
+        "--ipv4",
+        nargs="*",
+        action=ExtendAction,
+        metavar="DOMAIN",
+        help="IPv4 domains [IPv4域名列表, 可配置多个域名]",
+    )
+    parser.add_argument(
+        "--ipv6",
+        nargs="*",
+        action=ExtendAction,
+        metavar="DOMAIN",
+        help="IPv6 domains [IPv6域名列表, 可配置多个域名]",
+    )
+    parser.add_argument("--ttl", type=int, help="DNS TTL(s) [设置域名解析过期时间]")
+    parser.add_argument(
+        "--proxy",
+        nargs="*",
+        action=ExtendAction,
+        help="HTTP proxy [设置http代理，可配多个代理连接]",
+    )
+    parser.add_argument(
+        "--cache",
+        type=str2bool,
+        nargs="?",
+        const=True,
+        help="set cache [启用缓存开关，或传入保存路径]",
+    )
+    parser.add_argument(
+        "--no-cache",
+        dest="cache",
+        action="store_const",
+        const=False,
+        help="disable cache [关闭缓存等效 --cache=false]",
+    )
+    parser.add_argument(
+        "--log.file", metavar="FILE", help="log file [日志文件，默认标准输出]"
+    )
+    parser.add_argument("--log.level", type=log_level, metavar="|".join(log_levels))
+    parser.add_argument(
+        "--log.format", metavar="FORMAT", help="log format [设置日志打印格式]"
+    )
+    parser.add_argument(
+        "--log.datefmt", metavar="FORMAT", help="date format [日志时间打印格式]"
+    )
+
+    __cli_args = parser.parse_args()
+    if __cli_args.debug:
+        # 如果启用调试模式，则设置日志级别为 DEBUG
+        setattr(__cli_args, "log.level", log_level("DEBUG"))
+
+    is_configfile_required = not get_config("token") and not get_config("id")
+    config_file = get_config("config")
+    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(config_path):
+    """
+    加载配置
+    """
+    global __config
+    try:
+        with open(config_path, "r") as configfile:
+            __config = loadjson(configfile)
+            __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"]
+                if "format" in __config["log"]:
+                    __config["log.format"] = __config["log"]["format"]
+                if "datefmt" in __config["log"]:
+                    __config["log.datefmt"] = __config["log"]["datefmt"]
+            elif "log.level" in __config:
+                __config["log.level"] = log_level(__config["log.level"])
+    except Exception as e:
+        critical("Failed to load config file `%s`: %s", config_path, e)
+        raise
+        # 重新抛出异常
+
+
+def get_config(key, default=None):
+    """
+    读取配置
+    1. 命令行参数
+    2. 配置文件
+    3. 环境变量
+    """
+    if hasattr(__cli_args, key) and getattr(__cli_args, key) is not None:
+        return getattr(__cli_args, key)
+    if key in __config:
+        return __config.get(key)
+    # 检查环境变量
+    env_name = "DDNS_" + key.replace(".", "_")  # type:str
+    variations = [env_name, env_name.upper(), env_name.lower()]
+    value = next((environ.get(v) for v in variations if v in environ), None)
+
+    # 如果找到环境变量值且参数支持数组，尝试解析为数组
+    if value is not None and key in ARRAY_PARAMS:
+        return parse_array_string(value, key in SIMPLE_ARRAY_PARAMS)
+
+    return value if value is not None else default
+
+
+class ExtendAction(Action):
+    """
+    兼容 Python <3.8 的 extend action
+    """
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        items = getattr(namespace, self.dest, None)
+        if items is None:
+            items = []
+        # values 可能是单个值或列表
+        if isinstance(values, list):
+            items.extend(values)
+        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"},
+    }
+    try:
+        with open(config_path, "w") as f:
+            dumpjson(configure, f, indent=2, sort_keys=True)
+            return True
+    except IOError:
+        critical("Cannot open config file to write: `%s`!", config_path)
+        return False
+    except Exception as e:
+        critical("Failed to write config file `%s`: %s", config_path, e)
+        return False

{util → ddns/util}/ip.py

@@ -4,12 +4,10 @@ from re import compile
 from os import name as os_name, popen
 from socket import socket, getaddrinfo, gethostname, AF_INET, AF_INET6, SOCK_DGRAM
 from logging import debug, error
-try:
-    # python2
-    from urllib2 import urlopen, Request
-except ImportError:
-    # python3
+try:  # python3
     from urllib.request import urlopen, Request
+except ImportError:  # python2
+    from urllib2 import urlopen, Request
 
 # IPV4正则
 IPV4_REG = r'((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])'

ddns-4.0.0.dist-info/METADATA

@@ -0,0 +1,326 @@
+Metadata-Version: 2.4
+Name: ddns
+Version: 4.0.0
+Summary: Dynamic DNS client for multiple providers, supporting IPv4 and IPv6.
+Author-email: NewFuture <python@newfuture.cc>
+License-Expression: MIT
+Project-URL: Homepage, https://ddns.newfuture.cc
+Project-URL: Documentation, https://ddns.newfuture.cc
+Project-URL: Repository, https://github.com/NewFuture/DDNS
+Project-URL: Bug Tracker, https://github.com/NewFuture/DDNS/issues
+Project-URL: Source, https://github.com/NewFuture/DDNS
+Keywords: ddns,ipv6,ipv4,dns,dnspod,alidns,cloudflare
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: Name Service (DNS)
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: Software Development
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=2.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Dynamic: license-file
+
+# [<img src="https://ddns.newfuture.cc/doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) [DDNS](https://github.com/NewFuture/DDNS)
+
+> 自动更新 DNS 解析 到本机 IP 地址，支持 IPv4 和 IPv6，本地（内网）IP 和公网 IP。
+> 代理模式，支持自动创建 DNS 记录。
+
+[![Github Release](https://img.shields.io/github/v/release/NewFuture/DDNS?&logo=github&style=flatten
+)](https://github.com/NewFuture/DDNS/releases/latest)
+[![PyPI](https://img.shields.io/pypi/v/ddns.svg?label=ddns&logo=pypi&style=flatten)](https://pypi.org/project/ddns/)
+[![Docker Image Version](https://img.shields.io/docker/v/newfuture/ddns?label=newfuture/ddns&logo=docker&&sort=semver&style=flatten)](https://hub.docker.com/r/newfuture/ddns)
+[![Build Status](https://github.com/NewFuture/DDNS/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/NewFuture/DDNS/actions/workflows/build.yml)
+[![Publish](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml/badge.svg)](https://github.com/NewFuture/DDNS/actions/workflows/publish.yml)
+
+---
+
+## Features
+
+- 兼容和跨平台:
+  - [Docker (@NN708)](https://hub.docker.com/r/newfuture/ddns) [![Docker Image Size](https://img.shields.io/docker/image-size/newfuture/ddns/latest?logo=docker&style=social)](https://hub.docker.com/r/newfuture/ddns)[![Docker Platforms](https://img.shields.io/badge/arch-amd64%20%7C%20arm64%20%7C%20arm%2Fv7%20%7C%20arm%2Fv6%20%7C%20ppc64le%20%7C%20s390x%20%7C%20386%20%7C%20riscv64-blue?style=social)](https://hub.docker.com/r/newfuture/ddns)
+  - [二进制文件](https://github.com/NewFuture/DDNS/releases/latest) ![cross platform](https://img.shields.io/badge/system-windows_%7C%20linux_%7C%20mac-success.svg?style=social)
+  
+- 配置方式:
+  - [命令行参数](https://ddns.newfuture.cc/doc/cli.html)
+  - [JSON 配置文件](https://ddns.newfuture.cc/doc/json.html)
+  - [环境变量配置](https://ddns.newfuture.cc/doc/env.html)
+
+- 域名支持:
+  - 多个域名支持
+  - 多级域名解析
+  - 自动创建新 DNS 记录
+- IP 类型:
+  - 内网 IPv4 / IPv6
+  - 公网 IPv4 / IPv6 (支持自定义 API)
+  - 自定义命令（shell）
+  - 正则选取支持 (@rufengsuixing)
+- 网络代理:
+  - http 代理支持
+  - 多代理自动切换
+- 服务商支持:
+  - [DNSPOD](https://www.dnspod.cn/)
+  - [阿里 DNS](http://www.alidns.com/)
+  - [DNS.COM](https://www.dns.com/) (@loftor-git)
+  - [DNSPOD 国际版](https://www.dnspod.com/)
+  - [CloudFlare](https://www.cloudflare.com/) (@tongyifan)
+  - [HE.net](https://dns.he.net/) (@NN708) (不支持自动创建记录)
+  - [华为云](https://huaweicloud.com/) (@cybmp3)
+- 其他:
+  - 可设置定时任务
+  - TTL 配置支持
+  - 本地文件缓存（减少 API 请求）
+  - 地址变更时触发自定义回调 API（与 DDNS 功能互斥）
+
+## 使用
+
+### ① 安装
+
+根据需要选择一种方式：`二进制`版、`pip`版、`源码`运行，或者 `Docker`。
+
+推荐 Docker 版，兼容性最佳，体积小，性能优化。
+
+- #### pip 安装（需要 pip 或 easy_install）
+
+  1. 安装 ddns: `pip install ddns` 或 `easy_install ddns`
+  2. 运行: `ddns`
+
+- #### 二进制版（单文件，无需 python）
+
+  - Windows [ddns.exe](https://github.com/NewFuture/DDNS/releases/latest)
+  - Linux（仅 Ubuntu 测试） [ddns](https://github.com/NewFuture/DDNS/releases/latest)
+  - Mac OSX [ddns-mac](https://github.com/NewFuture/DDNS/releases/latest)
+
+- #### 源码运行（无任何依赖，需 python 环境）
+
+  1. clone 或者 [下载此仓库](https://github.com/NewFuture/DDNS/archive/master.zip) 并解压
+  2. 运行 ./run.py（windows 双击 `run.bat` 或者运行 `python run.py`）
+
+- #### Docker（需要安装 Docker）
+
+  - 使用环境变量：
+
+    ```sh
+    docker run -d \
+      -e DDNS_DNS=dnspod \
+      -e DDNS_ID=12345 \
+      -e DDNS_TOKEN=mytokenkey \
+      -e DDNS_IPV4=ddns.newfuture.cc \
+      -e DDNS_IPV6=ddns.newfuture.cc \
+      --network host \
+      newfuture/ddns
+    ```
+
+  - 使用配置文件（docker 工作目录 `/ddns/`，默认配置位置 `/ddns/config.json`）：
+
+    ```sh
+    docker run -d \
+      -v /local/config/path/:/ddns/ \
+      --network host \
+      newfuture/ddns
+    ```
+
+  更多详细说明和高级用法请查看 [Docker 使用文档](doc/docker.md)。
+
+### ② 快速配置
+
+1. 申请 api `token`，填写到对应的 `id` 和 `token` 字段:
+
+   - [DNSPOD(国内版)创建 token](https://support.dnspod.cn/Kb/showarticle/tsid/227/)
+   - [阿里云 accesskey](https://help.aliyun.com/document_detail/87745.htm)
+   - [DNS.COM API Key/Secret](https://www.dns.com/member/apiSet)
+   - [DNSPOD(国际版)](https://www.dnspod.com/docs/info.html#get-the-user-token)
+   - [CloudFlare API Key](https://support.cloudflare.com/hc/en-us/articles/200167836-Where-do-I-find-my-Cloudflare-API-key-)（除了 `email + API KEY`，也可使用 `Token`，需要列出 Zone 权限）
+   - [HE.net DDNS 文档](https://dns.he.net/docs.html)（仅需将设置的密码填入 `token` 字段，`id` 字段可留空）
+   - [华为 APIKEY 申请](https://console.huaweicloud.com/iam/)（点左边访问密钥，然后点新增访问密钥）
+   - 自定义回调的参数填写方式请查看下方的自定义回调配置说明
+
+2. 修改配置文件，`ipv4` 和 `ipv6` 字段，为待更新的域名，详细参照配置说明
+
+## 详细配置
+
+所有字段可通过三种方式进行配置，优先级为：**命令行参数 > JSON配置文件 > 环境变量**
+
+1. [命令行参数](doc/cli.md) `ddns --key=value`（`ddns -h` 查看详情），优先级最高
+2. [JSON 配置文件](doc/json.md)（值为 null 认为是有效值，会覆盖环境变量的设置，如果没有对应的 key 则会尝试使用环境变量）
+3. 环境变量 DDNS_ 前缀加上 key 全大写或者全小写，点转下划线（`${ddns_id}` 或 `${DDNS_ID}`，`${DDNS_LOG_LEVEL}`）
+
+### 配置优先级和字段覆盖关系
+
+如果同一个配置项在多个地方设置，将按照以下优先级规则生效：
+
+- **命令行参数**：优先级最高，会覆盖其他所有设置
+- **JSON配置文件**：介于命令行和环境变量之间，会覆盖环境变量中的设置
+- **环境变量**：优先级最低，当其他方式未设置时使用
+
+**特殊情况**：
+- JSON配置中明确设为`null`的值会覆盖环境变量设置
+- `debug`参数只在命令行中有效，JSON配置文件中的同名设置无效
+- 多值参数（如`ipv4`、`ipv6`等）在命令行中使用方式为重复使用参数，如`--ipv4 domain1 --ipv4 domain2`
+
+各配置方式的详细说明请查看对应文档：[命令行](doc/cli.md)、[JSON配置](doc/json.md)、[环境变量](doc/env.md)
+
+> 📖 **环境变量详细配置**: 查看 [环境变量配置文档](doc/env.md) 了解所有环境变量的详细用法和示例
+
+<details open>
+<summary markdown="span">config.json 配置文件</summary>
+
+- 首次运行会自动生成一个模板配置文件
+- 可以使用 `-c` 使用指定的配置文件（默认读取当前目录的 config.json）
+- 推荐使用 vscode 等支持 JsonSchema 的编辑器编辑配置文件
+- 查看 [JSON配置文件详细文档](doc/json.md) 了解完整的配置选项和示例
+
+```bash
+ddns -c path/to/config.json
+# 或者源码运行
+python run.py -c /path/to/config.json
+```
+
+#### 配置参数表
+
+|  key     |        type        | required |   default   |    description    | tips                                                                                                        |
+| :------: | :----------------: | :------: | :---------: | :---------------: | ----------------------------------------------------------------------------------------------------------- |
+|   id     |       string       |    √     |     无      |    api 访问 ID    | Cloudflare 为邮箱（使用 Token 时留空）<br>HE.net 可留空<br>华为云为 Access Key ID (AK)                     |
+|  token   |       string       |    √     |     无      |  api 授权 token   | 部分平台叫 secret key，**反馈粘贴时删除**                                                                   |
+|  dns     |       string       |    No    | `"dnspod"`  |    dns 服务商     | 阿里 DNS 为 `alidns`，Cloudflare 为 `cloudflare`，dns.com 为 `dnscom`，DNSPOD 国内为 `dnspod`，DNSPOD 国际为 `dnspod_com`，HE.net 为 `he`，华为云为 `huaweidns`，自定义回调为 `callback` |
+|  ipv4    |       array        |    No    |    `[]`     |   ipv4 域名列表   | 为 `[]` 时，不会获取和更新 IPv4 地址                                                                        |
+|  ipv6    |       array        |    No    |    `[]`     |   ipv6 域名列表   | 为 `[]` 时，不会获取和更新 IPv6 地址                                                                        |
+| index4   | string\|int\|array |    No    | `"default"` |   ipv4 获取方式   | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式                                                                |
+| index6   | string\|int\|array |    No    | `"default"` |   ipv6 获取方式   | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式                                                                |
+|  ttl     |       number       |    No    |   `null`    | DNS 解析 TTL 时间 | 不设置采用 DNS 默认策略                                                                                     |
+|  proxy   |       string\|array       |    No    |     无      | http 代理 `;` 分割 | 多代理逐个尝试直到成功，`DIRECT` 为直连                                                                     |
+|  debug  |        bool        |    No    |   `false`   |   是否开启调试    | 等同于设置 log.level=DEBUG，仅命令行参数`--debug`有效                                                  |
+|  cache   |    string\|bool    |    No    |   `true`    |   是否缓存记录    | 正常情况打开避免频繁更新，默认位置为临时目录下 `ddns.cache`，也可以指定一个具体路径                          |
+|  log     | object | No | `null` | 日志配置（可选） | 日志配置对象，支持`level`、`file`、`format`、`datefmt`参数                   |
+
+#### index4 和 index6 参数说明
+
+- 数字（`0`，`1`，`2`，`3`等）：第 i 个网卡 ip
+- 字符串 `"default"`（或者无此项）：系统访问外网默认 IP
+- 字符串 `"public"`：使用公网 ip（使用公网 API 查询，url 的简化模式）
+- 字符串 `"url:xxx"`：打开 URL `xxx`（如：`"url:http://ip.sb"`），从返回的数据提取 IP 地址
+- 字符串 `"regex:xxx"` 正则表达（如 `"regex:192.*"`）：提取 `ifconfig`/`ipconfig` 中与之匹配的首个 IP 地址，**注意 json 转义**（`\`要写成`\\`）
+  - `"192.*"` 表示 192 开头的所有 ip（注意 `regex:` 不可省略）
+  - 如果想匹配 `10.00.xxxx` 应该写成 `"regex:10\\.00\\..*"`（`"\\"` json 转义成 `\`）
+- 字符串 `"cmd:xxxx"`：执行命令 `xxxx` 的 stdout 输出结果作为目标 IP
+- 字符串 `"shell:xxx"`：使用系统 shell 运行 `xxx`，并把结果 stdout 作为目标 IP
+- `false`：强制禁止更新 ipv4 或 ipv6 的 DNS 解析
+- 列表：依次执行列表中的 index 规则，并将最先获得的结果作为目标 IP
+  - 例如 `["public", "regex:172\\..*"]` 将先查询公网 API，未获取到 IP 后再从本地寻找 172 开头的 IP
+
+#### 自定义回调配置说明
+
+- `id` 字段填写回调地址，以 HTTP 或 HTTPS 开头，推荐采用 HTTPS 方式的回调 API ，当 `token` 字段非空且 URL 参数包含下表所示的常量字符串时，会自动替换为实际内容。
+- `token` 字段为 POST 参数，本字段为空或不存在则使用 GET 方式发起回调，回调参数采用 JSON 格式编码，当 JSON 的首层参数值包含下表所示的常量字符串时，会自动替换为实际内容。
+
+| 常量名称          | 常量内容               | 说明      |
+| ---------------- | ---------------------- | -------- |
+| `__DOMAIN__`     | DDNS 域名              |          |
+| `__RECORDTYPE__` | DDNS 记录类型           |          |
+| `__TTL__`        | DDNS TTL               |          |
+| `__TIMESTAMP__`  | 请求发起时间戳          | 包含小数 |
+| `__IP__`         | 获取的对应类型的 IP 地址 |          |
+
+#### 配置示例
+
+```json
+{
+  "$schema": "https://ddns.newfuture.cc/schema/v4.0.json",
+  "id": "12345",
+  "token": "mytokenkey",
+  "dns": "dnspod 或 dnspod_com 或 alidns 或 dnscom 或 cloudflare 或 he 或 huaweidns 或 callback",
+  "ipv4": ["ddns.newfuture.cc", "ipv4.ddns.newfuture.cc"],
+  "ipv6": ["ddns.newfuture.cc", "ipv6.ddns.newfuture.cc"],
+  "index4": 0,
+  "index6": "public",
+  "ttl": 600,
+  "proxy": "127.0.0.1:1080;DIRECT",
+  "log": {
+    "level": "DEBUG",
+    "file": "dns.log",
+    "format": "%(asctime)s %(levelname)s [%(module)s]: %(message)s",
+    "datefmt": "%Y-%m-%dT%H:%M:%S"
+  }
+}
+```
+</details>
+
+## 定时任务
+
+<details>
+<summary markdown="span">可以通过脚本设置定时任务（默认每 5 分钟检查一次 IP，自动更新）</summary>
+
+#### Windows
+
+- [推荐] 以系统身份运行，右键“以管理员身份运行”`task.bat`（或者在管理员命令行中运行）
+- 以当前用户身份运行定时任务，双击或运行 `task.bat`（执行时会闪黑框）
+
+#### Linux
+
+- 使用 init.d 和 crontab:
+  ```bash
+  sudo ./task.sh
+  ```
+- 使用 systemd:
+  ```bash
+  安装:
+  sudo ./systemd.sh install
+  卸载:
+  sudo ./systemd.sh uninstall
+  ```
+
+  该脚本安装的文件符合 [Filesystem Hierarchy Standard (FHS)](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard)：
+  可执行文件所在目录为 `/usr/share/DDNS`
+  配置文件所在目录为 `/etc/DDNS`
+
+#### Docker
+
+Docker 镜像在无额外参数的情况下，已默认启用每 5 分钟执行一次的定时任务
+
+</details>
+
+## FAQ
+
+<details>
+<summary markdown="span">Windows Server [SSL: CERTIFICATE_VERIFY_FAILED]</summary>
+
+> Windows Server 默认安全策略会禁止任何未添加的信任 SSL 证书，可手动添加一下对应的证书 [#56](https://github.com/NewFuture/DDNS/issues/56#issuecomment-487371078)
+
+使用系统自带的 IE 浏览器访问一次对应的 API 即可
+
+- alidns 打开: <https://alidns.aliyuncs.com>
+- cloudflare 打开: <https://api.cloudflare.com>
+- dns.com 打开: <https://www.dns.com>
+- dnspod.cn 打开: <https://dnsapi.cn>
+- dnspod 国际版: <https://api.dnspod.com>
+- 华为 DNS <https://dns.myhuaweicloud.com>
+</details>
+
+<details>
+<summary markdown="span">问题排查反馈</summary>
+
+1. 先确认排查是否是系统/网络环境问题
+2. 在 [issues](https://github.com/NewFuture/DDNS/issues) 中搜索是否有类似问题
+3. 前两者均无法解决或者确定是 bug，[在此新建 issue](https://github.com/NewFuture/DDNS/issues/new)
+   - [ ] 开启 debug 配置
+   - [ ] 附上这些内容 **运行版本和方式**、**系统环境**、**出错日志**、**去掉 id/token** 的配置文件
+   - [ ] 源码运行注明使用的 python 环境
+
+</details>

ddns-4.0.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+ddns/__init__.py,sha256=S58_4GMV40EfyYnjeBprxbc0O0_JpzYbtrJ5sUtE1mY,503
+ddns/__main__.py,sha256=TIoMSOmdHay9k4m4rr5449y3tk8I60ruub_rBOxjh4M,6148
+ddns/provider/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ddns/provider/alidns.py,sha256=fD8mzr7FJ5QxOWLA3ekoOhjeU1IFepOpxybrgZv2c9k,5782
+ddns/provider/callback.py,sha256=V8AG7kxtS0jIkyD9F7xnGJpu1L3E5KUcNDwOnQjcJKs,3208
+ddns/provider/cloudflare.py,sha256=OBq4TJwVHHiPMM6FJo-bz20FOHPvA-RSFbuGilw3tVw,5647
+ddns/provider/dnscom.py,sha256=Nhyl70JGnZY2IV0j5Ebgy_gYQGFb8hXTshaRG_rC0Ww,5297
+ddns/provider/dnspod.py,sha256=52Hstd92-BkyEAicW5DkexfJiTww5KcNZkKs20HUIFE,6211
+ddns/provider/dnspod_com.py,sha256=touJksX1aPDAaP9yWRLVzbbbCtP8jzrDZSMSqtRlc0s,336
+ddns/provider/he.py,sha256=X_WODK6vDTpHdAvPP_vUltaeAlHeG2jMPbzFkfYxWOg,2142
+ddns/provider/huaweidns.py,sha256=0A2jxcJ5zGaMxMMh7C9SsDewhP2zVRLI8FznB9BBBEc,8748
+ddns/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ddns/util/cache.py,sha256=LVH5jGZFimXmD7XCQCtZULhagybM7gSjMo-73yqttiA,3338
+ddns/util/config.py,sha256=KUHd24gLwYOCiIM59euEpJ5fkOSfHNzMSclSWiwNZX4,10165
+ddns/util/ip.py,sha256=GZzqrl_nq9JuGHTWhPB0fffpr94ITJA6BCVlS5KlWcE,3836
+ddns-4.0.0.dist-info/licenses/LICENSE,sha256=MI-ECjp-Vl7WZLiSPY6r5VwrOReNiICVB1QCXiUGt_s,1111
+ddns-4.0.0.dist-info/METADATA,sha256=56Jpj_ZqrWqZScLU3ho-N47pI6Un6SmAmBbsuftAFWs,16831
+ddns-4.0.0.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+ddns-4.0.0.dist-info/entry_points.txt,sha256=2-VbA-WZcjebkZrGKvUCuBBRYF4xQNMoLIoGaS234WU,44
+ddns-4.0.0.dist-info/top_level.txt,sha256=Se0wn3T8Bc4pj55dGwVrCe8BFwmFCBwQVHF1bTyV0o0,5
+ddns-4.0.0.dist-info/RECORD,,