File: __init__.py

package info (click to toggle)
python-freenom 0.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 120 kB
  • sloc: python: 283; makefile: 4
file content (350 lines) | stat: -rw-r--r-- 11,663 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# -*- coding: utf-8 -*-
"""
:author: Punk Lee
:datetime: 2020/4/21 22:02
:url: https://punk_lee.gitee.io/
:copyright: ©2020 Punk Lee <punklee333@gmail.com>
"""
import requests, os, json
from sys import exit
from lxml.html import etree
from retrying import retry
from datetime import datetime
from http.cookiejar import MozillaCookieJar


def secure_retry(f):
    from functools import wraps
    @wraps(f)
    def inner(*args, **kwargs):
        try:
            return f(*args, **kwargs)
        except Exception as e:
            print(e)
            exit()

    return inner


def _retry_on_exception(e):
    _retry = isinstance(e, (requests.ConnectTimeout,
                            requests.ReadTimeout))
    if not _retry:
        print(e)
        exit()
    return _retry


dkw = {
    'stop_max_attempt_number': 3,
    'wait_random_min': 2000,
    'wait_random_max': 6000,
    'retry_on_exception': _retry_on_exception
}


class Freenom:
    def __init__(self, username, password, **kwargs):
        """
        init params
        :param username: your username
        :type username: str
        :param password: your password
        :type password: str
        """
        # path setup
        self._path = os.getcwd()
        self._cookies_path = os.path.join(os.getcwd(), 'cookies_data')
        self._data_path = os.path.join(os.getcwd(), 'freenom_data')
        # user setup
        self.username = username
        self.password = password
        # request setup
        self.headers = {
            'Host': 'my.freenom.com',
            'Referer': 'https://my.freenom.com/clientarea.php',
            'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36'
        }
        self.session = requests.session()
        self.session.headers = self.headers
        self.token = ''
        # cookies setup
        cookies = MozillaCookieJar(filename=self._cookies_path)
        if os.path.isfile(self._cookies_path):
            cookies.load(self._cookies_path, ignore_discard=True, ignore_expires=True)
        self.session.cookies = cookies
        # option setup --dev
        self.timeout = kwargs.get('timeout', 22)
        self.saveHtml = kwargs.get('saveHtml', False)

        self._RequireData()

    @secure_retry
    @retry(**dkw)
    def _request(self, req, url, **kwargs):
        kwargs = {
            'data': kwargs.get('data', {}),
            'timeout': kwargs.get('timeout', self.timeout),
            'headers': kwargs.get('headers', self.headers)
        }
        # send request
        res = req(url, **kwargs)

        # is loggedIn?
        loggedIn = self._parse(res.content.decode(), '//body/@class')[0]
        if not 'loggedIn' in loggedIn:
            self.token = self._parse(res.content.decode(), '//input[@name="token"]/@value')[0]
            self.doLogin()
            raise requests.ConnectTimeout

        return res

    def _saveHtml(self, html_text, filename='res'):
        if self.saveHtml:
            with open(f'{self._path}/{filename}.html', 'w', encoding='utf-8') as f:
                time = f"{datetime.now().strftime('%Y-%m-%d %H:%M:%S')}\n"
                f.write(f'<!--{time}-->')
                f.write(html_text)

    def _parse(self, html_text, xpath):
        try:
            self._saveHtml(html_text)
            element = etree.HTML(html_text)
            return element.xpath(xpath)
        except Exception as e:
            print('parse fail:', end=' ')
            return []

    def _getData(self):
        """get local domain_data"""
        data = {}
        try:
            if not os.path.isfile(self._data_path):
                self._RequireData()
            with open(self._data_path, encoding='utf-8') as f:
                data = json.loads(f.read())
        except Exception as e:
            print(e)
            return data

        return data

    def _RequireData(self):
        """Cache all domain and domain_id to local"""
        domains_data = {}
        url = "https://my.freenom.com/clientarea.php?action=domains"
        res = self._request(self.session.get, url)
        # parse html text
        domains = self._parse(res.text, "//td[@class='second']//text()")
        href = self._parse(res.text, "//td[@class='seventh']//a/@href")
        if domains and href:
            domains = [i.strip() for i in domains[:] if i.strip()]
            id = [i.split('=')[-1] for i in href[:]]
            domains_data = dict(zip(domains, id))
        # Save as local file
        f = open(self._data_path, 'w', encoding='utf-8')
        f.write(json.dumps(domains_data))
        f.close()

        return domains_data

    def _getRecordList(self, domain, domainid):
        data = []

        url = 'https://my.freenom.com/clientarea.php?managedns=%s&domainid=%s' % (domain, domainid)
        res = self._request(self.session.get, url)
        recordslist = self._parse(res.content.decode(), '//*[@id="recordslistform"]/table/tbody/tr')
        if recordslist:
            for record in recordslist:
                tmp_list = []
                name = record.xpath('./td[@class="name_column"]//input[@type="text"]/@value')[0]
                type = record.xpath('./td[@class="type_column"]//text()')[0]
                ttl = record.xpath('./td[@class="ttl_column"]//input[@type="text"]/@value')[0]
                target = record.xpath('./td[@class="value_column"]//input[@type="text"]/@value')[0]
                tmp_list.append(name)
                tmp_list.append(type)
                tmp_list.append(ttl)
                tmp_list.append(target)
                data.append(tmp_list)

        return data

    def _isAddRecord(self, records, name):
        # No records
        if not records:
            return True
        # no name in records
        for record in records:
            if name == record[0]:
                return False

        return True

    def _showDnsResult(self, html_text, xpath_list):
        # show dns result
        if not html_text:
            print('no html text')
            return
        for xpath in xpath_list:
            dns_res = self._parse(html_text, xpath)
            if dns_res:
                print(dns_res[0])
                return
        print('cannot find dns result')
        return

    @secure_retry
    @retry(**dkw)
    def doLogin(self, username=None, password=None):
        print('doLogin:', end=' ')

        url = 'https://my.freenom.com/dologin.php'
        form_data = {
            'token': self.token if self.token else '',
            'username': username if username else self.username,
            'password': password if password else self.password
        }

        # send request and save cookies as local
        res = self.session.post(url, data=form_data)
        if res.url.find('incorrect=true') != -1:
            print(self._parse(res.content.decode(), '//div[contains(@class,"error-message")]/p/text()')[0])
            exit()
        else:
            self.session.cookies.save(ignore_discard=True, ignore_expires=True)
            print('Login successfully.')

    def setRecord(self, domain, name, type, target, ttl='3600'):
        """
        add or modify record
        :param domain: <xxx.ga>
        :param name: <www>
        :param type: <CNAME>
        :param target: <0.0.0.0>
        :param kwargs: ttl|...
        :type domain: str
        :type name: str
        :type type: str
        :type target: str
        :type ttl: str
        """
        data = self._getData()
        print('setRecord:', end=' ')
        if not domain in data:
            print('No data found for this domain')
            return

        # init params
        url = 'https://my.freenom.com/clientarea.php?managedns=%s&domainid=%s'
        name = name.upper()
        type = type.upper()
        ttl = str(ttl)
        target = str(target)
        # add or modify?
        records = self._getRecordList(domain, data.get(domain))
        if self._isAddRecord(records, name):
            # add
            form_data = {
                'token': '',
                'dnsaction': 'add',
                'addrecord[0][name]': name,
                'addrecord[0][type]': type,
                'addrecord[0][ttl]': ttl,
                'addrecord[0][value]': target,
            }
        else:
            # modify
            form_data = {
                'token': '',
                'dnsaction': 'modify',
            }
            for i in range(len(records)):
                if type == records[i][1]:
                    if name == records[i][0]:
                        records[i][3] = target
                form_data[f'records[{i}][name]'] = records[i][0]
                form_data[f'records[{i}][type]'] = records[i][1]
                form_data[f'records[{i}][ttl]'] = records[i][2]
                form_data[f'records[{i}][value]'] = records[i][3]

        # send request
        res = self._request(self.session.post, url % (domain, data.get(domain)), data=form_data)
        # show dns result
        self._showDnsResult(res.content.decode(),
                            ['//div[@class="recordslist"]/ul/li/text()',
                             '//section[@class="domainContent"]//p/text()'])

    def delRecord(self, domain, name, type='', target='', ttl='3600'):
        """
        del record
        :param domain: <xxx.ga>
        :param name: <www>
        :param type: <CNAME>
        :param target: <0.0.0.0>
        :param kwargs: ttl|...
        :type domain: str
        :type name: str
        :type type: str
        :type target: str
        :type ttl: str
        """
        data = self._getData()
        print('delRecord:', end=' ')
        if not domain in data:
            print('No data found for this domain')
            return

        # init params
        url = 'https://my.freenom.com/clientarea.php?' \
              'managedns={}&' \
              'records={}&' \
              'dnsaction=delete&' \
              'name={}&' \
              'value={}&' \
              'ttl={}&' \
              'domainid={}'
        name = name.upper()
        type = type.upper()
        ttl = str(ttl)
        target = str(target)
        domainid = data.get(domain, '')
        records = self._getRecordList(domain, domainid)
        if records:
            for record in records:
                if name == record[0]:
                    type = record[1]
                    ttl = record[2]
                    target = record[3]

            # send request
            res = self._request(self.session.get, url.format(domain, type, name, target, ttl, domainid))
            # show dns result
            # show dns result
            self._showDnsResult(res.content.decode(),
                                ['//div[@class="recordslist"]/ul/li/text()',
                                 '//section[@class="domainContent"]//p/text()'])
        else:
            print('no records to delete')

    def showRecords(self, domain):
        data = self._getData()
        if not domain in data:
            print('No data found for this domain')
            return

        records = self._getRecordList(domain, data.get(domain, ''))
        print(f'{domain:-^38}')
        if records:
            for record in records:
                print(record)
        else:
            print(f'{"No records to display":-^38}')

    @secure_retry
    @retry(**dkw)
    def getPublicIP(self, url='https://api.ipify.org'):
        print('PublicIP:', end=' ')
        res = requests.get(url, timeout=self.timeout)
        pub_ip = res.content.decode()
        print(pub_ip)
        return pub_ip