1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
#!/usr/bin/python
# Copyright 2008, Google Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
# * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""Flattens a HTML file by inlining its external resources.
This is a small script that takes a HTML file, looks for src attributes
and inlines the specified file, producing one HTML file with no external
dependencies.
This does not inline CSS styles, nor does it inline anything referenced
from an inlined file.
"""
import os
import re
import sys
import base64
import mimetypes
# TODO(rahulk) The default here will change to 'CHROMIUM' as soon as the buildbots
# are ready with the correct environment variable
DIST_DEFAULT = 'GOOGLE_CHROME'
DIST_ENV_VAR = 'CHROMIUM_BUILD'
DIST_SUBSTR = '%DISTRIBUTION%'
def ReadFile(input_filename):
"""Helper function that returns input_filename as a string.
Args:
input_filename: name of file to be read
Returns:
string
"""
f = open(input_filename, 'rb')
file_contents = f.read()
f.close()
return file_contents
def SrcInline(src_match, base_path, distribution):
"""regex replace function.
Takes a regex match for src="filename", attempts to read the file
at 'filename' and returns the src attribute with the file inlined
as a data URI. If it finds DIST_SUBSTR string in file name, replaces
it with distribution.
Args:
src_match: regex match object with 'filename' named capturing group
base_path: path that to look for files in
distribution: string that should replace DIST_SUBSTR
Returns:
string
"""
filename = src_match.group('filename')
if filename.find(':') != -1:
# filename is probably a URL, which we don't want to bother inlining
return src_match.group(0)
filename = filename.replace('%DISTRIBUTION%', distribution)
filepath = os.path.join(base_path, filename)
mimetype = mimetypes.guess_type(filename)[0] or 'text/plain'
inline_data = base64.standard_b64encode(ReadFile(filepath))
prefix = src_match.string[src_match.start():src_match.start('filename')-1]
return "%s\"data:%s;base64,%s\"" % (prefix, mimetype, inline_data)
def InlineFile(input_filename, output_filename):
"""Inlines the resources in a specified file.
Reads input_filename, finds all the src attributes and attempts to
inline the files they are referring to, then writes the result
to output_filename.
Args:
input_filename: name of file to read in
output_filename: name of file to be written to
"""
print "inlining %s to %s" % (input_filename, output_filename)
input_filepath = os.path.dirname(input_filename)
distribution = DIST_DEFAULT
if DIST_ENV_VAR in os.environ.keys():
distribution = os.environ[DIST_ENV_VAR]
if len(distribution) > 1 and distribution[0] == '_':
distribution = distribution[1:].lower()
def SrcReplace(src_match):
"""Helper function to provide SrcInline with the base file path"""
return SrcInline(src_match, input_filepath, distribution)
# TODO(glen): Make this regex not match src="" text that is not inside a tag
flat_text = re.sub('src="(?P<filename>[^"\']*)"',
SrcReplace,
ReadFile(input_filename))
# TODO(glen): Make this regex not match url('') that is not inside a style
flat_text = re.sub('background:[ ]*url\(\'(?P<filename>[^"\']*)\'',
SrcReplace,
flat_text)
out_file = open(output_filename, 'wb')
out_file.writelines(flat_text)
out_file.close()
def main():
if len(sys.argv) <= 2:
print "Flattens a HTML file by inlining its external resources.\n"
print "html_inline.py inputfile outputfile"
else:
InlineFile(sys.argv[1], sys.argv[2])
if __name__ == '__main__':
main()
|
