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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
|
# -*- coding: utf-8 -*-
#
# Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
# This file is part of GlusterFS.
#
# This file is licensed to you under your choice of the GNU Lesser
# General Public License, version 3 or any later version (LGPLv3 or
# later), or the GNU General Public License, version 2 (GPLv2), in all
# cases as published by the Free Software Foundation.
#
try:
from ConfigParser import RawConfigParser, NoSectionError
except ImportError:
from configparser import RawConfigParser, NoSectionError
import os
import shutil
from string import Template
from datetime import datetime
from threading import Lock
# Global object which can be used in other modules
# once load_config is called
_gconf = {}
class GconfNotConfigurable(Exception):
pass
class GconfInvalidValue(Exception):
pass
class Gconf(object):
def __init__(self, default_conf_file, custom_conf_file=None,
args={}, extra_tmpl_args={}, override_from_args=False):
self.lock = Lock()
self.default_conf_file = default_conf_file
self.custom_conf_file = custom_conf_file
self.tmp_conf_file = None
self.gconf = {}
self.gconfdata = {}
self.gconf_typecast = {}
self.template_conf = []
self.non_configurable_configs = []
self.prev_mtime = 0
if custom_conf_file is not None:
self.tmp_conf_file = custom_conf_file + ".tmp"
self.session_conf_items = []
self.args = args
self.extra_tmpl_args = extra_tmpl_args
self.override_from_args = override_from_args
# Store default values only if overwritten, Only for JSON/CLI output
self.default_values = {}
self._load()
def _tmpl_substitute(self):
tmpl_values = {}
for k, v in self.gconf.items():
tmpl_values[k.replace("-", "_")] = v
# override the config file values with the one user passed
for k, v in self.args.items():
# override the existing value only if set by user
if v is not None:
tmpl_values[k] = v
for k, v in self.extra_tmpl_args.items():
tmpl_values[k] = v
for k, v in self.gconf.items():
if k in self.template_conf and \
(isinstance(v, str) or isinstance(v, unicode)):
self.gconf[k] = Template(v).safe_substitute(tmpl_values)
def _do_typecast(self):
for k, v in self.gconf.items():
cast_func = globals().get(
"to_" + self.gconf_typecast.get(k, "string"), None)
if cast_func is not None:
self.gconf[k] = cast_func(v)
if self.default_values.get(k, None) is not None:
self.default_values[k] = cast_func(v)
def reset(self, name):
# If custom conf file is not set then it is only read only configs
if self.custom_conf_file is None:
raise GconfNotConfigurable()
# If a config can not be modified
if name != "all" and not self._is_configurable(name):
raise GconfNotConfigurable()
cnf = RawConfigParser()
with open(self.custom_conf_file) as f:
cnf.readfp(f)
# Nothing to Reset, Not configured
if name != "all":
if not cnf.has_option("vars", name):
return True
# Remove option from custom conf file
cnf.remove_option("vars", name)
else:
# Remove and add empty section, do not disturb if config file
# already has any other section
try:
cnf.remove_section("vars")
except NoSectionError:
pass
cnf.add_section("vars")
with open(self.tmp_conf_file, "w") as fw:
cnf.write(fw)
os.rename(self.tmp_conf_file, self.custom_conf_file)
self.reload()
return True
def set(self, name, value):
if self.custom_conf_file is None:
raise GconfNotConfigurable()
if not self._is_configurable(name):
raise GconfNotConfigurable()
if not self._is_valid_value(name, value):
raise GconfInvalidValue()
curr_val = self.gconf.get(name, None)
if curr_val == value:
return True
cnf = RawConfigParser()
with open(self.custom_conf_file) as f:
cnf.readfp(f)
if not cnf.has_section("vars"):
cnf.add_section("vars")
cnf.set("vars", name, value)
with open(self.tmp_conf_file, "w") as fw:
cnf.write(fw)
os.rename(self.tmp_conf_file, self.custom_conf_file)
self.reload()
return True
def check(self, name, value=None, with_conffile=True):
if with_conffile and self.custom_conf_file is None:
raise GconfNotConfigurable()
if not self._is_configurable(name):
raise GconfNotConfigurable()
if value is not None and not self._is_valid_value(name, value):
raise GconfInvalidValue()
def _load_with_lock(self):
with self.lock:
self._load()
def _load(self):
self.gconf = {}
self.template_conf = []
self.gconf_typecast = {}
self.non_configurable_configs = []
self.session_conf_items = []
self.default_values = {}
conf = RawConfigParser()
# Default Template config file
with open(self.default_conf_file) as f:
conf.readfp(f)
# Custom Config file
if self.custom_conf_file is not None:
with open(self.custom_conf_file) as f:
conf.readfp(f)
# Get version from default conf file
self.version = conf.get("__meta__", "version")
# Populate default values
for sect in conf.sections():
if sect in ["__meta__", "vars"]:
continue
# Collect list of available options with help details
self.gconfdata[sect] = {}
for k, v in conf.items(sect):
self.gconfdata[sect][k] = v.strip()
# Collect the Type cast information
if conf.has_option(sect, "type"):
self.gconf_typecast[sect] = conf.get(sect, "type")
# Prepare list of configurable conf
if conf.has_option(sect, "configurable"):
if conf.get(sect, "configurable").lower() == "false":
self.non_configurable_configs.append(sect)
# if it is a template conf value which needs to be substituted
if conf.has_option(sect, "template"):
if conf.get(sect, "template").lower().strip() == "true":
self.template_conf.append(sect)
# Set default values
if conf.has_option(sect, "value"):
self.gconf[sect] = conf.get(sect, "value").strip()
# Load the custom conf elements and overwrite
if conf.has_section("vars"):
for k, v in conf.items("vars"):
self.session_conf_items.append(k)
self.default_values[k] = self.gconf.get(k, "")
self.gconf[k] = v.strip()
# Overwrite the Secondary configurations which are sent as
# arguments to gsyncd secondary
if self.override_from_args:
for k, v in self.args.items():
k = k.replace("_", "-")
if k.startswith("secondary-") and k in self.gconf:
self.gconf[k] = v
self._tmpl_substitute()
self._do_typecast()
def reload(self, with_lock=True):
if self._is_config_changed():
if with_lock:
self._load_with_lock()
else:
self._load()
def get(self, name, default_value=None, with_lock=True):
if with_lock:
with self.lock:
return self.gconf.get(name, default_value)
else:
return self.gconf.get(name, default_value)
def getall(self, show_defaults=False, show_non_configurable=False):
cnf = {}
if not show_defaults:
for k in self.session_conf_items:
if k not in self.non_configurable_configs:
dv = self.default_values.get(k, "")
cnf[k] = {
"value": self.get(k),
"default": dv,
"configurable": True,
"modified": False if dv == "" else True
}
return cnf
# Show all configs including defaults
for k, v in self.gconf.items():
configurable = False if k in self.non_configurable_configs \
else True
dv = self.default_values.get(k, "")
modified = False if dv == "" else True
if show_non_configurable:
cnf[k] = {
"value": v,
"default": dv,
"configurable": configurable,
"modified": modified
}
else:
if k not in self.non_configurable_configs:
cnf[k] = {
"value": v,
"default": dv,
"configurable": configurable,
"modified": modified
}
return cnf
def getr(self, name, default_value=None):
with self.lock:
self.reload(with_lock=False)
return self.get(name, default_value, with_lock=False)
def get_help(self, name=None):
pass
def _is_configurable(self, name):
item = self.gconfdata.get(name, None)
if item is None:
return False
return item.get("configurable", True)
def _is_valid_value(self, name, value):
item = self.gconfdata.get(name, None)
if item is None:
return False
# If validation func not defined
if item.get("validation", None) is None:
return True
# minmax validation
if item["validation"] == "minmax":
return validate_minmax(value, item["min"], item["max"])
if item["validation"] == "choice":
return validate_choice(value, item["allowed_values"])
if item["validation"] == "bool":
return validate_bool(value)
if item["validation"] == "execpath":
return validate_execpath(value)
if item["validation"] == "unixtime":
return validate_unixtime(value)
if item["validation"] == "int":
return validate_int(value)
return False
def _is_config_changed(self):
if self.custom_conf_file is not None and \
os.path.exists(self.custom_conf_file):
st = os.lstat(self.custom_conf_file)
if st.st_mtime > self.prev_mtime:
self.prev_mtime = st.st_mtime
return True
return False
def is_config_file_old(config_file, primaryvol, secondaryvol):
cnf = RawConfigParser()
cnf.read(config_file)
session_section = "peers %s %s" % (primaryvol, secondaryvol)
try:
return dict(cnf.items(session_section))
except NoSectionError:
return None
def config_upgrade(config_file, ret):
config_file_backup = os.path.join(os.path.dirname(config_file), "gsyncd.conf.bkp")
#copy old config file in a backup file
shutil.copyfile(config_file, config_file_backup)
#write a new config file
config = RawConfigParser()
config.add_section('vars')
for key, value in ret.items():
#handle option name changes
if key == "use_tarssh":
new_key = "sync-method"
if value == "true":
new_value = "tarssh"
else:
new_value = "rsync"
config.set('vars', new_key, new_value)
elif key == "timeout":
new_key = "secondary-timeout"
config.set('vars', new_key, value)
#for changes like: ignore_deletes to ignore-deletes
else:
new_key = key.replace("_", "-")
config.set('vars', new_key, value)
with open(config_file, 'w') as configfile:
config.write(configfile)
def validate_int(value):
try:
_ = int(value)
return True
except ValueError:
return False
def validate_unixtime(value):
try:
y = datetime.fromtimestamp(int(value)).strftime("%Y")
if y == "1970":
return False
return True
except ValueError:
return False
def validate_minmax(value, minval, maxval):
try:
value = int(value)
minval = int(minval)
maxval = int(maxval)
return value >= minval and value <= maxval
except ValueError:
return False
def validate_choice(value, allowed_values):
allowed_values = allowed_values.split(",")
allowed_values = [v.strip() for v in allowed_values]
return value in allowed_values
def validate_bool(value):
return value in ["true", "false"]
def validate_execpath(value):
return os.path.isfile(value) and os.access(value, os.X_OK)
def validate_filepath(value):
return os.path.isfile(value)
def validate_path(value):
return os.path.exists(value)
def to_int(value):
return int(value)
def to_float(value):
return float(value)
def to_bool(value):
if isinstance(value, bool):
return value
return True if value in ["true", "True"] else False
def get(name, default_value=None):
return _gconf.get(name, default_value)
def getall(show_defaults=False, show_non_configurable=False):
return _gconf.getall(show_defaults=show_defaults,
show_non_configurable=show_non_configurable)
def getr(name, default_value=None):
return _gconf.getr(name, default_value)
def load(default_conf, custom_conf=None, args={}, extra_tmpl_args={},
override_from_args=False):
global _gconf
_gconf = Gconf(default_conf, custom_conf, args, extra_tmpl_args,
override_from_args)
def setconfig(name, value):
global _gconf
_gconf.set(name, value)
def resetconfig(name):
global _gconf
_gconf.reset(name)
def check(name, value=None, with_conffile=True):
global _gconf
_gconf.check(name, value=value, with_conffile=with_conffile)
|