diff --git a/synapse/config/_base.py b/synapse/config/_base.py
index b59f4e45e2..9f5da70948 100644
--- a/synapse/config/_base.py
+++ b/synapse/config/_base.py
@@ -14,9 +14,10 @@
# limitations under the License.
import argparse
-import sys
import os
import yaml
+import sys
+from textwrap import dedent
class ConfigError(Exception):
@@ -24,8 +25,6 @@ class ConfigError(Exception):
class Config(object):
- def __init__(self, args):
- pass
@staticmethod
def parse_size(string):
@@ -38,6 +37,22 @@ class Config(object):
return int(string) * size
@staticmethod
+ def parse_duration(string):
+ second = 1000
+ hour = 60 * 60 * second
+ day = 24 * hour
+ week = 7 * day
+ year = 365 * day
+
+ sizes = {"s": second, "h": hour, "d": day, "w": week, "y": year}
+ size = 1
+ suffix = string[-1]
+ if suffix in sizes:
+ string = string[:-1]
+ size = sizes[suffix]
+ return int(string) * size
+
+ @staticmethod
def abspath(file_path):
return os.path.abspath(file_path) if file_path else file_path
@@ -77,17 +92,6 @@ class Config(object):
with open(file_path) as file_stream:
return file_stream.read()
- @classmethod
- def read_yaml_file(cls, file_path, config_name):
- cls.check_file(file_path, config_name)
- with open(file_path) as file_stream:
- try:
- return yaml.load(file_stream)
- except:
- raise ConfigError(
- "Error parsing yaml in file %r" % (file_path,)
- )
-
@staticmethod
def default_path(name):
return os.path.abspath(os.path.join(os.path.curdir, name))
@@ -97,16 +101,33 @@ class Config(object):
with open(file_path) as file_stream:
return yaml.load(file_stream)
- @classmethod
- def add_arguments(cls, parser):
- pass
+ def invoke_all(self, name, *args, **kargs):
+ results = []
+ for cls in type(self).mro():
+ if name in cls.__dict__:
+ results.append(getattr(cls, name)(self, *args, **kargs))
+ return results
- @classmethod
- def generate_config(cls, args, config_dir_path):
- pass
+ def generate_config(self, config_dir_path, server_name):
+ default_config = "# vim:ft=yaml\n"
+
+ default_config += "\n\n".join(dedent(conf) for conf in self.invoke_all(
+ "default_config", config_dir_path, server_name
+ ))
+
+ config = yaml.load(default_config)
+
+ if not os.path.exists(config_dir_path):
+ os.makedirs(config_dir_path)
+
+ self.invoke_all("generate_keys", config)
+
+ return default_config
@classmethod
def load_config(cls, description, argv, generate_section=None):
+ result = cls()
+
config_parser = argparse.ArgumentParser(add_help=False)
config_parser.add_argument(
"-c", "--config-path",
@@ -115,66 +136,56 @@ class Config(object):
)
config_parser.add_argument(
"--generate-config",
- action="store_true",
- help="Generate config file"
+ metavar="SERVER_NAME",
+ help="Generate a config file for the server name"
)
config_args, remaining_args = config_parser.parse_known_args(argv)
- if config_args.generate_config:
- if not config_args.config_path:
- config_parser.error(
- "Must specify where to generate the config file"
- )
- config_dir_path = os.path.dirname(config_args.config_path)
- if os.path.exists(config_args.config_path):
- defaults = cls.read_config_file(config_args.config_path)
- else:
- defaults = {}
- else:
- if config_args.config_path:
- defaults = cls.read_config_file(config_args.config_path)
- else:
- defaults = {}
-
- parser = argparse.ArgumentParser(
- parents=[config_parser],
- description=description,
- formatter_class=argparse.RawDescriptionHelpFormatter,
- )
- cls.add_arguments(parser)
- parser.set_defaults(**defaults)
-
- args = parser.parse_args(remaining_args)
+ if not config_args.config_path:
+ config_parser.error(
+ "Must supply a config file.\nA config file can be automatically"
+ " generated using \"--generate-config SERVER_NAME"
+ " -c CONFIG-FILE\""
+ )
if config_args.generate_config:
+ server_name = config_args.generate_config
+ config_path = config_args.config_path
+ if os.path.exists(config_path):
+ print "Config file %r already exists. Not overwriting" % (
+ config_args.config_path
+ )
+ sys.exit(0)
config_dir_path = os.path.dirname(config_args.config_path)
config_dir_path = os.path.abspath(config_dir_path)
- if not os.path.exists(config_dir_path):
- os.makedirs(config_dir_path)
- cls.generate_config(args, config_dir_path)
- config = {}
- for key, value in vars(args).items():
- if (key not in set(["config_path", "generate_config"])
- and value is not None):
- config[key] = value
- with open(config_args.config_path, "w") as config_file:
- # TODO(mark/paul) We might want to output emacs-style mode
- # markers as well as vim-style mode markers into the file,
- # to further hint to people this is a YAML file.
- config_file.write("# vim:ft=yaml\n")
- yaml.dump(config, config_file, default_flow_style=False)
+ with open(config_path, "wb") as config_file:
+ config_file.write(
+ result.generate_config(config_dir_path, server_name)
+ )
print (
"A config file has been generated in %s for server name"
" '%s' with corresponding SSL keys and self-signed"
" certificates. Please review this file and customise it to"
" your needs."
- ) % (
- config_args.config_path, config['server_name']
- )
+ ) % (config_path, server_name)
print (
"If this server name is incorrect, you will need to regenerate"
" the SSL certificates"
)
sys.exit(0)
- return cls(args)
+ config = cls.read_config_file(config_args.config_path)
+ result.invoke_all("read_config", config)
+
+ parser = argparse.ArgumentParser(
+ parents=[config_parser],
+ description=description,
+ formatter_class=argparse.RawDescriptionHelpFormatter,
+ )
+
+ result.invoke_all("add_arguments", parser)
+ args = parser.parse_args(remaining_args)
+
+ result.invoke_all("read_arguments", args)
+
+ return result
|
