You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
164 lines
5.3 KiB
164 lines
5.3 KiB
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
|
|
# All rights reserved.
|
|
#
|
|
# This code is licensed under the MIT License.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files(the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions :
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
|
|
import re
|
|
import io
|
|
import os
|
|
from os.path import expanduser
|
|
from .ConfigBase import ConfigBase
|
|
from ..common import ConfigFormat
|
|
|
|
|
|
class ConfigFile(ConfigBase):
|
|
"""
|
|
A wrapper for File based configuration sources
|
|
"""
|
|
|
|
# The default descriptive name associated with the Notification
|
|
service_name = 'Local File'
|
|
|
|
# The default protocol
|
|
protocol = 'file'
|
|
|
|
def __init__(self, path, **kwargs):
|
|
"""
|
|
Initialize File Object
|
|
|
|
headers can be a dictionary of key/value pairs that you want to
|
|
additionally include as part of the server headers to post with
|
|
|
|
"""
|
|
super(ConfigFile, self).__init__(**kwargs)
|
|
|
|
# Store our file path as it was set
|
|
self.path = path
|
|
|
|
return
|
|
|
|
def url(self):
|
|
"""
|
|
Returns the URL built dynamically based on specified arguments.
|
|
"""
|
|
|
|
# Define any arguments set
|
|
args = {
|
|
'encoding': self.encoding,
|
|
}
|
|
|
|
if self.config_format:
|
|
# A format was enforced; make sure it's passed back with the url
|
|
args['format'] = self.config_format
|
|
|
|
return 'file://{path}?{args}'.format(
|
|
path=self.quote(self.path),
|
|
args=self.urlencode(args),
|
|
)
|
|
|
|
def read(self, **kwargs):
|
|
"""
|
|
Perform retrieval of the configuration based on the specified request
|
|
"""
|
|
|
|
response = None
|
|
|
|
path = os.path.expanduser(self.path)
|
|
try:
|
|
if self.max_buffer_size > 0 and \
|
|
os.path.getsize(path) > self.max_buffer_size:
|
|
|
|
# Content exceeds maximum buffer size
|
|
self.logger.error(
|
|
'File size exceeds maximum allowable buffer length'
|
|
' ({}KB).'.format(int(self.max_buffer_size / 1024)))
|
|
return None
|
|
|
|
except OSError:
|
|
# getsize() can throw this acception if the file is missing
|
|
# and or simply isn't accessible
|
|
self.logger.error(
|
|
'File is not accessible: {}'.format(path))
|
|
return None
|
|
|
|
# Always call throttle before any server i/o is made
|
|
self.throttle()
|
|
|
|
try:
|
|
# Python 3 just supports open(), however to remain compatible with
|
|
# Python 2, we use the io module
|
|
with io.open(path, "rt", encoding=self.encoding) as f:
|
|
# Store our content for parsing
|
|
response = f.read()
|
|
|
|
except (ValueError, UnicodeDecodeError):
|
|
# A result of our strict encoding check; if we receive this
|
|
# then the file we're opening is not something we can
|
|
# understand the encoding of..
|
|
|
|
self.logger.error(
|
|
'File not using expected encoding ({}) : {}'.format(
|
|
self.encoding, path))
|
|
return None
|
|
|
|
except (IOError, OSError):
|
|
# IOError is present for backwards compatibility with Python
|
|
# versions older then 3.3. >= 3.3 throw OSError now.
|
|
|
|
# Could not open and/or read the file; this is not a problem since
|
|
# we scan a lot of default paths.
|
|
self.logger.error(
|
|
'File can not be opened for read: {}'.format(path))
|
|
return None
|
|
|
|
# Detect config format based on file extension if it isn't already
|
|
# enforced
|
|
if self.config_format is None and \
|
|
re.match(r'^.*\.ya?ml\s*$', path, re.I) is not None:
|
|
|
|
# YAML Filename Detected
|
|
self.default_config_format = ConfigFormat.YAML
|
|
|
|
# Return our response object
|
|
return response
|
|
|
|
@staticmethod
|
|
def parse_url(url):
|
|
"""
|
|
Parses the URL so that we can handle all different file paths
|
|
and return it as our path object
|
|
|
|
"""
|
|
|
|
results = ConfigBase.parse_url(url, verify_host=False)
|
|
if not results:
|
|
# We're done early; it's not a good URL
|
|
return results
|
|
|
|
match = re.match(r'file://(?P<path>[^?]+)(\?.*)?', url, re.I)
|
|
if not match:
|
|
return None
|
|
|
|
results['path'] = expanduser(ConfigFile.unquote(match.group('path')))
|
|
return results
|