summaryrefslogtreecommitdiff
path: root/src/dh_xul-ext
blob: 725d0b5c36ef5357534ae4e2d043e16582b23429 (plain)
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
#!/usr/bin/python

# Copyright (c) 2009 Benjamin Drung <bdrung@ubuntu.com>
#
# 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 csv
import getopt
import glob
import os
import subprocess
import sys

from moz_version import compare_versions

from rdflib import Namespace
from rdflib.Graph import Graph

# error codes
COMMAND_LINE_SYNTAX_ERROR = 1
MULTIPLE_INSTALL_RDFs = 2

def get_xul_apps():
	csvfile = open("/usr/share/mozilla-devscripts/xul-app-data.csv")
	csv_reader = csv.DictReader(csvfile)
	rows = []
	for row in csv_reader:
		rows.append(row)
	return rows

def get_supported_apps(script_name, xul_apps, install_rdf, package, verbose=False):
	# create array of id_max_min triples
	id_max_min = []
	rdf_graph = Graph()
	rdf_graph.parse(install_rdf)
	results = rdf_graph.query(
	  """
		SELECT ?id ?max ?min
		WHERE {
			?x1 em:targetApplication ?x2 .
			?x2 em:id ?id .
			OPTIONAL {
				?x2 em:maxVersion ?max .
				?x2 em:minVersion ?min .
			} .
		}
	  """, initNs=dict(em=Namespace("http://www.mozilla.org/2004/em-rdf#")))

	# append to id_max_min tripe to array
	for target in results:
		id_max_min.append (( str(target[0]), str(target[1]), str (target[2]) ))

	if verbose:
		print "%s: %s supports %i XUL application(s):" % (script_name, package, len(id_max_min))
		for (appid, max_version, min_version) in id_max_min:
			print "%s %s to %s" % (appid, min_version, max_version)

	# find supported apps/packages
	supported_apps = list()
	for xul_app in xul_apps:
		supported_app = filter(lambda x: x[0] == xul_app["id"], id_max_min)
		if len(supported_app) == 1:
			# package is supported by extension
			(appid, max_version, min_version) = supported_app.pop()
			if compare_versions(xul_app["sol"], max_version) <= 0:
				if compare_versions(xul_app["eol"], min_version) >= 0:
					supported_apps.append(xul_app["package"])
					if verbose:
						print "%s: %s supports %s." % (script_name, package, xul_app["package"])
				elif verbose:
					print "%s: %s does not support %s (any more)." % (script_name, package, xul_app["package"])
			elif verbose:
				print "%s: %s does not support %s (yet)." % (script_name, package, xul_app["package"])
		elif len(supported_app) > 1:
			print "%s: Found error in %s. There are multiple entries for application ID %s." % \
				(script_name, install_rdf, xul_app["id"])

	return supported_apps

def get_all_packages():
	lines = open("debian/control").readlines()
	package_lines = filter(lambda x: x.find("Package:") >= 0, lines)
	packages = map(lambda x: x[x.find(":")+1:].strip(), package_lines)
	return packages

def get_source_package_name():
	source = None
	with open("debian/control") as f:
		for line in f:
			if line.startswith("Source:"):
				source = line[line.find(":")+1:].strip()
				break
	return source


def get_provided_package_names(package, supported_apps):
	ext_name = package
	for prefix in ("firefox-", "iceweasel-", "mozilla-", "xul-ext-"):
		if ext_name.startswith(prefix):
			ext_name = ext_name[len(prefix):]

	# check if MOZ_XPI_EXT_NAME is defined in debian/rules
	lines = open("debian/rules").readlines()
	lines = filter(lambda x: x.find("MOZ_XPI_EXT_NAME") != -1, lines)
	if len(lines) > 0:
		ext_name = lines[-1][line.find("=")+1:].strip()

	provides = set()
	provides.add("xul-ext-" + ext_name)
	if ext_name == get_source_package_name():
		provides.add(ext_name)

	for app in supported_apps:
		for i in xrange(len(app) - 1, -1, -1):
			if app[i] == '-':
				app = app[:i]
			elif not app[i].isdigit() and not app[i] == '.':
				break
		provides.add(app + "-" + ext_name)

	# remove package name from provide list
	provides.discard(package)

	return list(provides)

def find_install_rdfs(path):
	install_rdfs = set()

	if os.path.isfile(path) and os.path.basename(path) == "install.rdf":
		install_rdfs.add(os.path.realpath(path))

	if os.path.isdir(path):
		# recursive walk
		content = map(lambda d: os.path.join(path, d), os.listdir(path))
		install_rdfs = reduce(lambda x, d: x.union(find_install_rdfs(d)), content, install_rdfs)

	return install_rdfs

def generate_substvars(script_name, xul_apps, package, verbose=False):
	install_rdfs = find_install_rdfs("debian/" + package)
	if len(install_rdfs) == 0:
		# this package does not contain a xul extension
		return
	elif len(install_rdfs) > 1:
		print >> sys.stderr, "%s: %s contains multiple install.rdf files. That's not supported." % (script_name, package)
		sys.exit(MULTIPLE_INSTALL_RDFs)
	install_rdf = install_rdfs.pop()

	filename = "debian/" + package + ".substvars"
	if os.path.exists(filename):
		f = open(filename)
		lines = f.readlines()
		f.close()
	else:
		lines = list()

	# remove existing varibles
	lines = filter(lambda s: not s.startswith("xpi:"), lines)

	packages = get_supported_apps(script_name, xul_apps, install_rdf, package, verbose)
	lines.append("xpi:Recommends=" + " | ".join(packages) + "\n")
	lines.append("xpi:Enhances=" + ", ".join(sorted(packages)) + "\n")
	packages = get_provided_package_names(package, packages)
	lines.append("xpi:Provides=" + ", ".join(sorted(packages)) + "\n")

	# write new variables
	f = open(filename, "w")
	f.writelines(lines)
	f.close()

def usage(output):
	print >> output, """Usage: %s [options]

Options:
  -p, --package=<value>     calculate substvars only for the specified package

General options:
  -h, --help                display this help and exit
  -v, --verbose             print more information

See %s(1) for more info.""" % (sys.argv[0], os.path.basename(sys.argv[0]))

if __name__ == "__main__":
	try:
		long_opts = ["help", "package", "verbose"]
		opts, args = getopt.gnu_getopt(sys.argv[1:], "hp:v", long_opts)
	except getopt.GetoptError, e:
		# print help information and exit:
		print >> sys.stderr, str(e) # will print something like "option -a not recognized"
		usage(sys.stderr)
		sys.exit(COMMAND_LINE_SYNTAX_ERROR)

	packages = list()
	verbose = False

	for o, a in opts:
		if o in ("-h", "--help"):
			usage(sys.stdout)
			sys.exit()
		elif o in ("-p", "--package"):
			packages.append(a)
		elif o in ("-v", "--verbose"):
			verbose = True
		else:
			assert False, "unhandled option"

	if len(packages) == 0:
		packages = get_all_packages()

	script_name = os.path.basename(sys.argv[0])

	if verbose:
		print script_name + ": packages:", ", ".join(packages)

	xul_apps = get_xul_apps()
	if verbose and len(xul_apps) > 0:
		print script_name + ": found %i Xul applications:" % (len(xul_apps))
		for xul_app in xul_apps:
			print xul_app["id"] + ": " + xul_app["package"] + " (" + xul_app["sol"] + " to " + xul_app["eol"] + ")"

	for package in packages:
		generate_substvars(script_name, xul_apps, package, verbose)