marcus/scour
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Make embedRasters independent of options.inputfile

Browse source 
This is a part of making scour able to support multiple input files.

Signed-off-by: Niels Thykier <niels@thykier.net>
This commit is contained in:
Niels Thykier 2018-03-18 11:50:45 +00:00
parent 6ea126d290
commit 82ce83acab
2 changed files with 19 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

28
scour/scour.py
View file

@ -3017,7 +3017,7 @@ def removeComments(element):
return num
def embedRasters(element, options):
def embedRasters(element, references_relative_to, options):
import base64
"""
Converts raster references to inline images.
@ -3056,9 +3056,9 @@ def embedRasters(element, options):
# relative local paths are relative to the input file, therefore temporarily change the working dir
working_dir_old = None
if parsed_href.scheme == 'file' and parsed_href.path[0] != '/':
if options.infilename:
if references_relative_to:
working_dir_new = os.path.abspath(references_relative_to)
working_dir_old = os.getcwd()
working_dir_new = os.path.abspath(os.path.dirname(options.infilename))
os.chdir(working_dir_new)
# open/download the file
@ -3308,7 +3308,7 @@ def serializeXML(element, options, indent_depth=0, preserveWhitespace=False):
# this is the main method
# input is a string representation of the input XML
# returns a string representation of the output XML
def scourString(in_string, options=None):
def scourString(in_string, options=None, references_relative_to=None):
# sanitize options (take missing attributes from defaults, discard unknown attributes)
options = sanitizeOptions(options)
@ -3549,7 +3549,7 @@ def scourString(in_string, options=None):
# convert rasters references to base64-encoded strings
if options.embed_rasters:
for elem in doc.documentElement.getElementsByTagName('image'):
embedRasters(elem, options)
embedRasters(elem, references_relative_to, options)
# properly size the SVG document (ideally width/height should be 100% with a viewBox)
if options.enable_viewboxing:
@ -3590,16 +3590,14 @@ def scourString(in_string, options=None):
# used mostly by unit tests
# input is a filename
# returns the minidom doc representation of the SVG
def scourXmlFile(filename, options=None):
def scourXmlFile(filename, options=None, references_relative_to=None):
# sanitize options (take missing attributes from defaults, discard unknown attributes)
options = sanitizeOptions(options)
# we need to make sure infilename is set correctly (otherwise relative references in the SVG won't work)
options.ensure_value("infilename", filename)
# open the file and scour it
with open(filename, "rb") as f:
in_string = f.read()
out_string = scourString(in_string, options)
out_string = scourString(in_string, options, references_relative_to)
# prepare the output xml.dom.minidom object
doc = xml.dom.minidom.parseString(out_string.encode('utf-8'))
@ -3814,9 +3812,11 @@ def maybe_gziped_file(filename, mode="r"):
def getInOut(options):
references_relative_to = None
if options.infilename:
infile = maybe_gziped_file(options.infilename, "rb")
# GZ: could catch a raised IOError here and report
references_relative_to = os.path.dirname(options.infilename)
else:
# GZ: could sniff for gzip compression here
#
@ -3840,7 +3840,7 @@ def getInOut(options):
# redirect informational output to stderr when SVG is output to stdout
options.stdout = sys.stderr
return [infile, outfile]
return [infile, references_relative_to, outfile]
def getReport():
@ -3862,7 +3862,7 @@ def getReport():
)
def start(options, input, output):
def start(options, input, output, references_relative_to=None):
# sanitize options (take missing attributes from defaults, discard unknown attributes)
options = sanitizeOptions(options)
@ -3870,7 +3870,7 @@ def start(options, input, output):
# do the work
in_string = input.read()
out_string = scourString(in_string, options).encode("UTF-8")
out_string = scourString(in_string, options, references_relative_to).encode("UTF-8")
output.write(out_string)
# Close input and output files (but do not attempt to close stdin/stdout!)
@ -3901,8 +3901,8 @@ def start(options, input, output):
def run():
options = parse_args()
(input, output) = getInOut(options)
start(options, input, output)
(input, input_relative_to, output) = getInOut(options)
start(options, input, output, input_relative_to)
if __name__ == '__main__':

9
testscour.py
View file

@ -2526,12 +2526,13 @@ class EmbedRasters(unittest.TestCase):
def test_disable_embed_rasters(self):
doc = scourXmlFile('unittests/raster-formats.svg',
parse_args(['--disable-embed-rasters']))
parse_args(['--disable-embed-rasters']),
'unittests')
self.assertEqual(doc.getElementById('png').getAttribute('xlink:href'), 'raster.png',
"Raster image embedded when '--disable-embed-rasters' was specified")
def test_raster_formats(self):
doc = scourXmlFile('unittests/raster-formats.svg')
doc = scourXmlFile('unittests/raster-formats.svg', None, 'unittests')
self.assertEqual(doc.getElementById('png').getAttribute('xlink:href'),
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAMAAAABAgMAAABmjvwnAAAAC'
'VBMVEUAAP//AAAA/wBmtfVOAAAACklEQVQI12NIAAAAYgBhGxZhsAAAAABJRU5ErkJggg==',
@ -2549,7 +2550,7 @@ class EmbedRasters(unittest.TestCase):
"Raster image (JPG) not correctly embedded.")
def test_raster_paths_local(self):
doc = scourXmlFile('unittests/raster-paths-local.svg')
doc = scourXmlFile('unittests/raster-paths-local.svg', None, 'unittests')
images = doc.getElementsByTagName('image')
for image in images:
href = image.getAttribute('xlink:href')
@ -2563,7 +2564,7 @@ class EmbedRasters(unittest.TestCase):
# create a reference string by scouring the original file with relative links
options = ScourOptions
options.infilename = 'unittests/raster-formats.svg'
reference_svg = scourString(svg, options)
reference_svg = scourString(svg, options, 'unittests')
# this will not always create formally valid paths but it'll check how robust our implementation is
# (the third path is invalid for sure because file: needs three slashes according to URI spec)