ddns 4.0.1__py2.py3-none-any.whl → 4.1.0b1__py2.py3-none-any.whl

ddns/provider/dnspod.py

@@ -1,186 +1,117 @@
 # coding=utf-8
 """
 DNSPOD API
-DNSPOD 接口解析操作库
-http://www.dnspod.cn/docs/domains.html
-@author: New Future
+@doc: https://docs.dnspod.cn/api/
+@author: NewFuture
 """
 
-from json import loads as jsondecode
-from logging import debug, info, warning
-from os import environ
+from ._base import BaseProvider, TYPE_FORM
 
-try:  # python 3
-    from http.client import HTTPSConnection
-    from urllib.parse import urlencode
-except ImportError:  # python 2
-    from httplib import HTTPSConnection
-    from urllib import urlencode
 
-__author__ = 'New Future'
-
-
-class Config:
-    ID = "token id"
-    TOKEN = "token key"
-    PROXY = None  # 代理设置
-    TTL = None
-
-
-class API:
-    # API 配置
-    SITE = "dnsapi.cn"  # API endpoint
-    METHOD = "POST"  # 请求方法
-    TOKEN_PARAM = "login_token"  # token参数
-    DEFAULT = "默认"  # 默认线路名
-    LENGTH = "length"  # 添加参数
-
-
-def request(action, param=None, **params):
+class DnspodProvider(BaseProvider):
     """
-    发送请求数据
+    DNSPOD API
+    DNSPOD 接口解析操作库
     """
-    if param:
-        params.update(param)
-    params = dict((k, params[k]) for k in params if params[k] is not None)
-    params.update({API.TOKEN_PARAM: '***', 'format': 'json'})
-    info("%s/%s : %s", API.SITE, action, params)
-    params[API.TOKEN_PARAM] = "%s,%s" % (Config.ID, Config.TOKEN)
-    params[API.LENGTH] = "3000"  # 添加参数
-    if Config.PROXY:
-        conn = HTTPSConnection(Config.PROXY)
-        conn.set_tunnel(API.SITE, 443)
-    else:
-        conn = HTTPSConnection(API.SITE)
-
-    conn.request(API.METHOD, '/' + action, urlencode(params), {
-        "Content-type": "application/x-www-form-urlencoded",
-        "User-Agent": "DDNS/%s (ddns@newfuture.cc)" % environ.get("DDNS_VERSION", "1.0.0")
-    })
-    response = conn.getresponse()
-    res = response.read().decode('utf8')
-    conn.close()
 
-    if response.status < 200 or response.status >= 300:
-        warning('%s : error[%d]:%s', action, response.status, res)
-        raise Exception(res)
-    else:
-        data = jsondecode(res)
-        debug('%s : result:%s', action, data)
-        if not data:
-            raise Exception("empty response")
-        elif data.get("status", {}).get("code") == "1":
+    API = "https://dnsapi.cn"
+    content_type = TYPE_FORM
+
+    DefaultLine = "默认"
+
+    def _request(self, action, extra=None, **params):
+        # type: (str, dict | None, **(str | int | bytes | bool | None)) -> dict
+        """
+        发送请求数据
+
+        Send request to DNSPod API.
+        Args:
+            action (str): API 动作/Action
+            extra (dict|None): 额外参数/Extra params
+            params (dict): 其它参数/Other params
+        Returns:
+            dict: 响应数据/Response data
+        """
+        # 过滤掉None参数
+        if extra:
+            params.update(extra)
+        params = {k: v for k, v in params.items() if v is not None}
+        params.update({"login_token": "{0},{1}".format(self.auth_id, self.auth_token), "format": "json"})
+        headers = {"User-Agent": "DDNS/{0} (ddns@newfuture.cc)".format(self.version)}
+        data = self._http("POST", "/" + action, headers=headers, body=params)
+        if data and data.get("status", {}).get("code") == "1":  # 请求成功
+            return data
+        else:  # 请求失败
+            error_msg = "Unknown error"
+            if data and isinstance(data, dict):
+                error_msg = data.get("status", {}).get("message", "Unknown error")
+            self.logger.warning("DNSPod API error: %s", error_msg)
             return data
-        else:
-            raise Exception(data.get('status', {}))
-
-
-def get_domain_info(domain):
-    """
-    切割域名获取主域名和对应ID
-    """
-    domain_split = domain.split('.')
-    sub, did = None, None
-    main = domain_split.pop()
-    while domain_split:  # 通过API判断,最后两个，三个递增
-        main = domain_split.pop() + '.' + main
-        did = get_domain_id(main)
-        if did:
-            sub = ".".join(domain_split) or '@'
-            # root domain根域名https://github.com/NewFuture/DDNS/issues/9
-            break
-    info('domain_id: %s, sub: %s', did, sub)
-    return did, sub
-
-
-def get_domain_id(domain):
-    """
-        获取域名ID
-        http://www.dnspod.cn/docs/domains.html#domain-info
-    """
-    if not hasattr(get_domain_id, "domain_list"):
-        get_domain_id.domain_list = {}  # "静态变量"存储已查询过的id
-
-    if domain in get_domain_id.domain_list:
-        # 如果已经存在直接返回防止再次请求
-        return get_domain_id.domain_list[domain]
-    else:
-        try:
-            d_info = request('Domain.Info', domain=domain)
-        except Exception as e:
-            info("get_domain_id(%s) error: %s", domain, e)
-            return
-        did = d_info.get("domain", {}).get("id")
-        if did:
-            get_domain_id.domain_list[domain] = did
-            return did
-
-
-def get_records(did, **conditions):
-    """
-        获取记录ID
-        返回满足条件的所有记录[]
-        TODO 大于3000翻页
-        http://www.dnspod.cn/docs/records.html#record-list
-    """
-    if not hasattr(get_records, "records"):
-        get_records.records = {}  # "静态变量"存储已查询过的id
-        get_records.keys = ("id", "name", "type", "line",
-                            "line_id", "enabled", "mx", "value")
-
-    if did not in get_records.records:
-        get_records.records[did] = {}
-        data = request('Record.List', domain_id=did)
-        if data:
-            for record in data.get('records'):
-                get_records.records[did][record["id"]] = {
-                    k: v for (k, v) in record.items() if k in get_records.keys}
-
-    records = {}
-    for (did, record) in get_records.records[did].items():
-        for (k, value) in conditions.items():
-            if record.get(k) != value:
-                break
-        else:  # for else push
-            records[did] = record
-    return records
-
-
-def update_record(domain, value, record_type="A"):
-    """
-    更新记录
-    """
-    info(">>>>>%s(%s)", domain, record_type)
-    domainid, sub = get_domain_info(domain)
-    if not domainid:
-        raise Exception("invalid domain: [ %s ] " % domain)
 
-    records = get_records(domainid, name=sub, type=record_type)
-    result = {}
-    if records:  # update
-        # http://www.dnspod.cn/docs/records.html#record-modify
-        for (did, record) in records.items():
-            if record["value"] != value:
-                debug(sub, record)
-                res = request('Record.Modify', record_id=did, record_line=record["line"].replace("Default", "default").encode(
-                    "utf-8"), value=value, sub_domain=sub, domain_id=domainid, record_type=record_type, ttl=Config.TTL)
-                if res:
-                    get_records.records[domainid][did]["value"] = value
-                    result[did] = res.get("record")
-                else:
-                    result[did] = "update fail!\n" + str(res)
-            else:
-                result[did] = domain
-    else:  # create
-        # http://www.dnspod.cn/docs/records.html#record-create
-        res = request("Record.Create", domain_id=domainid, value=value,
-                      sub_domain=sub, record_type=record_type, record_line=API.DEFAULT, ttl=Config.TTL)
-        if res:
-            did = res.get("record")["id"]
-            get_records.records[domainid][did] = res.get("record")
-            get_records.records[domainid][did].update(
-                value=value, sub_domain=sub, record_type=record_type)
-            result = res.get("record")
-        else:
-            result = domain + " created fail!"
-    return result
+    def _create_record(self, zone_id, subdomain, main_domain, value, record_type, ttl, line, extra):
+        # type: (str, str, str, str, str, int | str | None, str | None, dict) -> bool
+        """https://docs.dnspod.cn/api/add-record/"""
+        res = self._request(
+            "Record.Create",
+            extra=extra,
+            domain_id=zone_id,
+            sub_domain=subdomain,
+            value=value,
+            record_type=record_type,
+            record_line=line or self.DefaultLine,
+            ttl=ttl,
+        )
+        record = res and res.get("record")
+        if record:  # 记录创建成功
+            self.logger.info("Record created: %s", record)
+            return True
+        else:  # 记录创建失败
+            self.logger.error("Failed to create record: %s", res)
+        return False
+
+    def _update_record(self, zone_id, old_record, value, record_type, ttl, line, extra):
+        # type: (str, dict, str, str, int | str | None, str | None, dict) -> bool
+        """https://docs.dnspod.cn/api/modify-records/"""
+        record_line = (line or old_record.get("line") or self.DefaultLine).replace("Default", "default")
+        res = self._request(
+            "Record.Modify",
+            domain_id=zone_id,
+            record_id=old_record.get("id"),
+            sub_domain=old_record.get("name"),
+            record_type=record_type,
+            value=value,
+            record_line=record_line,
+            extra=extra,
+        )
+        record = res and res.get("record")
+        if record:  # 记录更新成功
+            self.logger.debug("Record updated: %s", record)
+            return True
+        else:  # 记录更新失败
+            self.logger.error("Failed to update record: %s", res)
+            return False
+
+    def _query_zone_id(self, domain):
+        # type: (str) -> str | None
+        """查询域名信息 https://docs.dnspod.cn/api/domain-info/"""
+        res = self._request("Domain.Info", domain=domain)
+        if res and isinstance(res, dict):
+            return res.get("domain", {}).get("id")
+        return None
+
+    def _query_record(self, zone_id, subdomain, main_domain, record_type, line, extra):
+        # type: (str, str, str, str, str | None, dict) -> dict | None
+        """查询记录 list 然后逐个查找 https://docs.dnspod.cn/api/record-list/"""
+        res = self._request(
+            "Record.List", domain_id=zone_id, sub_domain=subdomain, record_type=record_type, line=line
+        )
+        # length="3000"
+        records = res.get("records", [])
+        n = len(records)
+        if not n:
+            self.logger.warning("No record found for [%s] %s<%s>(line: %s)", zone_id, subdomain, record_type, line)
+            return None
+        if n > 1:
+            self.logger.warning("%d records found for %s<%s>(%s):\n %s", n, subdomain, record_type, line, records)
+            return next((r for r in records if r.get("name") == subdomain), None)
+        return records[0]

ddns/provider/dnspod_com.py

@@ -1,15 +1,18 @@
 # coding=utf-8
 """
-DNSPOD API
-DNSPOD 接口解析操作库
+DNSPOD Global (国际版) API
 http://www.dnspod.com/docs/domains.html
-@author: New Future
+@author: NewFuture
 """
 
-from .dnspod import *  # noqa: F403
+from .dnspod import DnspodProvider  # noqa: F401
 
-API.SITE = "api.dnspod.com"  # noqa: F405
-API.DEFAULT = "default"  # noqa: F405
 
-# https://github.com/NewFuture/DDNS/issues/286
-# API.TOKEN_PARAM = "user_token"  # noqa: F405
+class DnspodComProvider(DnspodProvider):
+    """
+    DNSPOD.com Provider (国际版)
+    This class extends the DnspodProvider to use the global DNSPOD API.
+    """
+
+    API = "https://api.dnspod.com"
+    DefaultLine = "default"

ddns/provider/he.py

@@ -1,83 +1,46 @@
 # coding=utf-8
 """
 Hurricane Electric (he.net) API
-Hurricane Electric (he.net) 接口解析操作库
-https://dns.he.net/docs.html
-@author: NN708
+@author: NN708, NewFuture
 """
 
-from logging import debug, info, warning
-
-try:  # python 3
-    from http.client import HTTPSConnection
-    from urllib.parse import urlencode
-except ImportError:  # python 2
-    from httplib import HTTPSConnection
-    from urllib import urlencode
-
-__author__ = 'NN708'
-
-
-class Config:
-    TOKEN = "password"
-    PROXY = None  # 代理设置
-
-
-class API:
-    # API 配置
-    SITE = "dyn.dns.he.net"
-    METHOD = "POST"
-    ACTION = "nic/update"
-    TOKEN_PARAM = "password"  # key name of token param
-
-
-def request(param=None, **params):
-    """
-    发送请求数据
-    """
-    if param:
-        params.update(param)
-
-    params.update({API.TOKEN_PARAM: '***'})
-    info("%s/%s : %s", API.SITE, API.ACTION, params)
-    params[API.TOKEN_PARAM] = Config.TOKEN
-
-    if Config.PROXY:
-        conn = HTTPSConnection(Config.PROXY)
-        conn.set_tunnel(API.SITE, 443)
-    else:
-        conn = HTTPSConnection(API.SITE)
-
-    conn.request(API.METHOD, '/' + API.ACTION, urlencode(params), {
-        "Content-type": "application/x-www-form-urlencoded"
-    })
-    response = conn.getresponse()
-    res = response.read().decode('utf8')
-    conn.close()
-
-    if response.status < 200 or response.status >= 300:
-        warning('%s : error[%d]:%s', API.ACTION, response.status, res)
-        raise Exception(res)
-    else:
-        debug('%s : result:%s', API.ACTION, res)
-        if not res:
-            raise Exception("empty response")
-        elif res[:5] == "nochg" or res[:4] == "good":  # No change or success
-            return res
-        else:
-            raise Exception(res)
-
-
-def update_record(domain, value, record_type="A"):
-    """
-    更新记录
-    """
-    info(">>>>>%s(%s)", domain, record_type)
-    res = request(hostname=domain, myip=value)
-    if res[:4] == "good":
-        result = "Record updated. New IP is: " + res[5:-1]
-    elif res[:5] == "nochg":
-        result = "IP not changed. IP is: " + res[6:-1]
-    else:
-        result = "Record update failed."
-    return result
+from ._base import SimpleProvider, TYPE_FORM
+
+
+class HeProvider(SimpleProvider):
+    API = "https://dyn.dns.he.net"
+    content_type = TYPE_FORM
+    accept = None  # he.net does not require a specific Accept header
+    decode_response = False  # he.net response is plain text, not JSON
+
+    def _validate(self):
+        self.logger.warning(
+            "HE.net 缺少充分的真实环境测试，请及时在 GitHub Issues 中反馈: %s",
+            "https://github.com/NewFuture/DDNS/issues",
+        )
+        if self.auth_id:
+            raise ValueError("Hurricane Electric (he.net) does not use `id`, use `token(password)` only.")
+        if not self.auth_token:
+            raise ValueError("Hurricane Electric (he.net) requires `token(password)`.")
+
+    def set_record(self, domain, value, record_type="A", ttl=None, line=None, **extra):
+        """
+        使用 POST API 更新或创建 DNS 记录。Update or create DNS record with POST API.
+        https://dns.he.net/docs.html
+        """
+        self.logger.info("%s => %s(%s)", domain, value, record_type)
+        params = {
+            "hostname": domain,  # he.net requires full domain name
+            "myip": value,  # IP address to update
+            "password": self.auth_token,  # Use auth_token as password
+        }
+        try:
+            res = self._http("POST", "/nic/update", body=params)
+            if res and res[:5] == "nochg" or res[:4] == "good":  # No change or success
+                self.logger.info("HE API response: %s", res)
+                return True
+            else:
+                self.logger.error("HE API error: %s", res)
+        except Exception as e:
+            self.logger.error("Error updating record for %s: %s", domain, e)
+        return False