r00t2
/
aif-ng
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

gorram it pycharm, stop warning me about this gorram dollar sign. it doesn't need to and shouldn't be escaped in XSD pattern expressions.

This commit is contained in:
brent s 2019-10-28 14:11:35 -04:00
parent 837d7a4703
commit 036dd24098
3 changed files with 71 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
aif.xsd
View File

@ -147,10 +147,10 @@
<xs:simpleType name="t_shadowhash">
<!-- http://man7.org/linux/man-pages/man3/crypt.3.html#NOTES -->
<xs:restriction base="xs:token">
<xs:pattern value="(\$1)?(\$[a-zA-Z0-9./]{1,16})\$[a-zA-Z0-9./]{22}"/><!-- md5 -->
<xs:pattern value="(\$2[abxy]?)?(\$[0-9]+)\$[a-zA-Z0-9./]{53}"/><!-- Blowfish -->
<xs:pattern value="(\$5)?(\$[a-zA-Z0-9./]{1,16})\$[a-zA-Z0-9./]{43}"/><!-- sha256 -->
<xs:pattern value="(\$6)?(\$[a-zA-Z0-9./]{1,16})\$[a-zA-Z0-9./]{86}"/><!-- sha512 -->
<xs:pattern value="($1)?($[a-zA-Z0-9./]{1,16})$[a-zA-Z0-9./]{22}"/><!-- md5 -->
<xs:pattern value="($2[abxy]?)?($[0-9]+)$[a-zA-Z0-9./]{53}"/><!-- Blowfish -->
<xs:pattern value="($5)?($[a-zA-Z0-9./]{1,16})$[a-zA-Z0-9./]{43}"/><!-- sha256 -->
<xs:pattern value="($6)?($[a-zA-Z0-9./]{1,16})$[a-zA-Z0-9./]{86}"/><!-- sha512 -->
<xs:whiteSpace value="collapse"/>
</xs:restriction>
</xs:simpleType>

99
aif/config.py
View File

@ -4,27 +4,29 @@ import re
import requests
from lxml import etree

# https://stackoverflow.com/questions/30232031/how-can-i-strip-namespaces-out-of-an-lxml-tree/30233635#30233635 ?

_patterns = {'raw': re.compile(r'^\s*(?P<xml><(\?xml|aif)\s+.*)\s*$', re.DOTALL|re.MULTILINE),
'remote': re.compile(r'^(?P<uri>(?P<proto>(https?|ftps?)://)(?P<path>.*))\s*$'),
'local': re.compile(r'^(file://)?(?P<path>(/?[^/]+)+/?)$')}


class Config(object):
def __init__(self, *args, **kwargs):
def __init__(self, xsd_path = None, *args, **kwargs):
self.xsd_path = None
self.tree = None
self.namespaced_tree = None
self.xml = None
self.namespaced_xml = None
self.raw = None
self.xsd = None
self.defaultsParser = None

def main(self, validate = True):
def main(self, validate = True, populate_defaults = True):
self.fetch()
self.parseRaw()
if populate_defaults:
self.populateDefaults()
if validate:
self.validate()

return()

def fetch(self): # Just a fail-safe; this is overridden by specific subclasses.
@ -32,6 +34,8 @@ class Config(object):
return()

def getXSD(self, xsdpath = None):
if not xsdpath:
xsdpath = self.xsd_path
raw_xsd = None
if xsdpath:
xsdpath = os.path.abspath(os.path.expanduser(xsdpath))
@ -45,20 +49,41 @@ class Config(object):
schemaLocation = '{{{0}}}schemaLocation'.format(xsi)
schemaURL = self.xml.attrib.get(schemaLocation,
'https://aif-ng.io/aif.xsd?ref={0}'.format(self.xml.attrib['version']))
split_url = schemaURL.split()
if len(split_url) == 2: # a properly defined schemaLocation
schemaURL = split_url[1]
else:
schemaURL = split_url[0]
req = requests.get(schemaURL)
if not req.ok():
if not req.ok:
# TODO: logging!
raise RuntimeError('Could not download XSD')
raw_xsd = req.content
self.xsd = etree.XMLSchema(etree.XML(raw_xsd))
return()

def parseRaw(self):
self.tree = etree.parse(self.raw)
self.namespaced_tree = etree.parse(self.raw)
self.xml = self.tree.getroot()
self.namespaced_xml = self.namespaced_tree.getroot()
def parseRaw(self, parser = None):
# self.xml = etree.parse(self.raw, parser = parser)
self.xml = etree.fromstring(self.raw, parser = parser)
# self.namespaced_xml = etree.parse(self.raw, parser = parser)
self.namespaced_xml = etree.fromstring(self.raw, parser = parser)
self.tree = self.xml.getroottree()
self.namespaced_tree = self.namespaced_xml.getroottree()
self.tree.xinclude()
self.namespaced_tree.xinclude()
self.stripNS()
return()

def populateDefaults(self):
if not self.xsd:
self.getXSD()
if not self.defaultsParser:
self.defaultsParser = etree.XMLParser(schema = self.xsd, attribute_defaults = True)
self.parseRaw(parser = self.defaultsParser)
return()

def removeDefaults(self):
self.parseRaw()
return()

def stripNS(self):
@ -71,31 +96,34 @@ class Config(object):
def validate(self):
if not self.xsd:
self.getXSD()

self.xsd.assertValid(self.tree)
self.xsd.assertValid(self.namespaced_tree)
return()


class LocalFile(Config):
def __init__(self, path, *args, **kwargs):
super().__init__(*args, **kwargs)
self.source = ['local', _patterns['local'].search(path).group('path')]
def __init__(self, path, xsd_path = None, *args, **kwargs):
super().__init__(xsd_path = xsd_path, *args, **kwargs)
self.type = 'local'
self.source = _patterns['local'].search(path).group('path')

def fetch(self):
self.source[1] = os.path.abspath(os.path.expanduser(self.source[1]))
if not os.path.isfile(self.source[1]):
raise ValueError('{0} does not exist'.format(self.source[1]))
with open(self.source[1], 'rb') as fh:
self.source = os.path.realpath(self.source)
if not os.path.isfile(self.source):
raise ValueError('{0} does not exist'.format(self.source))
with open(self.source, 'rb') as fh:
self.raw = fh.read()
return()


class RemoteFile(Config):
def __init__(self, uri, *args, **kwargs):
def __init__(self, uri, xsd_path = None, *args, **kwargs):
super().__init__(*args, **kwargs)
self.source = ('remote', uri)
self.type = 'remote'
self.source = uri

def fetch(self):
r = requests.get(self.source[1])
r = requests.get(self.source)
if not r.ok():
raise RuntimeError('Could not download XML')
self.raw = r.content
@ -103,36 +131,39 @@ class RemoteFile(Config):


class ConfigStr(Config):
def __init__(self, rawxml, *args, **kwargs):
def __init__(self, rawxml, xsd_path = None, *args, **kwargs):
super().__init__(*args, **kwargs)
self.source = ('raw', rawxml)
self.type = 'raw_str'
self.source = rawxml

def fetch(self):
self.raw = self.source[1].encode('utf-8')
self.raw = self.source.encode('utf-8')
return()


class ConfigBin(Config):
def __init__(self, rawbinaryxml, *args, **kwargs):
def __init__(self, rawbinaryxml, xsd_path = None, *args, **kwargs):
super().__init__(*args, **kwargs)
self.source = ('raw_binary', rawbinaryxml)
self.type = 'raw_bin'
self.source = rawbinaryxml

def fetch(self):
self.raw = self.source[1]
self.raw = self.source
return()


def getConfig(cfg_ref, validate = True):
def getConfig(cfg_ref, validate = True, populate_defaults = True, xsd_path = None):
cfgobj = None
# This is kind of gross.
for configtype, pattern in _patterns.items():
try:
if pattern.search(cfg_ref):
if configtype == 'raw':
cfgobj = ConfigStr(cfg_ref)
cfgobj = ConfigStr(cfg_ref, xsd_path = xsd_path)
elif configtype == 'remote':
cfgobj = RemoteFile(cfg_ref)
cfgobj = RemoteFile(cfg_ref, xsd_path = xsd_path)
elif configtype == 'local':
cfgobj = LocalFile(cfg_ref)
cfgobj = LocalFile(cfg_ref, xsd_path = xsd_path)
if cfgobj:
break
except TypeError:
@ -140,6 +171,8 @@ def getConfig(cfg_ref, validate = True):
if not ptrn.search(cfg_ref):
raise ValueError('Received junk data for cfg_ref')
else:
cfgobj = ConfigBin(cfg_ref)
cfgobj = ConfigBin(cfg_ref, xsd_path = xsd_path)
break
if cfgobj:
cfgobj.main(validate = validate, populate_defaults = populate_defaults)
return(cfgobj)

2
docs/THANKS
View File

@ -1,3 +1,3 @@
AIF-NG owes thanks to:

* jthan for being a good rubber ducky
* jthan for being a good rubber ducky