def get_schedule_a_results():
results = []
api_key = api_config
per_page = 100
committee_id = 'C00580100' # DJT for president
sort = '-contribution_receipt_date'
parameters = '?two_year_transaction_period=2020&two_year_transaction_period=2018&api_key={}&per_page={}&committee_id={}&sort={}'.format(
api_key, per_page, committee_id, sort)
last_indexes = True
loop_count = 0
while last_indexes is not None:
# Need to limit this to 120 calls per minute
response = requests.get(
'https://api.open.fec.gov/v1/schedules/schedule_a/{}'.format(
parameters))
json_response = response.json()
pagination = json_response['pagination']
last_indexes = pagination.get('last_indexes')
last_indexes_dict = DottedDict(last_indexes)
last_index = last_indexes_dict.get('last_index')
last_contribution_receipt_date = last_indexes_dict.get(
'last_contribution_receipt_date')
results += json_response['results']
if loop_count == 0:
parameters = parameters + '&last_index={}'.format(
last_index) + '&last_contribution_receipt_date={}'.format(
last_contribution_receipt_date)
else:
parameters = '?two_year_transaction_period=2020&two_year_transaction_period=2018&api_key={}&per_page={}&committee_id={}&sort={}&last_index={}&last_contribution_receipt_date={}'.format(
api_key, per_page, committee_id, sort, last_index,
last_contribution_receipt_date)
loop_count += 1
if loop_count == 2:
break
print(loop_count)
print(pagination)
time.sleep(1)
return results
class Configuration:
"""
The Configuration class stores the current IRRD configuration,
checks the validity of the settings, and offers graceful reloads.
"""
user_config_staging: DottedDict
user_config_live: DottedDict
def __init__(self):
"""
Load the default config and load and check the user provided config.
If a logfile was specified, direct logs there.
"""
default_config_path = os.path.join(
os.path.dirname(os.path.realpath(__file__)), 'default_config.yaml')
default_config_yaml = yaml.safe_load(open(default_config_path))
self.default_config = DottedDict(default_config_yaml['irrd'])
errors = self._staging_reload_check()
if errors:
raise ConfigurationError(
f'Errors found in configuration, unable to start: {errors}')
self._commit_staging()
logfile_path = self.get_setting_live('log.logfile_path')
if logfile_path:
LOGGING['handlers']['file'] = {
'class': 'logging.handlers.WatchedFileHandler',
'filename': logfile_path,
'formatter': 'verbose',
}
# noinspection PyTypeChecker
LOGGING['loggers']['']['handlers'] = ['file']
logging.config.dictConfig(LOGGING)
def get_setting_live(self, setting_name: str, default: Any = None) -> Any:
"""
Get a setting from the live config.
In order, this will look in:
- A env variable, uppercase and dots replaced by underscores, e.g.
IRRD_SERVER_WHOIS_INTERFACE
- The testing_overrides DottedDict
- The live user config.
- The default config.
If it is not found in any, the value of the default paramater
is returned, which is None by default.
"""
env_key = 'IRRD_' + setting_name.upper().replace('.', '_')
if env_key in os.environ:
return os.environ[env_key]
if testing_overrides:
try:
return testing_overrides[setting_name]
except KeyError:
pass
try:
return self.user_config_live[setting_name]
except KeyError:
return self.default_config.get(setting_name, default)
def reload(self) -> bool:
"""
Reload the configuration, if it passes the checks.
"""
errors = self._staging_reload_check()
if errors:
logger.error(
f'Errors found in configuration, continuing with current settings: {errors}'
)
return False
self._commit_staging()
return True
def _commit_staging(self):
"""
Activate the current staging config as the live config.
"""
self.user_config_live = self.user_config_staging
logging.getLogger('').setLevel(
self.get_setting_live('log.level', default='INFO'))
def _staging_reload_check(self) -> List[str]:
"""
Reload the staging configuration, and run the config checks on it.
Returns a list of errors if any were found, or an empty list of the
staging config is valid.
"""
# While in testing, Configuration does not demand a valid config file
# in IRRD_CONFIG_PATH_ENV. This simplifies test setup, as most tests
# do not need it. If IRRD_CONFIG_PATH_ENV is set, it is checked,
# and the check is forced with IRRD_CONFIG_CHECK_FORCE_ENV (to test
# the error message for the empty environment variable).
if all([
hasattr(sys, '_called_from_test'), IRRD_CONFIG_PATH_ENV
not in os.environ, IRRD_CONFIG_CHECK_FORCE_ENV
not in os.environ
]):
self.user_config_staging = DottedDict({})
return []
try:
user_config_path = os.environ[IRRD_CONFIG_PATH_ENV]
except KeyError:
return [f'Environment variable {IRRD_CONFIG_PATH_ENV} not set.']
try:
user_config_yaml = yaml.safe_load(open(user_config_path))
except OSError as oe:
return [f'Error opening config file {user_config_path}: {oe}']
except yaml.YAMLError as ye:
return [f'Error parsing YAML file: {ye}']
if not isinstance(user_config_yaml,
dict) or 'irrd' not in user_config_yaml:
return [
f'Could not find root item "irrd" in config file {user_config_path}'
]
self.user_config_staging = DottedDict(user_config_yaml['irrd'])
errors = self._check_staging_config()
if not errors:
logger.info(
f'Configuration successfully (re)loaded from {user_config_path}'
)
return errors
def _check_staging_config(self) -> List[str]:
"""
Validate the current staging configuration.
Returns a list of any errors, or an empty list for a valid config.
"""
errors = []
config = self.user_config_staging
if not self._check_is_str(config, 'database_url'):
errors.append(f'Setting database_url is required.')
expected_access_lists = {
config.get('server.whois.access_list'),
config.get('server.http.access_list'),
}
if not self._check_is_str(
config, 'email.from') or '@' not in config.get('email.from'):
errors.append(
f'Setting email.from is required and must be an email address.'
)
if not self._check_is_str(config, 'email.smtp'):
errors.append(f'Setting email.smtp is required.')
string_not_required = [
'email.footer', 'server.whois.access_list',
'server.http.access_list'
]
for setting in string_not_required:
if not self._check_is_str(config, setting, required=False):
errors.append(
f'Setting {setting} must be a string, if defined.')
if not self._check_is_str(config, 'auth.gnupg_keyring'):
errors.append(f'Setting auth.gnupg_keyring is required.')
access_lists = set(config.get('access_lists', {}).keys())
unresolved_access_lists = {
x
for x in expected_access_lists.difference(access_lists)
if x and isinstance(x, str)
}
if unresolved_access_lists:
errors.append(
f'Access lists {", ".join(unresolved_access_lists)} referenced in settings, but not defined.'
)
for name, access_list in config.get('access_lists', {}).items():
for item in access_list:
try:
IP(item)
except ValueError as ve:
errors.append(f'Invalid item in access list {name}: {ve}.')
known_sources = set(config.get('sources', {}).keys())
unknown_default_sources = set(config.get('sources_default',
[])).difference(known_sources)
if unknown_default_sources:
errors.append(
f'Setting sources_default contains unknown sources: {", ".join(unknown_default_sources)}'
)
for name, details in config.get('sources', {}).items():
nrtm_mirror = details.get('nrtm_host') and details.get(
'nrtm_port') and details.get('import_serial_source')
if details.get('keep_journal') and not (
nrtm_mirror or details.get('authoritative')):
errors.append(
f'Setting keep_journal for source {name} can not be enabled unless either authoritative '
f'is enabled, or all three of nrtm_host, nrtm_port and import_serial_source.'
)
if details.get('nrtm_host') and not (
details.get('import_serial_source')):
errors.append(
f'Setting nrtm_host for source {name} can not be enabled without setting '
f'import_serial_source.')
if not details.get('import_timer', '0').isnumeric():
errors.append(
f'Setting import_timer for source {name} must be a number.'
)
if not details.get('export_timer', '0').isnumeric():
errors.append(
f'Setting export_timer for source {name} must be a number.'
)
if config.get('log.level') and not config.get('log.level') in [
'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
]:
errors.append(
f'Invalid log.level: {config.get("log.level")}. '
f'Valid settings for log.level are `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`.'
)
return errors
def _check_is_str(self, config, key, required=True):
if required:
return config.get(key) and isinstance(config.get(key), str)
return config.get(key) is None or isinstance(config.get(key), str)
class Configuration:
"""
The Configuration class stores the current IRRD configuration,
checks the validity of the settings, and offers graceful reloads.
"""
user_config_staging: DottedDict
user_config_live: DottedDict
def __init__(self, user_config_path: Optional[str] = None, commit=True):
"""
Load the default config and load and check the user provided config.
If a logfile was specified, direct logs there.
"""
self.user_config_path = user_config_path if user_config_path else CONFIG_PATH_DEFAULT
default_config_path = str(
Path(__file__).resolve().parents[0] / 'default_config.yaml')
default_config_yaml = yaml.safe_load(open(default_config_path))
self.default_config = DottedDict(default_config_yaml['irrd'])
errors = self._staging_reload_check(log_success=False)
if errors:
raise ConfigurationError(
f'Errors found in configuration, unable to start: {errors}')
if commit:
self._commit_staging()
logfile_path = self.get_setting_live('log.logfile_path')
if logfile_path:
LOGGING['handlers']['file'] = { # type:ignore
'class': 'logging.handlers.WatchedFileHandler',
'filename': logfile_path,
'formatter': 'verbose',
}
# noinspection PyTypeChecker
LOGGING['loggers']['']['handlers'] = ['file'] # type:ignore
logging.config.dictConfig(LOGGING)
# Re-commit to apply loglevel
self._commit_staging()
def get_setting_live(self, setting_name: str, default: Any = None) -> Any:
"""
Get a setting from the live config.
In order, this will look in:
- A env variable, uppercase and dots replaced by underscores, e.g.
IRRD_SERVER_WHOIS_INTERFACE
- The testing_overrides DottedDict
- The live user config.
- The default config.
If it is not found in any, the value of the default paramater
is returned, which is None by default.
"""
env_key = 'IRRD_' + setting_name.upper().replace('.', '_')
if env_key in os.environ:
return os.environ[env_key]
if testing_overrides:
try:
return testing_overrides[setting_name]
except KeyError:
pass
try:
return self.user_config_live[setting_name]
except KeyError:
return self.default_config.get(setting_name, default)
def reload(self) -> bool:
"""
Reload the configuration, if it passes the checks.
"""
errors = self._staging_reload_check()
if errors:
logger.error(
f'Errors found in configuration, continuing with current settings: {errors}'
)
return False
self._commit_staging()
return True
def _commit_staging(self) -> None:
"""
Activate the current staging config as the live config.
"""
self.user_config_live = self.user_config_staging
logging.getLogger('').setLevel(
self.get_setting_live('log.level', default='INFO'))
if hasattr(sys, '_called_from_test'):
logging.getLogger('').setLevel('DEBUG')
def _staging_reload_check(self, log_success=True) -> List[str]:
"""
Reload the staging configuration, and run the config checks on it.
Returns a list of errors if any were found, or an empty list of the
staging config is valid.
"""
# While in testing, Configuration does not demand a valid config file
# This simplifies test setup, as most tests do not need it.
# If a non-default path is set during testing, it is still checked.
if hasattr(sys, '_called_from_test'
) and self.user_config_path == CONFIG_PATH_DEFAULT:
self.user_config_staging = DottedDict({})
return []
try:
with open(self.user_config_path) as fh:
user_config_yaml = yaml.safe_load(fh)
except OSError as oe:
return [f'Error opening config file {self.user_config_path}: {oe}']
except yaml.YAMLError as ye:
return [f'Error parsing YAML file: {ye}']
if not isinstance(user_config_yaml,
dict) or 'irrd' not in user_config_yaml:
return [
f'Could not find root item "irrd" in config file {self.user_config_path}'
]
self.user_config_staging = DottedDict(user_config_yaml['irrd'])
errors = self._check_staging_config()
if not errors and log_success:
logger.info(
f'Configuration successfully (re)loaded from {self.user_config_path} in PID {os.getpid()}'
)
return errors
def _check_staging_config(self) -> List[str]:
"""
Validate the current staging configuration.
Returns a list of any errors, or an empty list for a valid config.
"""
errors = []
config = self.user_config_staging
if not self._check_is_str(config, 'database_url'):
errors.append('Setting database_url is required.')
if not self._check_is_str(config, 'redis_url'):
errors.append('Setting redis_url is required.')
if not self._check_is_str(config, 'piddir') or not os.path.isdir(
config['piddir']):
errors.append(
'Setting piddir is required and must point to an existing directory.'
)
expected_access_lists = {
config.get('server.whois.access_list'),
config.get('server.http.access_list'),
}
if not self._check_is_str(
config, 'email.from') or '@' not in config.get('email.from'):
errors.append(
'Setting email.from is required and must be an email address.')
if not self._check_is_str(config, 'email.smtp'):
errors.append('Setting email.smtp is required.')
if not self._check_is_str(config, 'email.recipient_override', required=False) \
or '@' not in config.get('email.recipient_override', '@'):
errors.append(
'Setting email.recipient_override must be an email address if set.'
)
string_not_required = [
'email.footer', 'server.whois.access_list',
'server.http.access_list', 'rpki.notify_invalid_subject',
'rpki.notify_invalid_header', 'rpki.slurm_source'
]
for setting in string_not_required:
if not self._check_is_str(config, setting, required=False):
errors.append(
f'Setting {setting} must be a string, if defined.')
if not self._check_is_str(config, 'auth.gnupg_keyring'):
errors.append('Setting auth.gnupg_keyring is required.')
access_lists = set(config.get('access_lists', {}).keys())
unresolved_access_lists = {
x
for x in expected_access_lists.difference(access_lists)
if x and isinstance(x, str)
}
if unresolved_access_lists:
errors.append(
f'Access lists {", ".join(unresolved_access_lists)} referenced in settings, but not defined.'
)
for name, access_list in config.get('access_lists', {}).items():
for item in access_list:
try:
IP(item)
except ValueError as ve:
errors.append(f'Invalid item in access list {name}: {ve}.')
known_sources = set(config.get('sources', {}).keys())
if config.get('rpki.roa_source',
'https://rpki.gin.ntt.net/api/export.json'):
known_sources.add(RPKI_IRR_PSEUDO_SOURCE)
if config.get('rpki.notify_invalid_enabled') is None:
errors.append(
'RPKI-aware mode is enabled, but rpki.notify_invalid_enabled '
'is not set. Set to true or false. DANGER: care is required with '
'this setting in testing setups with live data, as it may send bulk '
'emails to real resource contacts unless email.recipient_override '
'is also set. Read documentation carefully.')
unknown_default_sources = set(config.get('sources_default',
[])).difference(known_sources)
if unknown_default_sources:
errors.append(
f'Setting sources_default contains unknown sources: {", ".join(unknown_default_sources)}'
)
if not str(config.get('rpki.roa_import_timer', '0')).isnumeric():
errors.append(
'Setting rpki.roa_import_timer must be set to a number.')
for name, details in config.get('sources', {}).items():
if config.get(
'rpki.roa_source') and name == RPKI_IRR_PSEUDO_SOURCE:
errors.append(
f'Setting sources contains reserved source name: {RPKI_IRR_PSEUDO_SOURCE}'
)
if not SOURCE_NAME_RE.match(name):
errors.append(f'Invalid source name: {name}')
nrtm_mirror = details.get('nrtm_host') and details.get(
'import_serial_source')
if details.get('keep_journal') and not (
nrtm_mirror or details.get('authoritative')):
errors.append(
f'Setting keep_journal for source {name} can not be enabled unless either authoritative '
f'is enabled, or all three of nrtm_host, nrtm_port and import_serial_source.'
)
if details.get(
'nrtm_host') and not details.get('import_serial_source'):
errors.append(
f'Setting nrtm_host for source {name} can not be enabled without setting '
f'import_serial_source.')
if details.get('authoritative') and (details.get('nrtm_host') or
details.get('import_source')):
errors.append(
f'Setting authoritative for source {name} can not be enabled when either '
f'nrtm_host or import_source are set.')
if not str(details.get('nrtm_port', '43')).isnumeric():
errors.append(
f'Setting nrtm_port for source {name} must be a number.')
if not str(details.get('import_timer', '0')).isnumeric():
errors.append(
f'Setting import_timer for source {name} must be a number.'
)
if not str(details.get('export_timer', '0')).isnumeric():
errors.append(
f'Setting export_timer for source {name} must be a number.'
)
if config.get('log.level') and not config.get('log.level') in [
'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
]:
errors.append(
f'Invalid log.level: {config.get("log.level")}. '
f'Valid settings for log.level are `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`.'
)
return errors
def _check_is_str(self, config, key, required=True):
if required:
return config.get(key) and isinstance(config.get(key), str)
return config.get(key) is None or isinstance(config.get(key), str)
