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

ddns/provider/callback.py

@@ -3,115 +3,77 @@
 Custom Callback API
 自定义回调接口解析操作库
 
-@author: 老周部落
+@author: 老周部落, NewFuture
 """
 
-from json import loads as jsondecode
-from logging import debug, info, warning
+from ._base import TYPE_JSON, SimpleProvider
 from time import time
-
-try:  # python 3
-    from http.client import HTTPSConnection, HTTPConnection
-    from urllib.parse import urlencode, urlparse, parse_qsl
-except ImportError:  # python 2
-    from httplib import HTTPSConnection, HTTPConnection
-    from urlparse import urlparse, parse_qsl
-    from urllib import urlencode
-
-__author__ = '老周部落'
-
-
-class Config:
-    ID = None  # 自定义回调 URL
-    TOKEN = None  # 使用 JSON 编码的 POST 参数
-    PROXY = None   # 代理设置
-    TTL = None
-
-
-def request(method, action, param=None, **params):
-    """
-    发送请求数据
-    """
-    if param:
-        params.update(param)
-
-    URLObj = urlparse(Config.ID)
-    params = dict((k, params[k]) for k in params if params[k] is not None)
-    info("%s/%s : %s", URLObj.netloc, action, params)
-
-    if Config.PROXY:
-        if URLObj.netloc == "http":
-            conn = HTTPConnection(Config.PROXY)
-        else:
-            conn = HTTPSConnection(Config.PROXY)
-        conn.set_tunnel(URLObj.netloc, URLObj.port)
-    else:
-        if URLObj.netloc == "http":
-            conn = HTTPConnection(URLObj.netloc, URLObj.port)
-        else:
-            conn = HTTPSConnection(URLObj.netloc, URLObj.port)
-
-    headers = {}
-
-    if method == "GET":
-        if params:
-            action += '?' + urlencode(params)
-        params = ""
-    else:
-        headers["Content-Type"] = "application/x-www-form-urlencoded"
-
-    params = urlencode(params)
-
-    conn.request(method, 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:
-        debug('%s : result:%s', action, res)
-        return res
-
-
-def replace_params(domain, record_type, ip, params):
-    """
-    替换定义常量为实际值
-    """
-    dict = {"__DOMAIN__": domain, "__RECORDTYPE__": record_type,
-            "__TTL__": Config.TTL, "__TIMESTAMP__": time(), "__IP__": ip}
-    for key, value in params.items():
-        if dict.get(value):
-            params[key] = dict.get(value)
-    return params
+from json import loads as jsondecode
 
 
-def update_record(domain, value, record_type="A"):
+class CallbackProvider(SimpleProvider):
     """
-    更新记录
+    通用自定义回调 Provider，支持 GET/POST 任意接口。
+    Generic custom callback provider, supports GET/POST arbitrary API.
     """
-    info(">>>>>%s(%s)", domain, record_type)
-
-    result = {}
-
-    if not Config.TOKEN:  # 此处使用 TOKEN 参数透传 POST 参数所用的 JSON
-        method = "GET"
-        URLObj = urlparse(Config.ID)
-        path = URLObj.path
-        query = dict(parse_qsl(URLObj.query))
-        params = replace_params(domain, record_type, value, query)
-    else:
-        method = "POST"
-        URLObj = urlparse(Config.ID)
-        path = URLObj.path
-        params = replace_params(domain, record_type,
-                                value, jsondecode(Config.TOKEN))
-
-    res = request(method, path, params)
-
-    if res:
-        result = "Callback Request Success!\n" + res
-    else:
-        result = "Callback Request Fail!\n"
 
-    return result
+    endpoint = ""  # CallbackProvider uses id as URL, no fixed API endpoint
+    content_type = TYPE_JSON
+    decode_response = False  # Callback response is not JSON, it's a custom response
+
+    def set_record(self, domain, value, record_type="A", ttl=None, line=None, **extra):
+        """
+        发送自定义回调请求，支持 GET/POST
+        Send custom callback request, support GET/POST
+        """
+        self.logger.info("%s => %s(%s)", domain, value, record_type)
+        url = self.id  # 直接用 id 作为 url
+        token = self.token  # token 作为 POST 参数
+        extra.update(
+            {
+                "__DOMAIN__": domain,
+                "__RECORDTYPE__": record_type,
+                "__TTL__": ttl,
+                "__IP__": value,
+                "__TIMESTAMP__": time(),
+                "__LINE__": line,
+            }
+        )
+        url = self._replace_vars(url, extra)
+        method, params = "GET", None
+        if token:
+            # 如果有 token，使用 POST 方法
+            method = "POST"
+            # POST 方式，token 作为 POST 参数
+            params = token if isinstance(token, dict) else jsondecode(token)
+            for k, v in params.items():
+                if hasattr(v, "replace"):  # 判断是否支持字符串替换, 兼容py2,py3
+                    params[k] = self._replace_vars(v, extra)
+
+        try:
+            res = self._http(method, url, body=params)
+            if res is not None:
+                self.logger.info("Callback result: %s", res)
+                return True
+            else:
+                self.logger.warning("Callback received empty response.")
+        except Exception as e:
+            self.logger.error("Callback failed: %s", e)
+        return False
+
+    def _replace_vars(self, string, mapping):
+        # type: (str, dict) -> str
+        """
+        替换字符串中的变量为实际值
+        Replace variables in string with actual values
+        """
+        for k, v in mapping.items():
+            string = string.replace(k, str(v))
+        return string
+
+    def _validate(self):
+        # CallbackProvider uses id as URL, not as regular ID
+        if self.endpoint or (not self.id or "://" not in self.id):
+            # 如果 endpoint 已经设置，或者 id 不是有效的 URL，则抛出异常
+            self.logger.critical("endpoint [%s] or id [%s] 必须是有效的URL", self.endpoint, self.id)
+            raise ValueError("endpoint or id must be configured with URL")

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 TYPE_JSON, BaseProvider, 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):
+    endpoint = "https://api.cloudflare.com"
+    content_type = TYPE_JSON
 
+    def _validate(self):
+        if not self.token:
+            raise ValueError("token must be configured")
+        if self.id:
+            # must be email for Cloudflare API v4
+            if "@" not in self.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.id:
+            headers["X-Auth-Email"] = self.id
+            headers["X-Auth-Key"] = self.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.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
+        )  # fmt: skip
+        self.logger.debug("Record updated: %s", data)
+        if data:
+            return True
+        return False

ddns/provider/debug.py

@@ -0,0 +1,19 @@
+# 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