/
__main__.py
211 lines (200 loc) · 8.93 KB
/
__main__.py
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
# pyCloudFlareUpdater
# Copyright (C) 2019 - Javinator9889
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import traceback
from argparse import ArgumentParser
from argparse import SUPPRESS
from logging import getLogger
from os import makedirs
from os import path
from time import sleep
from daemonize import Daemonize
from .logging_utils import LoggingHandler
from .logging_utils import setup_logging
from .network import CloudFlare
from .network import get_machine_public_ip
from .preferences import UserPreferences
from .values import description
preferences = UserPreferences()
def main():
log = LoggingHandler(logs=[getLogger("cloudflareLogger")])
loop_continuation = True
try:
net = CloudFlare(domain=preferences.get_domain(),
name=preferences.get_name(),
key=preferences.get_key(),
mail=preferences.get_mail(),
proxied=preferences.is_record_behind_proxy())
while loop_continuation:
current_ip = get_machine_public_ip()
log.info("Current machine IP: \"{0}\"".format(current_ip))
if preferences.get_latest_ip() == "0.0.0.0":
preferences.set_latest_ip(net.get_cloudflare_latest_ip())
log.warning("User saved latest IP is not up to date - downloading CloudFlare A Record value: \"{0}\""
.format(preferences.get_latest_ip()))
if preferences.get_latest_ip() != current_ip:
log.info("IP needs an upgrade - OLD IP: {0} | NEW IP: {1}"
.format(preferences.get_latest_ip(), current_ip))
result = net.set_cloudflare_ip(current_ip)
log.info("IP updated correctly! - Operation return code: {0}".format(result))
log.debug("Updating saved IP...")
preferences.set_latest_ip(current_ip)
else:
log.info("IP has not changed - skipping")
if not preferences.is_running_as_daemon():
log.info("This script is only executed once. Finishing...")
loop_continuation = False
else:
log.info("Next check in about {0} minute{1}"
.format((preferences.get_time() / 60),
's' if (preferences.get_time() / 60) > 1 else ''))
sleep(preferences.get_time())
except KeyboardInterrupt:
log.warning("Received SIGINT - exiting...")
except Exception as e:
log.error("Exception registered! - " + str(e))
log.error("Stacktrace: " + traceback.format_exc())
finally:
preferences.save_preferences()
exit(0)
def parser():
is_first_execution = not preferences.are_preferences_stored()
args = ArgumentParser(description=description,
allow_abbrev=False)
args.add_argument("--domain",
type=str,
required=is_first_execution,
help="CloudFlare domain to be updated.")
args.add_argument("--name",
type=str,
required=is_first_execution,
help="CloudFlare 'A' Record name.")
args.add_argument("--time",
type=int,
default=SUPPRESS,
required=False,
help="Time (in minutes) to check for updated IP (defaults: 5 min.) - must be higher than 0.")
args.add_argument("--key",
type=str,
required=is_first_execution,
help="CloudFlare API key.")
args.add_argument("--mail",
type=str,
required=is_first_execution,
help="CloudFlare sign-in mail.")
args.add_argument("--proxied",
action="store_true",
required=is_first_execution,
default=False,
help="Set this value if you want your 'A' Record to be behind the Cloudflare proxy "
"(disabled by default).")
args.add_argument("--no_daemonize",
action="store_true",
required=False,
default=False,
help="By default, the program runs as a daemon in background. With this option enabled, "
"the program will run only once and then exit.")
args.add_argument("--pid",
type=str,
default=SUPPRESS,
required=False,
metavar="PID FILE",
help="Specifies a custom PID file for storing current daemon PID.")
args.add_argument("--log",
type=str,
default=SUPPRESS,
required=False,
metavar="LOG FILE",
help="Specifies a custom LOG file for storing current daemon logs.")
args.add_argument("--preferences",
type=str,
default="cloudflare.user.preferences",
required=False,
metavar="PREFERENCES FILE",
help="Provide a custom preferences file - useful for multiple running daemon for different 'A'"
"Records. NOTICE THAT YOU MUST PROVIDE ALL REQUIRED PARAMS FOR A NEW CONFIGURATION")
args.add_argument("--user",
type=str,
default=None,
required=False,
metavar="USERNAME",
help="Run the daemon as the specified user.")
args.add_argument("--group",
type=str,
default=None,
required=False,
metavar="GROUP NAME",
help="Run the daemon as the specified group.")
p_args = args.parse_args()
should_save_preferences = False
if p_args.domain:
preferences.set_domain(p_args.domain)
should_save_preferences = True
if p_args.name:
preferences.set_name(p_args.name)
should_save_preferences = True
if "time" in p_args:
preferences.set_time(p_args.time * 60)
should_save_preferences = True
else:
if preferences.get_time() is None:
preferences.set_time(300)
if p_args.key:
preferences.set_key(p_args.key)
should_save_preferences = True
if p_args.mail:
preferences.set_mail(p_args.mail)
should_save_preferences = True
if p_args.no_daemonize:
preferences.run_as_daemon(not p_args.no_daemonize)
if "pid" in p_args:
preferences.set_pid_file(p_args.pid)
should_save_preferences = True
else:
if preferences.get_pid_file() is None:
preferences.set_pid_file("/var/run/cloudflare.pid")
if "log" in p_args:
preferences.set_log_file(p_args.log)
should_save_preferences = True
else:
if preferences.get_log_file() is None:
preferences.set_log_file("/var/log/cloudflare.log")
user = p_args.user
group = p_args.group
if p_args.preferences:
if not (p_args.domain and p_args.name and p_args.key and p_args.mail):
print("You must provide the required params for a new preferences file")
if should_save_preferences:
preferences.save_preferences(p_args.preferences)
if not is_first_execution:
preferences.load_preferences()
if preferences.is_record_behind_proxy() != p_args.proxied:
preferences.record_behind_proxy(p_args.proxied)
preferences.save_preferences()
file_handler = setup_logging("cloudflareLogger", preferences.get_log_file())
fds = [file_handler.stream.fileno()]
pid_dir = path.dirname(path.abspath(preferences.get_pid_file()))
if not path.exists(pid_dir):
makedirs(path=pid_dir, exist_ok=True)
daemon = Daemonize(app="pyCloudFlareDaemon",
pid=preferences.get_pid_file(),
action=main,
keep_fds=fds,
user=user,
group=group,
logger=getLogger("cloudflareLogger"))
daemon.start()
if __name__ == '__main__':
parser()