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
|
import jsonschema
import os
import yaml
import logging
from colorlog import ColoredFormatter
log_level = logging.DEBUG
log_format = (
" %(log_color)s%(levelname)-8s%(reset)s |"
" %(log_color)s%(message)s%(reset)s"
)
logging.root.setLevel(log_level)
formatter = ColoredFormatter(log_format)
stream = logging.StreamHandler()
stream.setLevel(log_level)
stream.setFormatter(formatter)
LOG = logging.getLogger("pythonConfig")
LOG.setLevel(log_level)
LOG.addHandler(stream)
IP_TO_LOCATION = None
API_KEY = None
DB_NAME = None
DB_ENGINE = None
DB_HOST = None
DB_PORT = None
DB_USER = None
DB_PASSWORD = None
schema = {
"type": "object",
"properties": {
"config": {
"type": "object",
"properties": {
"ip_to_location": {"type": "boolean"},
"api_key": {"type": "string"},
},
"required": ["ip_to_location"],
},
"database": {
"type": "object",
"properties": {
"name": {"type": "string", "default": "linklogger"},
"engine": {"type": "string"},
"host": {"type": "string"},
"port": {"type": "integer"},
"user": {"type": "string"},
"password": {"type": "string"},
},
"required": [
"name",
"engine",
"host",
"port",
"user",
"password",
],
},
},
"required": ["config"],
}
# Load config file or create new template
def load_config():
if os.path.exists("/.dockerenv"):
file_path = "/data/config.yaml"
else:
file_path = "config.yaml"
try:
with open(file_path, "r") as f:
file_contents = f.read()
if not validate_config(file_contents):
return False
else:
return True
except FileNotFoundError:
# Create new config.yaml w/ template
with open(file_path, "w") as f:
f.write(
"""config:
ip_to_location: false
api_key: ''
database:
engine: 'sqlite'
name: ''
host: ''
port: 0
user: ''
password: ''"""
)
LOG.critical(
"`config.yaml` was not found, a template has been created."
" Please fill out the necessary information and restart."
)
return False
# Validate the options within config.yaml
def validate_config(file_contents):
global IP_TO_LOCATION, API_KEY, DB_NAME, DB_ENGINE, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD
config = yaml.safe_load(file_contents)
try:
jsonschema.validate(config, schema)
except jsonschema.ValidationError as e:
LOG.error(e.message)
return False
# Make IP_TO_LOCATION a boolean
IP_TO_LOCATION = bool(config["config"]["ip_to_location"])
# Validate API_KEY if IP_TO_LOCATION is set to TRUE
if IP_TO_LOCATION:
if not config["config"]["api_key"]:
LOG.error("API_KEY is not set")
return False
else:
API_KEY = config["config"]["api_key"]
#
# Set/Validate the DATABASE section of the config.yaml
#
if "database" in config:
if config["database"]["engine"] not in [
"sqlite",
"mysql",
"postgresql",
]:
LOG.error(
"database_engine must be either 'sqlite', 'mysql', or"
" 'postgresql'"
)
return False
else:
DB_ENGINE = config["database"]["engine"]
DB_NAME = config["database"]["name"]
DB_HOST = config["database"]["host"]
DB_PORT = config["database"]["port"]
DB_USER = config["database"]["user"]
DB_PASSWORD = config["database"]["password"]
return True
|
