123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419 |
- # -*- coding: utf-8 -*-
- # Copyright 2014-2016 OpenMarket Ltd
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- import argparse
- import errno
- import os
- from textwrap import dedent
- from six import integer_types
- import yaml
- class ConfigError(Exception):
- pass
- # We split these messages out to allow packages to override with package
- # specific instructions.
- MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS = """\
- Please opt in or out of reporting anonymized homeserver usage statistics, by
- setting the `report_stats` key in your config file to either True or False.
- """
- MISSING_REPORT_STATS_SPIEL = """\
- We would really appreciate it if you could help our project out by reporting
- anonymized usage statistics from your homeserver. Only very basic aggregate
- data (e.g. number of users) will be reported, but it helps us to track the
- growth of the Matrix community, and helps us to make Matrix a success, as well
- as to convince other networks that they should peer with us.
- Thank you.
- """
- MISSING_SERVER_NAME = """\
- Missing mandatory `server_name` config option.
- """
- class Config(object):
- @staticmethod
- def parse_size(value):
- if isinstance(value, integer_types):
- return value
- sizes = {"K": 1024, "M": 1024 * 1024}
- size = 1
- suffix = value[-1]
- if suffix in sizes:
- value = value[:-1]
- size = sizes[suffix]
- return int(value) * size
- @staticmethod
- def parse_duration(value):
- if isinstance(value, integer_types):
- return value
- second = 1000
- minute = 60 * second
- hour = 60 * minute
- day = 24 * hour
- week = 7 * day
- year = 365 * day
- sizes = {"s": second, "m": minute, "h": hour, "d": day, "w": week, "y": year}
- size = 1
- suffix = value[-1]
- if suffix in sizes:
- value = value[:-1]
- size = sizes[suffix]
- return int(value) * size
- @staticmethod
- def abspath(file_path):
- return os.path.abspath(file_path) if file_path else file_path
- @classmethod
- def path_exists(cls, file_path):
- """Check if a file exists
- Unlike os.path.exists, this throws an exception if there is an error
- checking if the file exists (for example, if there is a perms error on
- the parent dir).
- Returns:
- bool: True if the file exists; False if not.
- """
- try:
- os.stat(file_path)
- return True
- except OSError as e:
- if e.errno != errno.ENOENT:
- raise e
- return False
- @classmethod
- def check_file(cls, file_path, config_name):
- if file_path is None:
- raise ConfigError(
- "Missing config for %s."
- % (config_name,)
- )
- try:
- os.stat(file_path)
- except OSError as e:
- raise ConfigError(
- "Error accessing file '%s' (config for %s): %s"
- % (file_path, config_name, e.strerror)
- )
- return cls.abspath(file_path)
- @classmethod
- def ensure_directory(cls, dir_path):
- dir_path = cls.abspath(dir_path)
- try:
- os.makedirs(dir_path)
- except OSError as e:
- if e.errno != errno.EEXIST:
- raise
- if not os.path.isdir(dir_path):
- raise ConfigError(
- "%s is not a directory" % (dir_path,)
- )
- return dir_path
- @classmethod
- def read_file(cls, file_path, config_name):
- cls.check_file(file_path, config_name)
- with open(file_path) as file_stream:
- return file_stream.read()
- @staticmethod
- def default_path(name):
- return os.path.abspath(os.path.join(os.path.curdir, name))
- @staticmethod
- def read_config_file(file_path):
- with open(file_path) as file_stream:
- return yaml.load(file_stream)
- 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
- def generate_config(
- self,
- config_dir_path,
- server_name,
- is_generating_file,
- report_stats=None,
- ):
- default_config = "# vim:ft=yaml\n"
- default_config += "\n\n".join(dedent(conf) for conf in self.invoke_all(
- "default_config",
- config_dir_path=config_dir_path,
- server_name=server_name,
- is_generating_file=is_generating_file,
- report_stats=report_stats,
- ))
- config = yaml.load(default_config)
- return default_config, config
- @classmethod
- def load_config(cls, description, argv):
- config_parser = argparse.ArgumentParser(
- description=description,
- )
- config_parser.add_argument(
- "-c", "--config-path",
- action="append",
- metavar="CONFIG_FILE",
- help="Specify config file. Can be given multiple times and"
- " may specify directories containing *.yaml files."
- )
- config_parser.add_argument(
- "--keys-directory",
- metavar="DIRECTORY",
- help="Where files such as certs and signing keys are stored when"
- " their location is given explicitly in the config."
- " Defaults to the directory containing the last config file",
- )
- config_args = config_parser.parse_args(argv)
- config_files = find_config_files(search_paths=config_args.config_path)
- obj = cls()
- obj.read_config_files(
- config_files,
- keys_directory=config_args.keys_directory,
- generate_keys=False,
- )
- return obj
- @classmethod
- def load_or_generate_config(cls, description, argv):
- config_parser = argparse.ArgumentParser(add_help=False)
- config_parser.add_argument(
- "-c", "--config-path",
- action="append",
- metavar="CONFIG_FILE",
- help="Specify config file. Can be given multiple times and"
- " may specify directories containing *.yaml files."
- )
- config_parser.add_argument(
- "--generate-config",
- action="store_true",
- help="Generate a config file for the server name"
- )
- config_parser.add_argument(
- "--report-stats",
- action="store",
- help="Whether the generated config reports anonymized usage statistics",
- choices=["yes", "no"]
- )
- config_parser.add_argument(
- "--generate-keys",
- action="store_true",
- help="Generate any missing key files then exit"
- )
- config_parser.add_argument(
- "--keys-directory",
- metavar="DIRECTORY",
- help="Used with 'generate-*' options to specify where files such as"
- " certs and signing keys should be stored in, unless explicitly"
- " specified in the config."
- )
- config_parser.add_argument(
- "-H", "--server-name",
- help="The server name to generate a config file for"
- )
- config_args, remaining_args = config_parser.parse_known_args(argv)
- config_files = find_config_files(search_paths=config_args.config_path)
- generate_keys = config_args.generate_keys
- obj = cls()
- if config_args.generate_config:
- if config_args.report_stats is None:
- config_parser.error(
- "Please specify either --report-stats=yes or --report-stats=no\n\n" +
- MISSING_REPORT_STATS_SPIEL
- )
- if not config_files:
- config_parser.error(
- "Must supply a config file.\nA config file can be automatically"
- " generated using \"--generate-config -H SERVER_NAME"
- " -c CONFIG-FILE\""
- )
- (config_path,) = config_files
- if not cls.path_exists(config_path):
- if config_args.keys_directory:
- config_dir_path = config_args.keys_directory
- else:
- config_dir_path = os.path.dirname(config_path)
- config_dir_path = os.path.abspath(config_dir_path)
- server_name = config_args.server_name
- if not server_name:
- raise ConfigError(
- "Must specify a server_name to a generate config for."
- " Pass -H server.name."
- )
- if not cls.path_exists(config_dir_path):
- os.makedirs(config_dir_path)
- with open(config_path, "w") as config_file:
- config_str, config = obj.generate_config(
- config_dir_path=config_dir_path,
- server_name=server_name,
- report_stats=(config_args.report_stats == "yes"),
- is_generating_file=True
- )
- obj.invoke_all("generate_files", config)
- config_file.write(config_str)
- print((
- "A config file has been generated in %r for server name"
- " %r with corresponding SSL keys and self-signed"
- " certificates. Please review this file and customise it"
- " to your needs."
- ) % (config_path, server_name))
- print(
- "If this server name is incorrect, you will need to"
- " regenerate the SSL certificates"
- )
- return
- else:
- print((
- "Config file %r already exists. Generating any missing key"
- " files."
- ) % (config_path,))
- generate_keys = True
- parser = argparse.ArgumentParser(
- parents=[config_parser],
- description=description,
- formatter_class=argparse.RawDescriptionHelpFormatter,
- )
- obj.invoke_all("add_arguments", parser)
- args = parser.parse_args(remaining_args)
- if not config_files:
- config_parser.error(
- "Must supply a config file.\nA config file can be automatically"
- " generated using \"--generate-config -H SERVER_NAME"
- " -c CONFIG-FILE\""
- )
- obj.read_config_files(
- config_files,
- keys_directory=config_args.keys_directory,
- generate_keys=generate_keys,
- )
- if generate_keys:
- return None
- obj.invoke_all("read_arguments", args)
- return obj
- def read_config_files(self, config_files, keys_directory=None,
- generate_keys=False):
- if not keys_directory:
- keys_directory = os.path.dirname(config_files[-1])
- config_dir_path = os.path.abspath(keys_directory)
- specified_config = {}
- for config_file in config_files:
- yaml_config = self.read_config_file(config_file)
- specified_config.update(yaml_config)
- if "server_name" not in specified_config:
- raise ConfigError(MISSING_SERVER_NAME)
- server_name = specified_config["server_name"]
- _, config = self.generate_config(
- config_dir_path=config_dir_path,
- server_name=server_name,
- is_generating_file=False,
- )
- config.pop("log_config")
- config.update(specified_config)
- if "report_stats" not in config:
- raise ConfigError(
- MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS + "\n" +
- MISSING_REPORT_STATS_SPIEL
- )
- if generate_keys:
- self.invoke_all("generate_files", config)
- return
- self.invoke_all("read_config", config)
- def find_config_files(search_paths):
- """Finds config files using a list of search paths. If a path is a file
- then that file path is added to the list. If a search path is a directory
- then all the "*.yaml" files in that directory are added to the list in
- sorted order.
- Args:
- search_paths(list(str)): A list of paths to search.
- Returns:
- list(str): A list of file paths.
- """
- config_files = []
- if search_paths:
- for config_path in search_paths:
- if os.path.isdir(config_path):
- # We accept specifying directories as config paths, we search
- # inside that directory for all files matching *.yaml, and then
- # we apply them in *sorted* order.
- files = []
- for entry in os.listdir(config_path):
- entry_path = os.path.join(config_path, entry)
- if not os.path.isfile(entry_path):
- print (
- "Found subdirectory in config directory: %r. IGNORING."
- ) % (entry_path, )
- continue
- if not entry.endswith(".yaml"):
- print (
- "Found file in config directory that does not"
- " end in '.yaml': %r. IGNORING."
- ) % (entry_path, )
- continue
- files.append(entry_path)
- config_files.extend(sorted(files))
- else:
- config_files.append(config_path)
- return config_files
|