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

ddns/provider/cloudflare.py

@@ -1,163 +1,99 @@
 # coding=utf-8
 """
 CloudFlare API
-CloudFlare 接口解析操作库
-https://api.cloudflare.com/#dns-records-for-a-zone-properties
-@author: TongYifan
+@author: TongYifan, NewFuture
 """
 
-from json import loads as jsondecode, dumps as jsonencode
-from logging import debug, info, warning
+from ._base import BaseProvider, TYPE_JSON, join_domain
 
-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__ = 'TongYifan'
+class CloudflareProvider(BaseProvider):
+    API = "https://api.cloudflare.com"
+    content_type = TYPE_JSON
 
+    def _validate(self):
+        if not self.auth_token:
+            raise ValueError("token must be configured")
+        if self.auth_id:
+            # must be email for Cloudflare API v4
+            if "@" not in self.auth_id:
+                self.logger.critical("ID 必须为空或有效的邮箱地址")
+                raise ValueError("ID must be a valid email or Empty for Cloudflare API v4")
 
-class Config:
-    ID = "AUTH EMAIL"  # CloudFlare 验证的是用户Email，等同于其他平台的userID
-    TOKEN = "API KEY"
-    PROXY = None  # 代理设置
-    TTL = None
-
-
-class API:
-    # API 配置
-    SITE = "api.cloudflare.com"  # API endpoint
-
-
-def request(method, action, param=None, **params):
-    """
-        发送请求数据
-    """
-    if param:
-        params.update(param)
-
-    params = dict((k, params[k]) for k in params if params[k] is not None)
-    info("%s/%s : %s", API.SITE, action, params)
-    if Config.PROXY:
-        conn = HTTPSConnection(Config.PROXY)
-        conn.set_tunnel(API.SITE, 443)
-    else:
-        conn = HTTPSConnection(API.SITE)
-
-    if method in ['PUT', 'POST', 'PATCH']:
-        # 从public_v(4,6)获取的IP是bytes类型，在json.dumps时会报TypeError
-        params['content'] = str(params.get('content'))
-        params = jsonencode(params)
-    else:  # (GET, DELETE) where DELETE doesn't require params in Cloudflare
-        if params:
-            action += '?' + urlencode(params)
-        params = None
-    if not Config.ID:
-        headers = {"Content-type": "application/json",
-                   "Authorization": "Bearer " + Config.TOKEN}
-    else:
-        headers = {"Content-type": "application/json",
-                   "X-Auth-Email": Config.ID, "X-Auth-Key": Config.TOKEN}
-    conn.request(method, '/client/v4/zones' + action, params, headers)
-    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('success'):
-            return data.get('result', [{}])
+    def _request(self, method, action, **params):
+        """发送请求数据"""
+        headers = {}
+        if self.auth_id:
+            headers["X-Auth-Email"] = self.auth_id
+            headers["X-Auth-Key"] = self.auth_token
         else:
-            raise Exception(data.get('errors', [{}]))
-
-
-def get_zone_id(domain):
-    """
-        切割域名获取主域名ID(Zone_ID)
-        https://api.cloudflare.com/#zone-list-zones
-    """
-    zoneid = None
-    domain_slice = domain.split('.')
-    index = 2
-    # ddns.example.com => example.com; ddns.example.eu.org => example.eu.org
-    while (not zoneid) and (index <= len(domain_slice)):
-        zones = request('GET', '', name='.'.join(domain_slice[-index:]))
-        zone = next((z for z in zones if domain.endswith(z.get('name'))), None)
-        zoneid = zone and zone['id']
-        index += 1
-    return zoneid
-
+            headers["Authorization"] = "Bearer " + self.auth_token
 
-def get_records(zoneid, **conditions):
-    """
-           获取记录ID
-           返回满足条件的所有记录[]
-           TODO 大于100翻页
-    """
-    cache_key = zoneid + "_" + \
-        conditions.get('name', "") + "_" + conditions.get('type', "")
-    if not hasattr(get_records, 'records'):
-        get_records.records = {}  # "静态变量"存储已查询过的id
-        get_records.keys = ('id', 'type', 'name', 'content', 'proxied', 'ttl')
-
-    if zoneid not in get_records.records:
-        get_records.records[cache_key] = {}
-        data = request('GET', '/' + zoneid + '/dns_records',
-                       per_page=100, **conditions)
-        if data:
-            for record in data:
-                get_records.records[cache_key][record['id']] = {
-                    k: v for (k, v) in record.items() if k in get_records.keys}
-
-    records = {}
-    for (zid, record) in get_records.records[cache_key].items():
-        for (k, value) in conditions.items():
-            if record.get(k) != value:
-                break
-        else:  # for else push
-            records[zid] = record
-    return records
-
-
-def update_record(domain, value, record_type="A"):
-    """
-    更新记录
-    """
-    info(">>>>>%s(%s)", domain, record_type)
-    zoneid = get_zone_id(domain)
-    if not zoneid:
-        raise Exception("invalid domain: [ %s ] " % domain)
-
-    records = get_records(zoneid, name=domain, type=record_type)
-    cache_key = zoneid + "_" + domain + "_" + record_type
-    result = {}
-    if records:  # update
-        # https://api.cloudflare.com/#dns-records-for-a-zone-update-dns-record
-        for (rid, record) in records.items():
-            if record['content'] != value:
-                res = request('PUT', '/' + zoneid + '/dns_records/' + record['id'],
-                              type=record_type, content=value, name=domain, proxied=record['proxied'], ttl=Config.TTL)
-                if res:
-                    get_records.records[cache_key][rid]['content'] = value
-                    result[rid] = res.get("name")
-                else:
-                    result[rid] = "Update fail!\n" + str(res)
-            else:
-                result[rid] = domain
-    else:  # create
-        # https://api.cloudflare.com/#dns-records-for-a-zone-create-dns-record
-        res = request('POST', '/' + zoneid + '/dns_records',
-                      type=record_type, name=domain, content=value, proxied=False, ttl=Config.TTL)
-        if res:
-            get_records.records[cache_key][res['id']] = res
-            result = res
+        params = {k: v for k, v in params.items() if v is not None}  # 过滤掉None参数
+        data = self._http(method, "/client/v4/zones" + action, headers=headers, params=params)
+        if data and data.get("success"):
+            return data.get("result")  # 返回结果或原始数据
         else:
-            result = domain + " created fail!"
-    return result
+            self.logger.warning("Cloudflare API error: %s", data.get("errors", "Unknown error"))
+        return data
+
+    def _query_zone_id(self, domain):
+        """https://developers.cloudflare.com/api/resources/zones/methods/list/"""
+        params = {"name.exact": domain, "per_page": 50}
+        zones = self._request("GET", "", **params)
+        zone = next((z for z in zones if domain == z.get("name", "")), None)
+        self.logger.debug("Queried zone: %s", zone)
+        if zone:
+            return zone["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
+        """https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/list/"""
+        # cloudflare的域名查询需要完整域名
+        name = join_domain(subdomain, main_domain)
+        query = {"name.exact": name}  # type: dict[str, str|None]
+        if extra:
+            query["proxied"] = extra.get("proxied", None)  # 代理状态
+        data = self._request("GET", "/{}/dns_records".format(zone_id), type=record_type, per_page=10000, **query)
+        record = next((r for r in data if r.get("name") == name and r.get("type") == record_type), None)
+        self.logger.debug("Record queried: %s", record)
+        if record:
+            return record
+        self.logger.warning("Failed to query record: %s", data)
+        return None
+
+    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://developers.cloudflare.com/api/resources/dns/subresources/records/methods/create/"""
+        name = join_domain(subdomain, main_domain)
+        extra["comment"] = extra.get("comment", self.remark)  # 添加注释
+        data = self._request(
+            "POST", "/{}/dns_records".format(zone_id), name=name, type=record_type, content=value, ttl=ttl, **extra
+        )
+        if data:
+            self.logger.info("Record created: %s", data)
+            return True
+        self.logger.error("Failed to create record: %s", data)
+        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://developers.cloudflare.com/api/resources/dns/subresources/records/methods/edit/"""
+        extra["comment"] = extra.get("comment", self.remark)  # 注释
+        extra["proxied"] = old_record.get("proxied", extra.get("proxied"))  # 保持原有的代理状态
+        extra["tags"] = old_record.get("tags", extra.get("tags"))  # 保持原有的标签
+        extra["settings"] = old_record.get("settings", extra.get("settings"))  # 保持原有的设置
+        data = self._request(
+            "PUT",
+            "/{}/dns_records/{}".format(zone_id, old_record["id"]),
+            type=record_type,
+            name=old_record.get("name"),
+            content=value,
+            ttl=ttl,
+            **extra
+        )
+        self.logger.debug("Record updated: %s", data)
+        if data:
+            return True
+        return False

ddns/provider/debug.py

@@ -0,0 +1,20 @@
+# coding=utf-8
+"""
+DebugProvider
+仅打印出 IP 地址，不进行任何实际 DNS 更新。
+"""
+
+from ._base import SimpleProvider
+
+
+class DebugProvider(SimpleProvider):
+
+    def _validate(self):
+        """无需任何验证"""
+        pass
+
+    def set_record(self, domain, value, record_type="A", ttl=None, line=None, **extra):
+        self.logger.debug("DebugProvider: %s(%s) => %s", domain, record_type, value)
+        ip_type = "IPv4" if record_type == "A" else "IPv6" if record_type == "AAAA" else record_type
+        print("[{}] {}".format(ip_type, value))
+        return True

ddns/provider/dnscom.py

@@ -1,180 +1,102 @@
 # coding=utf-8
 """
-DNSCOM API
-DNS.COM 接口解析操作库
-http://open.dns.com/
-@author: Bigjin
-@mailto: i@bigjin.com
+DNSCOM/51dns API 接口解析操作库
+www.51dns.com (原dns.com)
+@author: Bigjin<i@bigjin.com>, NewFuture
 """
 
+from ._base import BaseProvider, TYPE_FORM
 from hashlib import md5
-from json import loads as jsondecode
-from logging import debug, info, warning
-from time import mktime
-from datetime import datetime
+from time import time
 
-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__ = 'Bigjin'
-# __all__ = ["request", "ID", "TOKEN", "PROXY"]
-
-
-class Config:
-    ID = "id"
-    TOKEN = "TOKEN"
-    PROXY = None  # 代理设置
-    TTL = None
-
-
-class API:
-    # API 配置
-    SITE = "www.dns.com"  # API endpoint
-    METHOD = "POST"  # 请求方法
-
-
-def signature(params):
+class DnscomProvider(BaseProvider):
     """
-    计算签名,返回签名后的查询参数
+    DNSCOM/51dns API Provider
+    https://www.51dns.com/document/api/index.html
     """
-    params.update({
-        'apiKey': Config.ID,
-        'timestamp': mktime(datetime.now().timetuple()),
-    })
-    query = urlencode(sorted(params.items()))
-    debug(query)
-    sign = query
-    debug("signString: %s", sign)
-
-    sign = md5((sign + Config.TOKEN).encode('utf-8')).hexdigest()
-    params["hash"] = sign
-
-    return params
-
 
-def request(action, param=None, **params):
-    """
-    发送请求数据
-    """
-    if param:
-        params.update(param)
-    params = dict((k, params[k]) for k in params if params[k] is not None)
-    params = signature(params)
-    info("%s/api/%s/ : params:%s", API.SITE, action, params)
-
-    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()
-    result = response.read().decode('utf8')
-    conn.close()
-
-    if response.status < 200 or response.status >= 300:
-        warning('%s : error[%d]:%s', action, response.status, result)
-        raise Exception(result)
-    else:
-        data = jsondecode(result)
-        debug('%s : result:%s', action, data)
-        if data.get('code') != 0:
-            raise Exception("api error:", data.get('message'))
-        data = data.get('data')
-        if data is None:
-            raise Exception('response data is none')
-        return data
-
-
-def get_domain_info(domain):
-    """
-    切割域名获取主域名和对应ID
-    """
-    if len(domain.split('.')) > 2:
-        domains = domain.split('.', 1)
-        sub = domains[0]
-        main = domains[1]
-    else:
-        sub = ''  # 接口有bug 不能传 @ * 作为主机头，但是如果为空，默认为 @
-        main = domain
-
-    res = request("domain/getsingle", domainID=main)
-    domain_id = res.get('domainID')
-    return sub, main, domain_id
-
-
-def get_records(domain, domain_id, **conditions):
-    """
-        获取记录ID
-        返回满足条件的所有记录[]
-        TODO 大于500翻页
-    """
-    if not hasattr(get_records, "records"):
-        get_records.records = {}  # "静态变量"存储已查询过的id
-        get_records.keys = ("recordID", "record", "type", "viewID",
-                            "TTL", "state", "value")
-
-    if domain not in get_records.records:
-        get_records.records[domain] = {}
-        data = request("record/list",
-                       domainID=domain_id, pageSize=500)
-        if data.get('data'):
-            for record in data.get('data'):
-                get_records.records[domain][record["recordID"]] = {
-                    k: v for (k, v) in record.items() if k in get_records.keys}
-    records = {}
-    for (rid, record) in get_records.records[domain].items():
-        for (k, value) in conditions.items():
-            if record.get(k) != value:
-                break
-        else:  # for else push
-            records[rid] = record
-    return records
-
-
-def update_record(domain, value, record_type='A'):
-    """
-        更新记录
-    """
-    info(">>>>>%s(%s)", domain, record_type)
-    sub, main, domain_id = get_domain_info(domain)
-
-    records = get_records(main, domain_id, record=sub, type=record_type)
-    result = {}
-
-    if records:
-        for (rid, record) in records.items():
-            if record["value"] != value:
-                debug(sub, record)
-                res = request("record/modify", domainID=domain_id,
-                              recordID=rid, newvalue=value, newTTL=Config.TTL)
-                if res:
-                    # update records
-                    get_records.records[main][rid]["value"] = value
-                    result[rid] = res
-                else:
-                    result[rid] = "update fail!\n" + str(res)
-            else:
-                result[rid] = domain
-    else:
-        res = request("record/create", domainID=domain_id,
-                      value=value, host=sub, type=record_type, TTL=Config.TTL)
-        if res:
-            # update records INFO
-            rid = res.get('recordID')
-            get_records.records[main][rid] = {
-                'value': value,
-                "recordID": rid,
-                "record": sub,
-                "type": record_type
+    API = "https://www.51dns.com"
+    content_type = TYPE_FORM
+
+    def _validate(self):
+        self.logger.warning(
+            "DNS.COM 缺少充分的真实环境测试，请及时在 GitHub Issues 中反馈: %s",
+            "https://github.com/NewFuture/DDNS/issues",
+        )
+        super(DnscomProvider, self)._validate()
+
+    def _signature(self, params):
+        """https://www.51dns.com/document/api/70/72.html"""
+        params = {k: v for k, v in params.items() if v is not None}
+        params.update(
+            {
+                "apiKey": self.auth_id,
+                "timestamp": time(),  # 时间戳
             }
-            result = res
-        else:
-            result = domain + " created fail!"
-    return result
+        )
+        query = self._encode(sorted(params.items()))
+        sign = md5((query + self.auth_token).encode("utf-8")).hexdigest()
+        params["hash"] = sign
+        return params
+
+    def _request(self, action, **params):
+        params = self._signature(params)
+        data = self._http("POST", "/api/{}/".format(action), body=params)
+        if data is None or not isinstance(data, dict):
+            raise Exception("response data is none")
+        if data.get("code", 0) != 0:
+            raise Exception("api error: " + str(data.get("message")))
+        return data.get("data")
+
+    def _query_zone_id(self, domain):
+        """https://www.51dns.com/document/api/74/31.html"""
+        res = self._request("domain/getsingle", domainID=domain)
+        self.logger.debug("Queried domain: %s", res)
+        if res:
+            return res.get("domainID")
+        return None
+
+    def _query_record(self, zone_id, subdomain, main_domain, record_type, line, extra):
+        """https://www.51dns.com/document/api/4/47.html"""
+        records = self._request("record/list", domainID=zone_id, host=subdomain, pageSize=500)
+        records = records.get("data", []) if records else []
+        for record in records:
+            if (
+                record.get("record") == subdomain
+                and record.get("type") == record_type
+                and (line is None or record.get("viewID") == line)
+            ):
+                return record
+        return None
+
+    def _create_record(self, zone_id, subdomain, main_domain, value, record_type, ttl, line, extra):
+        """https://www.51dns.com/document/api/4/12.html"""
+        extra["remark"] = extra.get("remark", self.remark)
+        res = self._request(
+            "record/create",
+            domainID=zone_id,
+            value=value,
+            host=subdomain,
+            type=record_type,
+            TTL=ttl,
+            viewID=line,
+            **extra
+        )
+        if res and res.get("recordID"):
+            self.logger.info("Record created: %s", res)
+            return True
+        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):
+        """https://www.51dns.com/document/api/4/45.html"""
+        extra["remark"] = extra.get("remark", self.remark)
+        res = self._request(
+            "record/modify", domainID=zone_id, recordID=old_record.get("recordID"), newvalue=value, newTTL=ttl
+        )
+        if res:
+            self.logger.info("Record updated: %s", res)
+            return True
+        self.logger.error("Failed to update record: %s", res)
+        return False