├── .gitignore ├── LICENSE ├── README.md ├── config.py ├── dnspod_ddns.py └── requirements.txt /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | lib/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # PyInstaller 26 | # Usually these files are written by a python script from a template 27 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 28 | *.manifest 29 | *.spec 30 | 31 | # Installer logs 32 | pip-log.txt 33 | pip-delete-this-directory.txt 34 | 35 | # Unit test / coverage reports 36 | htmlcov/ 37 | .tox/ 38 | .coverage 39 | .cache 40 | nosetests.xml 41 | coverage.xml 42 | 43 | # Translations 44 | *.mo 45 | *.pot 46 | 47 | # Django stuff: 48 | *.log 49 | 50 | # Sphinx documentation 51 | docs/_build/ 52 | 53 | # PyBuilder 54 | target/ 55 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Introduction 2 | ============ 3 | 4 | **dnspod_ddns** a Python tool to dynamic update DNS record at DNSPod. 5 | 6 | Installing 7 | ========== 8 | 9 | Clone the repo with `git` and install the requirements with `pip`: 10 | ``` 11 | $ git clone https://github.com/leeyiw/dnspod_ddns.git 12 | $ cd dnspod_ddns 13 | $ sudo pip install -r requirements.txt 14 | ``` 15 | 16 | Then edit `config.py`, replace the value of `LOGIN_EMAIL`, `LOGIN_PASSWORD`, `SUB_DOMAIN`, `DOMAIN` with your DNSPod account and the domain you want to dynamic update. 17 | 18 | Usage 19 | ===== 20 | 21 | Command line options are: 22 | ``` 23 | Usage: 24 | dnspod_ddns.py [options] 25 | 26 | Options: 27 | -h --help Show this screen. 28 | -t TIME Check IP change every TIME seconds [default: 60]. 29 | -d ACTION Run this script as a daemon (e.g. start,stop,restart). 30 | -l LOG_PATH Program log file [default: /var/log/dnspod_ddns.log]. 31 | -p PID_FILE Use PID_FILE as daemon's pid file [default: /var/run/dnspod_ddns.pid]. 32 | ``` 33 | 34 | You can run this script as a daemon with command: 35 | ``` 36 | sudo python dnspod_ddns.py -d start 37 | ``` 38 | 39 | Or run it in foreground mode with the following command (`-l` and `-p` options will be ignored, and log will output to console): 40 | ``` 41 | python dnspod_ddns.py 42 | ``` 43 | -------------------------------------------------------------------------------- /config.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | #-*- coding: utf-8 -*- 3 | 4 | LOGIN_EMAIL = 'your@email.here' 5 | LOGIN_PASSWORD = 'your_password_here' 6 | SUB_DOMAIN = 'www' 7 | DOMAIN = 'your-domain.here' 8 | -------------------------------------------------------------------------------- /dnspod_ddns.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | #-*- coding: utf-8 -*- 3 | 4 | ''' 5 | Usage: 6 | dnspod_ddns.py [options] 7 | 8 | Options: 9 | -h --help Show this screen. 10 | -t TIME Check IP change every TIME seconds [default: 60]. 11 | -l LOG_PATH Program log file [default: /var/log/dnspod_ddns.log]. 12 | -p PID_FILE Use PID_FILE as daemon's pid file [default: /var/run/dnspod_ddns.pid]. 13 | -d ACTION Run this script as a daemon (e.g. start,stop,restart). 14 | 15 | ''' 16 | 17 | def handle_import_error(): 18 | print 'Please install 3rd-party modules required by dnspod_ddns.py with following command:' 19 | print ' sudo pip install -r requirements.txt' 20 | import sys 21 | sys.exit() 22 | 23 | try: 24 | from daemon import runner 25 | except ImportError: 26 | handle_import_error() 27 | import docopt 28 | import logging 29 | import logging.handlers 30 | import os 31 | import socket 32 | import sys 33 | import time 34 | 35 | try: 36 | from dnspod.base import BaseAPI 37 | from dnspod.domain import DomainAPI 38 | from dnspod.record import Record, RecordAPI 39 | except ImportError: 40 | handle_import_error() 41 | 42 | import config 43 | 44 | class App(object): 45 | ''' 46 | main application called by daemon.runner 47 | ''' 48 | 49 | def __init__(self, args): 50 | self.stdin_path = os.devnull 51 | self.stdout_path = os.devnull 52 | self.stderr_path = os.devnull 53 | self.pidfile_path = args['-p'] 54 | self.pidfile_timeout = 3 55 | 56 | self._args = args 57 | 58 | def run(self): 59 | # Set up logger 60 | logger = logging.getLogger() 61 | logger.setLevel(logging.INFO) 62 | formatter = logging.Formatter('[%(asctime)s %(levelname)s] %(message)s') 63 | if self._args['-d'] == None: 64 | handler = logging.StreamHandler() 65 | else: 66 | handler = logging.handlers.RotatingFileHandler(self._args['-l'], 67 | maxBytes=1*1024*1024, 68 | backupCount=1) 69 | handler.setFormatter(formatter) 70 | logger.addHandler(handler) 71 | 72 | bapi = BaseAPI(config.LOGIN_EMAIL, config.LOGIN_PASSWORD) 73 | dapi = DomainAPI(bapi) 74 | rapi = RecordAPI(bapi) 75 | domain = dapi.info(domain=config.DOMAIN) 76 | record_list = rapi.list(domain.id) 77 | record = None 78 | for rec in record_list: 79 | if rec.sub_domain == config.SUB_DOMAIN and \ 80 | rec.record_type == Record.TYPE_A: 81 | record = rec 82 | break 83 | if record == None: 84 | logger.error("Couldn't get A record of domain: %s.%s", 85 | config.SUB_DOMAIN, config.DOMAIN) 86 | return 87 | 88 | last_ip = record.value 89 | while True: 90 | try: 91 | current_ip = get_ip() 92 | except socket.error, e: 93 | logger.error('Get current IP error: %s', e) 94 | else: 95 | if current_ip != last_ip: 96 | logger.info('IP change from %s to %s, update DNS record', 97 | last_ip, current_ip) 98 | rapi.ddns(record.domain_id, record.id, record.sub_domain, 99 | record.record_line, current_ip) 100 | last_ip = current_ip 101 | else: 102 | logger.info('IP not change, check after %d seconds', 103 | int(self._args['-t'])) 104 | time.sleep(int(self._args['-t'])) 105 | 106 | def get_ip(): 107 | sock = socket.create_connection(('ns1.dnspod.net', 6666), timeout=30) 108 | ip = sock.recv(16) 109 | sock.close() 110 | return ip 111 | 112 | def main(): 113 | try: 114 | arguments = docopt.docopt(__doc__) 115 | except docopt.DocoptExit: 116 | print __doc__.strip() 117 | return 118 | app = App(arguments) 119 | action = arguments['-d'] 120 | if action != None: 121 | if action in ['start', 'stop', 'restart']: 122 | sys.argv[1] = action 123 | daemon_runner = runner.DaemonRunner(app) 124 | daemon_runner.do_action() 125 | else: 126 | print __doc__.strip() 127 | return 128 | else: 129 | app.run() 130 | 131 | if __name__ == '__main__': 132 | main() 133 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | python-daemon 2 | dnspod 3 | docopt 4 | --------------------------------------------------------------------------------