[GTK] Sort inspector GResource manifest to ensure reproducible builds
[WebKit-https.git] / Tools / glib / generate-inspector-gresource-manifest.py
1 #!/usr/bin/env python
2 # Copyright (C) 2013 Igalia S.L.
3 #
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2 of the License, or (at your option) any later version.
8 #
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 # Lesser General Public License for more details.
13 #
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17
18 import argparse
19 import os
20 import sys
21
22 VALID_EXTENSIONS = ['.html', '.js', '.css', '.svg', '.png']
23 COMPRESSIBLE_EXTENSIONS = ['.html', '.js', '.css', '.svg']
24 BASE_DIR = 'WebInspectorUI/'
25
26
27 def get_filenames(directory):
28     filenames = []
29
30     def should_ignore_resource(resource):
31         if resource.startswith(os.path.join('Protocol', 'Legacy')):
32             return True
33         if os.path.splitext(resource)[1] not in VALID_EXTENSIONS:
34             return True
35
36     for root, dirs, files in os.walk(directory):
37         dirs.sort()
38         files.sort()
39         for file in files:
40             filename = os.path.join(root, file)
41             base_dir_index = filename.rfind(BASE_DIR)
42             if base_dir_index == -1:
43                 continue
44
45             name = filename[base_dir_index + len(BASE_DIR):]
46             # The result should use forward slashes, thus make sure any os-specific
47             # separator, is properly replaced
48             if os.sep != '/':
49                 name = name.replace(os.sep, '/')
50             if not should_ignore_resource(name):
51                 filenames.append(name)
52
53     return filenames
54
55
56 def is_compressible(filename):
57     return os.path.splitext(filename)[1] in COMPRESSIBLE_EXTENSIONS
58
59
60 if __name__ == "__main__":
61     parser = argparse.ArgumentParser(description='Generate a GResources file for the inspector.')
62     parser.add_argument('--input', type=str,
63                         help='the input directory')
64     parser.add_argument('--output', nargs='?', type=argparse.FileType('w'), default=sys.stdout,
65                         help='the output file')
66
67     args = parser.parse_args(sys.argv[1:])
68
69     args.output.write(\
70     """<?xml version=1.0 encoding=UTF-8?>
71     <gresources>
72         <gresource prefix="/org/webkit/inspector">
73 """)
74
75     for filename in get_filenames(args.input):
76         line = '            <file'
77         if is_compressible(filename):
78             line += ' compressed="true"'
79         if not filename.startswith('Localization'):
80             alias = 'UserInterface/' + filename
81             line += ' alias="%s"' % alias
82         line += '>%s</file>\n' % filename
83
84         args.output.write(line)
85
86     args.output.write(\
87     """    </gresource>
88 </gresources>
89 """)