-
Notifications
You must be signed in to change notification settings - Fork 360
/
Config.py
192 lines (158 loc) · 6.81 KB
/
Config.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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Contest Management System - http://cms-dev.github.io/
# Copyright © 2011-2016 Luca Wehrstedt <luca.wehrstedt@gmail.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from future.builtins.disabled import * # noqa
from future.builtins import * # noqa
from six import iteritems
import io
import errno
import json
import logging
import os
import pkg_resources
import sys
from cmsranking.Logger import add_file_handler
logger = logging.getLogger(__name__)
CMS_RANKING_CONFIG_ENV_VAR = "CMS_RANKING_CONFIG"
class Config(object):
"""An object holding the current configuration.
"""
def __init__(self):
"""Fill this object with the default values for each key.
"""
# Connection.
self.bind_address = ''
self.http_port = 8890
self.https_port = None
self.https_certfile = None
self.https_keyfile = None
self.timeout = 600 # 10 minutes (in seconds)
# Authentication.
self.realm_name = 'Scoreboard'
self.username = 'usern4me'
self.password = 'passw0rd'
# Buffers
self.buffer_size = 100 # Needs to be strictly positive.
# File system.
# TODO: move to cmscommon as it is used both here and in cms/conf.py
bin_path = os.path.join(os.getcwd(), sys.argv[0])
bin_name = os.path.basename(bin_path)
bin_is_python = bin_name in ["ipython", "python", "python2", "python3"]
bin_in_installed_path = bin_path.startswith(sys.prefix) or (
hasattr(sys, 'real_prefix')
and bin_path.startswith(sys.real_prefix))
self.installed = bin_in_installed_path and not bin_is_python
self.web_dir = pkg_resources.resource_filename("cmsranking", "static")
if self.installed:
self.log_dir = os.path.join("/", "var", "local", "log",
"cms", "ranking")
self.lib_dir = os.path.join("/", "var", "local", "lib",
"cms", "ranking")
self.conf_paths = [os.path.join("/", "usr", "local", "etc",
"cms.ranking.conf"),
os.path.join("/", "etc", "cms.ranking.conf")]
else:
self.log_dir = os.path.join("log", "ranking")
self.lib_dir = os.path.join("lib", "ranking")
self.conf_paths = [os.path.join(".", "config", "cms.ranking.conf"),
os.path.join("/", "usr", "local", "etc",
"cms.ranking.conf"),
os.path.join("/", "etc", "cms.ranking.conf")]
# Allow users to override config file path using environment
# variable 'CMS_RANKING_CONFIG'.
if CMS_RANKING_CONFIG_ENV_VAR in os.environ:
self.conf_paths = [os.environ[CMS_RANKING_CONFIG_ENV_VAR]] \
+ self.conf_paths
def get(self, key):
"""Get the config value for the given key.
"""
return getattr(self, key)
def load(self, config_override_fobj=None):
"""Look for config files on disk and load them.
"""
# If a command-line override is given it is used exclusively.
if config_override_fobj is not None:
if not self._load_one(config_override_fobj):
sys.exit(1)
else:
if not self._load_many(self.conf_paths):
sys.exit(1)
try:
os.makedirs(self.lib_dir)
except OSError:
pass # We assume the directory already exists...
try:
os.makedirs(self.web_dir)
except OSError:
pass # We assume the directory already exists...
try:
os.makedirs(self.log_dir)
except OSError:
pass # We assume the directory already exists...
add_file_handler(self.log_dir)
def _load_many(self, conf_paths):
"""Load the first existing config file among the given ones.
Take a list of paths where config files may reside and attempt
to load the first one that exists.
conf_paths([str]): paths of config file candidates, from most
to least prioritary.
returns (bool): whether loading was successful.
"""
for conf_path in conf_paths:
try:
with io.open(conf_path, "rt") as conf_fobj:
logger.info("Using config file %s.", conf_path)
return self._load_one(conf_fobj)
except IOError as error:
# If it's because it doesn't exist we just skip to the
# next one. Otherwise it's probably unintended and the
# user should do something about it.
if error.errno != errno.ENOENT:
logger.critical("Unable to access config file %s: %s.",
conf_path, os.strerror(error.errno))
return False
logger.warning("No config file found, using hardcoded defaults.")
return True
def _load_one(self, conf_fobj):
"""Populate config parameters from the given file.
Parse it as JSON and store in self all configuration properties
it defines. Log critical message and return False if anything
goes wrong or seems odd.
conf_fobj (file-like object): the config file.
returns (bool): whether parsing was successful.
"""
# Parse config file.
try:
data = json.load(conf_fobj)
except ValueError:
logger.critical("Config file is invalid JSON.")
return False
# Store every config property.
for key, value in iteritems(data):
if key.startswith("_"):
continue
if not hasattr(self, key):
logger.critical("Invalid field %s in config file, maybe a "
"typo? (use leading underscore to ignore).",
key)
return False
setattr(self, key, value)
return True