summaryrefslogtreecommitdiff
path: root/src/install-xpi
blob: 071507c3de7269f9cef00803dab61431d72b6454 (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
#!/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 getopt
import os
import stat
import subprocess
import sys
import zipfile

from rdflib import Namespace
from rdflib.Graph import Graph

# error codes
COMMAND_LINE_SYNTAX_ERROR = 1
XPI_FILE_DOES_NOT_EXISTS = 2

def get_target_applications(script_name, install_rdf, verbose=False):
	target_applications = []
	rdf_graph = Graph()
	rdf_graph.parse(install_rdf)
	query = "SELECT ?id WHERE { ?x1 em:targetApplication ?x2 . ?x2 em:id ?id }"
	results = rdf_graph.query(query, initNs=dict(em=Namespace("http://www.mozilla.org/2004/em-rdf#")))
	for target in results:
		target_applications.append(str(target[0]))
	return target_applications

def get_extension_id(install_rdf):
	extension_ids = set()
	rdf_graph = Graph()
	rdf_graph.parse(install_rdf)
	query = "SELECT ?id WHERE {?x1 em:targetApplication ?x2 . ?x1 em:id ?id }"
	results = rdf_graph.query(query, initNs=dict(em=Namespace("http://www.mozilla.org/2004/em-rdf#")))
	for result in results:
		extension_ids.add(str(result[0]))
	return extension_ids.pop()

def get_arch(package):
	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)
	architecture_lines = filter(lambda x: x.find("Architecture:") >= 0, lines)
	architectures = map(lambda x: x[x.find(":")+1:].strip(), architecture_lines)
	(p, arch) = filter(lambda (x, y): x == package, zip(packages, architectures))[0]
	return arch

def get_mode(filename):
	st = os.stat(filename)
	mode = st[stat.ST_MODE]
	return mode & 0777

def install_xpi(script_name, package, xpi_file, exclude, links, correct_permissions, remove_licenses, verbose=False):
	# get xpi file content list
	if not os.path.isfile(xpi_file):
		print >> sys.stderr, "%s: Error: xpi file %s does not exist." % (script_name, xpi_file)
		sys.exit(XPI_FILE_DOES_NOT_EXISTS)
	zfobj = zipfile.ZipFile(xpi_file)
	xpi_content = zfobj.namelist()

	# determine installation directory
	if get_arch(package) == "all":
		lib_share_dir = "share"
	else:
		lib_share_dir = "lib"
	install_dir = os.path.join("debian", package, "usr", lib_share_dir, package)
	if verbose:
		print "%s: install directory: %s" % (script_name, install_dir)

	# remove documented license files
	if remove_licenses:
		pattern_list = ("copying", "gpl.txt", "licence", "license", "licence.txt", "license.txt")
		for name in filter(lambda x: not x.endswith('/'), xpi_content):
			basename = os.path.basename(name).lower()
			if basename in pattern_list:
				exclude.append(name)
				print "%s: exclude license file %s" % (script_name, name)

	# create directory and extract xpi file
	if not os.path.isdir(install_dir):
		os.makedirs(install_dir)
	command = ["unzip", "-o", "-d", install_dir, xpi_file]
	if len(exclude) > 0:
		command.append("-x")
		command.extend(exclude)
	print " ".join(command)
	subprocess.call(command)

	# correct permissons of files to 644 and directories to 755
	if correct_permissions:
		for name in xpi_content:
			filename = os.path.join(install_dir, name)
			if os.path.exists(filename):
				mode = get_mode(filename)
				if os.path.isdir(filename) and mode != 0755:
					print "%s: correct permission from %s to %s of %s" % (script_name, oct(mode), oct(0755), name)
					os.chmod(filename, 0755)
				elif os.path.isfile(filename):
					header = open(filename, "r").read(2)
					if header != "#!" and mode != 0644:
						# file without shebang
						print "%s: correct permission from %s to %s of %s" % (script_name, oct(mode), oct(0644), name)
						os.chmod(filename, 0644)
					elif header == "#!" and mode != 0755:
						# file with shebang
						print "%s: correct permission from %s to %s of %s" % (script_name, oct(mode), oct(0755), name)
						os.chmod(filename, 0755)

	# get symlinks list
	extension_id = get_extension_id(os.path.join(install_dir, "install.rdf"))
	target_applications = get_target_applications(script_name, os.path.join(install_dir, "install.rdf"))
	for target_application in target_applications:
		destination = os.path.join("/usr/lib/mozilla/extensions/", target_application, extension_id)
		links.add(destination)

	# create symlinks
	source = os.path.join("/usr", lib_share_dir, package)
	for link in links:
		command = ["dh_link", "-p" + package, source, link]
		print " ".join(command)
		subprocess.call(command)

def get_first_package():
	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[0]

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

Options:
  -x, --exclude=<file>         do not install specified file
  -l, --link=<directory>       link from directory to extension directory
  -p, --package=<value>        install the extension into specified package
      --preserve-permissions   do not adjust the file permissions
  -r, --remove-license-files   do not install license files

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 = ["exclude", "help", "link", "package",
				"preserve-permissions", "remove-license-files", "verbose"]
		opts, args = getopt.gnu_getopt(sys.argv[1:], "hl:p:rvx:", 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)

	correct_permissions = True
	links = set()
	package = None
	remove_licenses = False
	verbose = False
	exclude = list()

	for o, a in opts:
		if o in ("-x", "--exclude"):
			exclude.append(a)
		elif o in ("-h", "--help"):
			usage(sys.stdout)
			sys.exit()
		elif o in ("-l", "--link"):
			links.add(a)
		elif o in ("-p", "--package"):
			package = a
		elif o in ("preserve-permissions"):
			correct_permissions = False
		elif o in ("-r", "--remove-license-files"):
			remove_licenses = True
		elif o in ("-v", "--verbose"):
			verbose = True
		else:
			assert False, "unhandled option"

	if package is None:
		package = get_first_package()

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

	if len(args) == 0:
		print >> sys.stderr, "%s: Error: No xpi file specified." % (script_name)
		sys.exit(COMMAND_LINE_SYNTAX_ERROR)
	elif len(args) > 1:
		print >> sys.stderr, script_name + ": Error: Multiple xpi files specified: " + ", ".join(args)
		sys.exit(COMMAND_LINE_SYNTAX_ERROR)

	if verbose:
		print script_name + ": Install %s into package %s." % (args[0], package)

	install_xpi(script_name, package, args[0], exclude, links, correct_permissions, remove_licenses, verbose)