1 # Copyright (C) 2006, Thomas Leonard
2 # See http://0install.net/0compile.html
4 import sys
, os
, __main__
, time
, shutil
, glob
, codecs
, subprocess
5 from os
.path
import join
6 from logging
import info
, warn
7 from xml
.dom
import minidom
, XMLNS_NAMESPACE
8 from optparse
import OptionParser
12 if hasattr(os
.path
, 'relpath'):
13 relpath
= os
.path
.relpath
15 # Copied from Python 2.6 (GPL compatible license)
16 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation; All Rights Reserved
18 # Return the longest prefix of all list elements.
20 "Given a list of pathnames, returns the longest common leading component"
24 for i
, c
in enumerate(s1
):
29 def relpath(path
, start
):
30 """Return a relative version of a path"""
33 raise ValueError("no path specified")
35 start_list
= os
.path
.abspath(start
).split('/')
36 path_list
= os
.path
.abspath(path
).split('/')
38 # Work out how much of the filepath is shared by start and path.
39 i
= len(commonprefix([start_list
, path_list
]))
41 rel_list
= ['..'] * (len(start_list
)-i
) + path_list
[i
:]
44 return join(*rel_list
)
46 # If we have to modify any pkg-config files, we put the new versions in $TMPDIR/PKG_CONFIG_OVERRIDES
47 PKG_CONFIG_OVERRIDES
= 'pkg-config-overrides'
50 os
.environ
[name
] = value
51 print "%s=%s" % (name
, value
)
53 def do_env_binding(binding
, path
):
54 env(binding
.name
, binding
.get_value(path
, os
.environ
.get(binding
.name
, None)))
56 def correct_for_64bit(base
, rel_path
):
57 """If rel_path starts lib or usr/lib and doesn't exist, try with lib64 instead."""
58 if os
.path
.exists(os
.path
.join(base
, rel_path
)):
61 if rel_path
.startswith('lib/') or rel_path
.startswith('usr/lib/'):
62 new_rel_path
= rel_path
.replace('lib/', 'lib64/', 1)
63 if os
.path
.exists(os
.path
.join(base
, new_rel_path
)):
68 def write_pc(name
, lines
):
69 overrides_dir
= os
.path
.join(os
.environ
['TMPDIR'], PKG_CONFIG_OVERRIDES
)
70 if not os
.path
.isdir(overrides_dir
):
71 os
.mkdir(overrides_dir
)
72 stream
= open(os
.path
.join(overrides_dir
, name
), 'w')
73 stream
.write(''.join(lines
))
76 def do_pkg_config_binding(binding
, impl
):
77 feed_name
= impl
.feed
.split('/')[-1]
78 path
= lookup(impl
.id)
79 new_insert
= correct_for_64bit(path
, binding
.insert
)
80 if new_insert
!= binding
.insert
:
81 print "PKG_CONFIG_PATH dir <%s>/%s not found; using %s instead" % (feed_name
, binding
.insert
, new_insert
)
82 binding
= model
.EnvironmentBinding(binding
.name
,
87 orig_path
= os
.path
.join(path
, binding
.insert
)
88 if os
.path
.isdir(orig_path
):
89 for pc
in os
.listdir(orig_path
):
90 stream
= open(os
.path
.join(orig_path
, pc
))
91 lines
= stream
.readlines()
93 for i
, line
in enumerate(lines
):
94 if '=' not in line
: continue
95 name
, value
= [x
.strip() for x
in line
.split('=', 1)]
96 if name
== 'prefix' and value
.startswith('/'):
97 print "Absolute prefix=%s in %s; overriding..." % (value
, feed_name
)
98 lines
[i
] = 'prefix=%s/%s\n' % (path
, value
[1:])
101 do_env_binding(binding
, path
)
103 def fixup_generated_pkgconfig_file(pc_file
):
104 stream
= open(pc_file
)
105 lines
= stream
.readlines()
107 for i
, line
in enumerate(lines
):
108 if '=' not in line
: continue
109 name
, value
= [x
.strip() for x
in line
.split('=', 1)]
110 if name
== 'prefix' and value
.startswith('/'):
111 print "Absolute prefix=%s in %s; fixing..." % (value
, pc_file
)
112 rel_path
= relpath(value
, os
.path
.dirname(pc_file
)) # Requires Python 2.6
113 lines
[i
] = 'prefix=${pcfiledir}/%s\n' % rel_path
114 write_pc(pc_file
, lines
)
117 # After doing a build, check that we didn't generate pkgconfig files with absolute paths
119 def fixup_generated_pkgconfig_files():
120 for root
, dirs
, files
in os
.walk(os
.environ
['DISTDIR']):
121 if os
.path
.basename(root
) == 'pkgconfig':
123 if f
.endswith('.pc'):
124 info("Checking generated pkgconfig file '%s'", f
)
125 fixup_generated_pkgconfig_file(os
.path
.join(root
, f
))
127 def remove_la_file(path
):
128 # Read the contents...
133 # Check it really is a libtool archive...
134 if 'Please DO NOT delete this file' not in data
:
135 warn("Ignoring %s; doesn't look like a libtool archive", path
)
139 print "Removed %s (.la files contain absolute paths)" % path
141 # libtool archives contain hard-coded paths. Lucky, modern systems don't need them, so remove
143 def remove_la_files():
144 for root
, dirs
, files
in os
.walk(os
.environ
['DISTDIR']):
145 if os
.path
.basename(root
) == 'lib':
147 if f
.endswith('.la'):
148 remove_la_file(os
.path
.join(root
, f
))
150 def do_build_internal(options
, args
):
152 # If a sandbox is being used, we're in it now.
153 import getpass
, socket
, time
155 buildenv
= BuildEnv()
156 sels
= buildenv
.get_selections()
158 builddir
= os
.path
.realpath('build')
159 ensure_dir(buildenv
.metadir
)
161 build_env_xml
= join(buildenv
.metadir
, 'build-environment.xml')
163 buildenv_doc
= buildenv
.get_selections().toDOM()
165 # Create build-environment.xml file
166 root
= buildenv_doc
.documentElement
167 info
= buildenv_doc
.createElementNS(XMLNS_0COMPILE
, 'build-info')
168 root
.appendChild(info
)
169 info
.setAttributeNS(None, 'time', time
.strftime('%Y-%m-%d %H:%M').strip())
170 info
.setAttributeNS(None, 'host', socket
.getfqdn())
171 info
.setAttributeNS(None, 'user', getpass
.getuser())
173 info
.setAttributeNS(None, 'arch', '%s-%s' % (uname
[0], uname
[4]))
174 stream
= file(build_env_xml
, 'w')
175 buildenv_doc
.writexml(stream
, addindent
=" ", newl
="\n")
178 # Create local binary interface file
179 src_iface
= iface_cache
.get_interface(buildenv
.interface
)
180 src_impl
= buildenv
.chosen_impl(buildenv
.interface
)
181 write_sample_interface(buildenv
, src_iface
, src_impl
)
183 # Check 0compile is new enough
184 min_version
= parse_version(src_impl
.attrs
.get(XMLNS_0COMPILE
+ ' min-version', None))
185 if min_version
and min_version
> parse_version(__main__
.version
):
186 raise SafeException("%s-%s requires 0compile >= %s, but we are only version %s" %
187 (src_iface
.get_name(), src_impl
.version
, format_version(min_version
), __main__
.version
))
190 patch_file
= join(buildenv
.metadir
, 'from-%s.patch' % src_impl
.version
)
191 if buildenv
.user_srcdir
:
192 # (ignore errors; will already be shown on stderr)
193 os
.system("diff -urN '%s' src > %s" %
194 (buildenv
.orig_srcdir
.replace('\\', '\\\\').replace("'", "\\'"),
196 if os
.path
.getsize(patch_file
) == 0:
197 os
.unlink(patch_file
)
198 elif os
.path
.exists(patch_file
):
199 os
.unlink(patch_file
)
201 env('BUILDDIR', builddir
)
202 env('DISTDIR', buildenv
.distdir
)
203 env('SRCDIR', buildenv
.user_srcdir
or buildenv
.orig_srcdir
)
207 for needed_iface
in sels
.selections
:
208 impl
= buildenv
.chosen_impl(needed_iface
)
210 for dep
in impl
.dependencies
:
211 dep_iface
= sels
.selections
[dep
.interface
]
212 for b
in dep
.bindings
:
213 if isinstance(b
, EnvironmentBinding
):
214 dep_impl
= buildenv
.chosen_impl(dep
.interface
)
215 if b
.name
== 'PKG_CONFIG_PATH':
216 do_pkg_config_binding(b
, dep_impl
)
218 do_env_binding(b
, lookup(dep_impl
.id))
221 for impl
in sels
.selections
.values():
222 new_mappings
= impl
.attrs
.get(XMLNS_0COMPILE
+ ' lib-mappings', '')
224 new_mappings
= new_mappings
.split(' ')
225 for mapping
in new_mappings
:
226 assert ':' in mapping
, "lib-mappings missing ':' in '%s' from '%s'" % (mapping
, impl
.feed
)
227 name
, major_version
= mapping
.split(':', 1)
228 assert '/' not in mapping
, "lib-mappings '%s' contains a / in the version number (from '%s')!" % (mapping
, impl
.feed
)
229 mappings
[name
] = 'lib%s.so.%s' % (name
, major_version
)
230 impl_path
= lookup(impl
.id)
231 for libdirname
in ['lib', 'usr/lib', 'lib64', 'usr/lib64']:
232 libdir
= os
.path
.join(impl_path
, libdirname
)
233 if os
.path
.isdir(libdir
):
234 find_broken_version_symlinks(libdir
, mappings
)
237 set_up_mappings(mappings
)
239 overrides_dir
= os
.path
.join(os
.environ
['TMPDIR'], PKG_CONFIG_OVERRIDES
)
240 if os
.path
.isdir(overrides_dir
):
241 add_overrides
= model
.EnvironmentBinding('PKG_CONFIG_PATH', PKG_CONFIG_OVERRIDES
)
242 do_env_binding(add_overrides
, os
.environ
['TMPDIR'])
244 # Some programs want to put temporary build files in the source directory.
245 # Make a copy of the source if needed.
246 dup_src_type
= src_impl
.attrs
.get(XMLNS_0COMPILE
+ ' dup-src', None)
247 if dup_src_type
== 'true':
248 dup_src(shutil
.copy2
)
249 env('SRCDIR', builddir
)
251 raise Exception("Unknown dup-src value '%s'" % dup_src_type
)
254 spawn_and_check(find_in_path('sh'), [])
256 command
= src_impl
.attrs
[XMLNS_0COMPILE
+ ' command']
258 # Remove any existing log files
259 for log
in ['build.log', 'build-success.log', 'build-failure.log']:
260 if os
.path
.exists(log
):
263 # Run the command, copying output to a new log
264 log
= file('build.log', 'w')
266 print >>log
, "Build log for %s-%s" % (src_iface
.get_name(),
268 print >>log
, "\nBuilt using 0compile-%s" % __main__
.version
269 print >>log
, "\nBuild system: " + ', '.join(uname
)
270 print >>log
, "\n%s:\n" % ENV_FILE
271 shutil
.copyfileobj(file("../" + ENV_FILE
), log
)
275 if os
.path
.exists(patch_file
):
276 print >>log
, "\nPatched with:\n"
277 shutil
.copyfileobj(file(patch_file
), log
)
280 print "Executing: " + command
281 print >>log
, "Executing: " + command
283 # Tee the output to the console and to the log
284 child
= subprocess
.Popen(command
, shell
= True, stdout
= subprocess
.PIPE
, stderr
= subprocess
.STDOUT
)
286 data
= os
.read(child
.stdout
.fileno(), 100)
288 sys
.stdout
.write(data
)
290 status
= child
.wait()
293 print >>log
, "Build successful"
294 fixup_generated_pkgconfig_files()
297 failure
= "Build failed with exit code %d" % status
299 failure
= "Build failure: exited due to signal %d" % (-status
)
302 os
.rename('build.log', 'build-failure.log')
303 raise SafeException("Command '%s': %s" % (command
, failure
))
305 os
.rename('build.log', 'build-success.log')
310 """build [ --no-sandbox ] [ --shell | --force | --clean ]"""
311 buildenv
= BuildEnv()
312 sels
= buildenv
.get_selections()
314 parser
= OptionParser(usage
="usage: %prog build [options]")
316 parser
.add_option('', "--no-sandbox", help="disable use of sandboxing", action
='store_true')
317 parser
.add_option("-s", "--shell", help="run a shell instead of building", action
='store_true')
318 parser
.add_option("-c", "--clean", help="remove the build directories", action
='store_true')
319 parser
.add_option("-f", "--force", help="build even if dependencies have changed", action
='store_true')
321 parser
.disable_interspersed_args()
323 (options
, args2
) = parser
.parse_args(args
)
325 builddir
= os
.path
.realpath('build')
327 changes
= buildenv
.get_build_changes()
329 if not (options
.force
or options
.clean
):
330 raise SafeException("Build dependencies have changed:\n" +
331 '\n'.join(changes
) + "\n\n" +
332 "To build anyway, use: 0compile build --force\n" +
333 "To do a clean build: 0compile build --clean")
334 if not options
.no_sandbox
:
335 print "Build dependencies have changed:\n" + '\n'.join(changes
)
337 ensure_dir(builddir
, options
.clean
)
338 ensure_dir(buildenv
.distdir
, options
.clean
)
340 if options
.no_sandbox
:
341 return do_build_internal(options
, args2
)
343 tmpdir
= tempfile
.mkdtemp(prefix
= '0compile-')
345 my_dir
= os
.path
.dirname(__file__
)
346 readable
= ['.', my_dir
]
347 writable
= ['build', buildenv
.distdir
, tmpdir
]
348 env('TMPDIR', tmpdir
)
350 for selection
in sels
.selections
.values():
351 readable
.append(lookup(selection
.id))
354 if __main__
.options
.verbose
:
355 options
.append('--verbose')
357 readable
.append('/etc') # /etc/ld.*
359 spawn_maybe_sandboxed(readable
, writable
, tmpdir
, sys
.executable
, ['-u', sys
.argv
[0]] + options
+ ['build', '--no-sandbox'] + args
)
361 info("Deleting temporary directory '%s'" % tmpdir
)
362 shutil
.rmtree(tmpdir
)
364 def write_sample_interface(buildenv
, iface
, src_impl
):
365 path
= buildenv
.local_iface_file
366 target_arch
= buildenv
.target_arch
368 impl
= minidom
.getDOMImplementation()
370 XMLNS_IFACE
= namespaces
.XMLNS_IFACE
372 doc
= impl
.createDocument(XMLNS_IFACE
, "interface", None)
374 root
= doc
.documentElement
375 root
.setAttributeNS(XMLNS_NAMESPACE
, 'xmlns', XMLNS_IFACE
)
377 def addSimple(parent
, name
, text
= None):
378 elem
= doc
.createElementNS(XMLNS_IFACE
, name
)
380 parent
.appendChild(doc
.createTextNode('\n' + ' ' * (1 + depth(parent
))))
381 parent
.appendChild(elem
)
383 elem
.appendChild(doc
.createTextNode(text
))
387 element
.appendChild(doc
.createTextNode('\n' + ' ' * depth(element
)))
389 addSimple(root
, 'name', iface
.name
)
390 addSimple(root
, 'summary', iface
.summary
)
391 addSimple(root
, 'description', iface
.description
)
392 feed_for
= addSimple(root
, 'feed-for')
395 if uri
.startswith('/'):
396 print "Note: source %s is a local feed" % iface
.uri
397 for feed_uri
in iface
.feed_for
or []:
399 print "Will use <feed-for interface='%s'> instead..." % uri
402 master_feed
= minidom
.parse(uri
).documentElement
403 if master_feed
.hasAttribute('uri'):
404 uri
= master_feed
.getAttribute('uri')
405 print "Will use <feed-for interface='%s'> instead..." % uri
407 feed_for
.setAttributeNS(None, 'interface', uri
)
409 group
= addSimple(root
, 'group')
410 main
= src_impl
.attrs
.get(XMLNS_0COMPILE
+ ' binary-main', None)
412 group
.setAttributeNS(None, 'main', main
)
414 lib_mappings
= src_impl
.attrs
.get(XMLNS_0COMPILE
+ ' binary-lib-mappings', None)
416 root
.setAttributeNS(XMLNS_NAMESPACE
, 'xmlns:compile', XMLNS_0COMPILE
)
417 group
.setAttributeNS(XMLNS_0COMPILE
, 'compile:lib-mappings', lib_mappings
)
419 for d
in src_impl
.dependencies
:
420 # 0launch < 0.32 messed up the namespace...
421 if parse_bool(d
.metadata
.get('include-binary', 'false')) or \
422 parse_bool(d
.metadata
.get(XMLNS_0COMPILE
+ ' include-binary', 'false')):
423 requires
= addSimple(group
, 'requires')
424 requires
.setAttributeNS(None, 'interface', d
.interface
)
426 if isinstance(b
, model
.EnvironmentBinding
):
427 env_elem
= addSimple(requires
, 'environment')
428 env_elem
.setAttributeNS(None, 'name', b
.name
)
429 env_elem
.setAttributeNS(None, 'insert', b
.insert
)
431 env_elem
.setAttributeNS(None, 'default', b
.default
)
433 raise Exception('Unknown binding type ' + b
)
436 group
.setAttributeNS(None, 'arch', target_arch
)
437 impl_elem
= addSimple(group
, 'implementation')
438 impl_elem
.setAttributeNS(None, 'version', src_impl
.version
)
440 version_modifier
= buildenv
.version_modifier
442 impl_elem
.setAttributeNS(None, 'version-modifier', version_modifier
)
444 impl_elem
.setAttributeNS(None, 'id', '..')
445 impl_elem
.setAttributeNS(None, 'released', time
.strftime('%Y-%m-%d'))
449 stream
= codecs
.open(path
, 'w', encoding
= 'utf-8')
455 def find_broken_version_symlinks(libdir
, mappings
):
456 """libdir may be a legacy -devel package containing lib* symlinks whose
457 targets would be provided by the corresponding runtime package. If so,
458 create fixed symlinks under $TMPDIR with the real location."""
459 for x
in os
.listdir(libdir
):
460 if x
.startswith('lib') and x
.endswith('.so'):
461 path
= os
.path
.join(libdir
, x
)
462 if os
.path
.islink(path
):
463 target
= os
.readlink(path
)
464 if '/' not in target
and not os
.path
.exists(os
.path
.join(libdir
, target
)):
465 print "Broken link %s -> %s; will relocate..." % (x
, target
)
466 mappings
[x
[3:-3]] = target
468 def set_up_mappings(mappings
):
469 """Create a temporary directory with symlinks for each of the library mappings."""
471 for d
in os
.environ
.get('LD_LIBRARY_PATH', '').split(':'):
472 if d
: libdirs
.append(d
)
473 libdirs
+= ['/lib', '/usr/lib']
475 def add_ldconf(config_file
):
476 if not os
.path
.isfile(config_file
):
478 for line
in file(config_file
):
480 if d
.startswith('include '):
481 glob_pattern
= d
.split(' ', 1)[1]
482 for conf
in glob
.glob(glob_pattern
):
484 elif d
and not d
.startswith('#'):
486 add_ldconf('/etc/ld.so.conf')
488 def find_library(name
, wanted
):
489 # Takes a short-name and target name of a library and returns
490 # the full path of the library.
492 path
= os
.path
.join(d
, wanted
)
493 if os
.path
.exists(path
):
495 print "WARNING: library '%s' not found (searched '%s')!" % (wanted
, libdirs
)
498 mappings_dir
= os
.path
.join(os
.environ
['TMPDIR'], 'lib-mappings')
499 os
.mkdir(mappings_dir
)
501 old_path
= os
.environ
.get('LIBRARY_PATH', '')
502 if old_path
: old_path
= ':' + old_path
503 os
.environ
['LIBRARY_PATH'] = mappings_dir
+ old_path
505 for name
, wanted
in mappings
.items():
506 target
= find_library(name
, wanted
)
508 print "Adding mapping lib%s.so -> %s" % (name
, target
)
509 os
.symlink(target
, os
.path
.join(mappings_dir
, 'lib' + name
+ '.so'))
512 srcdir
= os
.environ
['SRCDIR'] + '/'
513 for root
, dirs
, files
in os
.walk(srcdir
):
514 assert root
.startswith(srcdir
)
515 reldir
= root
[len(srcdir
):]
517 target
= os
.path
.join(reldir
, f
)
518 #print "Copy %s -> %s" % (os.path.join(root, f), target)
519 if os
.path
.exists(target
):
521 fn(os
.path
.join(root
, f
), target
)
523 target
= os
.path
.join(reldir
, d
)
524 if not os
.path
.isdir(target
):
527 __main__
.commands
.append(do_build
)