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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
|
# pristinetar.py -- Providers of upstream source
# Copyright (C) 2009-2011 Canonical Ltd.
# Copyright (C) 2009 Jelmer Vernooij <jelmer@debian.org>
#
# This file is part of bzr-builddeb.
#
# bzr-builddeb is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# bzr-builddeb is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with bzr-builddeb; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
from base64 import (
standard_b64decode,
standard_b64encode,
)
import errno
import os
import shutil
import subprocess
import tempfile
from bzrlib.plugins.builddeb.errors import (
PackageVersionNotPresent,
PerFileTimestampsNotSupported,
)
from bzrlib.plugins.builddeb.upstream import UpstreamSource
from bzrlib.plugins.builddeb.util import (
debuild_config,
export,
subprocess_setup,
)
from bzrlib import (
osutils,
revision as _mod_revision,
)
from bzrlib.errors import (
BzrError,
NoSuchRevision,
NoSuchTag,
)
from bzrlib.trace import (
mutter,
note,
warning,
)
class PristineTarError(BzrError):
_fmt = 'There was an error using pristine-tar: %(error)s.'
def __init__(self, error):
BzrError.__init__(self, error=error)
class PristineTarDeltaTooLarge(PristineTarError):
_fmt = 'The delta generated was too large: %(error)s.'
def reconstruct_pristine_tar(dest, delta, dest_filename):
"""Reconstruct a pristine tarball from a directory and a delta.
:param dest: Directory to pack
:param delta: pristine-tar delta
:param dest_filename: Destination filename
"""
command = ["pristine-tar", "gentar", "-",
os.path.abspath(dest_filename)]
try:
proc = subprocess.Popen(command, stdin=subprocess.PIPE,
cwd=dest, preexec_fn=subprocess_setup,
stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
except OSError, e:
if e.errno == errno.ENOENT:
raise PristineTarError("pristine-tar is not installed")
else:
raise
(stdout, stderr) = proc.communicate(delta)
if proc.returncode != 0:
raise PristineTarError("Generating tar from delta failed: %s" % stdout)
def make_pristine_tar_delta(dest, tarball_path):
"""Create a pristine-tar delta for a tarball.
:param dest: Directory to generate pristine tar delta for
:param tarball_path: Path to the tarball
:return: pristine-tarball
"""
# If tarball_path is relative, the cwd=dest parameter to Popen will make
# pristine-tar faaaail. pristine-tar doesn't use the VFS either, so we
# assume local paths.
tarball_path = osutils.abspath(tarball_path)
command = ["pristine-tar", "gendelta", tarball_path, "-"]
try:
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
cwd=dest, preexec_fn=subprocess_setup,
stderr=subprocess.PIPE)
except OSError, e:
if e.errno == errno.ENOENT:
raise PristineTarError("pristine-tar is not installed")
else:
raise
(stdout, stderr) = proc.communicate()
if proc.returncode != 0:
if 'excessively large binary delta' in stderr:
raise PristineTarDeltaTooLarge(stderr)
else:
raise PristineTarError("Generating delta from tar failed: %s" %
stderr)
return stdout
class PristineTarSource(UpstreamSource):
"""Source that uses the pristine-tar revisions in the packaging branch."""
def __init__(self, tree, branch):
self.branch = branch
self.tree = tree
def __repr__(self):
return "<%s at %s>" % (self.__class__.__name__, self.branch.base)
def tag_name(self, version, component=None, distro=None):
"""Gets the tag name for the upstream part of version.
:param version: the Version object to extract the upstream
part of the version number from.
:param component: Name of the component (None for base)
:param distro: Optional distribution name
:return: a String with the name of the tag.
"""
assert isinstance(version, str)
if distro is None:
name = "upstream-" + version
else:
name = "upstream-%s-%s" % (distro, version)
if component is not None:
name += "/%s" % component
return name
def tag_version(self, version, revid, component=None):
"""Tags the upstream branch's last revision with an upstream version.
Sets a tag on the last revision of the upstream branch and on the main
branch with a tag that refers to the upstream part of the version
provided.
:param version: the upstream part of the version number to derive the
tag name from.
:param component: name of the component that is being imported
(None for base)
:param revid: the revid to associate the tag with, or None for the
tip of self.pristine_upstream_branch.
:return The tag name, revid of the added tag.
"""
assert isinstance(version, str)
tag_name = self.tag_name(version, component=component)
self.branch.tags.set_tag(tag_name, revid)
return tag_name, revid
def import_component_tarball(self, package, version, tree, parent_ids,
component=None, md5=None, tarball=None, author=None, timestamp=None,
subdir=None, exclude=None):
"""Import a tarball.
:param package: Package name
:param version: Upstream version
:param parent_ids: Dictionary mapping component names to revision ids
:param component: Component name (None for base)
:param exclude: Exclude directories
"""
if exclude is None:
exclude = []
def include_change(c):
if not exclude:
return True
path = c[1][1]
if path is None:
return True
for e in exclude:
if path == e or path.startswith(e+"/"):
return False
else:
return True
revprops = {}
if md5 is not None:
revprops["deb-md5"] = md5
delta = self.make_pristine_tar_delta(tree, tarball, subdir=subdir,
exclude=exclude)
uuencoded = standard_b64encode(delta)
if tarball.endswith(".tar.bz2"):
revprops["deb-pristine-delta-bz2"] = uuencoded
elif tarball.endswith(".tar.xz"):
revprops["deb-pristine-delta-xz"] = uuencoded
else:
revprops["deb-pristine-delta"] = uuencoded
if author is not None:
revprops['authors'] = author
timezone = None
if timestamp is not None:
timezone = timestamp[1]
timestamp = timestamp[0]
message = "Import upstream version %s" % (version,)
if component is not None:
message += ", component %s" % component
revprops["deb-component"] = component
if len(parent_ids) == 0:
base_revid = _mod_revision.NULL_REVISION
else:
base_revid = parent_ids[0]
basis_tree = tree.branch.repository.revision_tree(base_revid)
tree.lock_write()
try:
builder = tree.branch.get_commit_builder(parents=parent_ids,
revprops=revprops, timestamp=timestamp, timezone=timezone)
builder.will_record_deletes()
try:
changes = [c for c in tree.iter_changes(basis_tree) if
include_change(c)]
list(builder.record_iter_changes(tree, base_revid, changes))
builder.finish_inventory()
except:
builder.abort()
raise
revid = builder.commit(message)
tag_name, _ = self.tag_version(version, revid=revid, component=component)
tree.update_basis_by_delta(revid, builder.get_basis_delta())
finally:
tree.unlock()
mutter(
'imported %s version %s component %r as revid %s, tagged %s',
package, version, component, revid, tag_name)
return tag_name, revid
def fetch_component_tarball(self, package, version, component, target_dir):
revid = self.version_component_as_revision(package, version, component)
try:
rev = self.branch.repository.get_revision(revid)
except NoSuchRevision:
raise PackageVersionNotPresent(package, version, self)
if self.has_pristine_tar_delta(rev):
format = self.pristine_tar_format(rev)
else:
format = 'gz'
target_filename = self._tarball_path(package, version, component,
target_dir, format=format)
note("Using pristine-tar to reconstruct %s.", os.path.basename(target_filename))
try:
self.reconstruct_pristine_tar(revid, package, version, target_filename)
except PristineTarError:
raise PackageVersionNotPresent(package, version, self)
except PerFileTimestampsNotSupported:
raise PackageVersionNotPresent(package, version, self)
return target_filename
def fetch_tarballs(self, package, version, target_dir, components=None):
if components is None:
# Scan tags for components
try:
components = self._components_by_version()[version].keys()
except KeyError:
raise PackageVersionNotPresent(package, version, self)
return [self.fetch_component_tarball(package, version, component, target_dir)
for component in components]
def _has_revision(self, revid, md5=None):
self.branch.lock_read()
try:
graph = self.branch.repository.get_graph()
if not graph.is_ancestor(revid, self.branch.last_revision()):
return False
finally:
self.branch.unlock()
if md5 is None:
return True
rev = self.branch.repository.get_revision(revid)
try:
return rev.properties['deb-md5'] == md5
except KeyError:
warning("tag present in branch, but there is no "
"associated 'deb-md5' property in associated "
"revision %s", revid)
return True
def version_as_revisions(self, package, version, tarballs=None):
if tarballs is None:
# FIXME: What if there are multiple tarballs?
return {
None: self.version_component_as_revision(package, version, component=None) }
ret = {}
for (tarball, component, md5) in tarballs:
ret[component] = self.version_component_as_revision(
package, version, component, md5)
return ret
def version_component_as_revision(self, package, version, component, md5=None):
assert isinstance(version, str)
for tag_name in self.possible_tag_names(version, component=component):
try:
revid = self.branch.tags.lookup_tag(tag_name)
except NoSuchTag:
continue
else:
if self._has_revision(revid, md5=md5):
return revid
tag_name = self.tag_name(version, component=component)
try:
return self.branch.tags.lookup_tag(tag_name)
except NoSuchTag:
raise PackageVersionNotPresent(package, version, self)
def has_version(self, package, version, tarballs=None):
if tarballs is None:
return self.has_version_component(package, version, component=None)
else:
for (tarball, component, md5) in tarballs:
if not self.has_version_component(package, version, component, md5):
return False
return True
def has_version_component(self, package, version, component, md5=None):
assert isinstance(version, str), str(type(version))
for tag_name in self.possible_tag_names(version, component=component):
try:
revid = self.branch.tags.lookup_tag(tag_name)
except NoSuchTag:
continue
else:
if self._has_revision(revid, md5=md5):
return True
return False
def possible_tag_names(self, version, component):
assert isinstance(version, str)
tags = [self.tag_name(version, component=component),
self.tag_name(version, component=component, distro="debian"),
self.tag_name(version, component=component, distro="ubuntu"),
]
if component is None:
# compatibility with git-buildpackage
tags += ["upstream/%s" % version]
# compatibility with svn-buildpackage
tags += ["upstream_%s" % version]
return tags
def has_pristine_tar_delta(self, rev):
return ('deb-pristine-delta' in rev.properties
or 'deb-pristine-delta-bz2' in rev.properties
or 'deb-pristine-delta-xz' in rev.properties)
def pristine_tar_format(self, rev):
if 'deb-pristine-delta' in rev.properties:
return 'gz'
elif 'deb-pristine-delta-bz2' in rev.properties:
return 'bz2'
elif 'deb-pristine-delta-xz' in rev.properties:
return 'xz'
assert self.has_pristine_tar_delta(rev)
raise AssertionError("Not handled new delta type in "
"pristine_tar_format")
def pristine_tar_delta(self, rev):
if 'deb-pristine-delta' in rev.properties:
uuencoded = rev.properties['deb-pristine-delta']
elif 'deb-pristine-delta-bz2' in rev.properties:
uuencoded = rev.properties['deb-pristine-delta-bz2']
elif 'deb-pristine-delta-xz' in rev.properties:
uuencoded = rev.properties['deb-pristine-delta-xz']
else:
assert self.has_pristine_tar_delta(rev)
raise AssertionError("Not handled new delta type in "
"pristine_tar_delta")
return standard_b64decode(uuencoded)
def reconstruct_pristine_tar(self, revid, package, version,
dest_filename):
"""Reconstruct a pristine-tar tarball from a bzr revision."""
tree = self.branch.repository.revision_tree(revid)
tmpdir = tempfile.mkdtemp(prefix="builddeb-pristine-")
try:
dest = os.path.join(tmpdir, "orig")
rev = self.branch.repository.get_revision(revid)
if self.has_pristine_tar_delta(rev):
export(tree, dest, format='dir')
delta = self.pristine_tar_delta(rev)
reconstruct_pristine_tar(dest, delta, dest_filename)
else:
export(tree, dest_filename, require_per_file_timestamps=True)
finally:
shutil.rmtree(tmpdir)
def make_pristine_tar_delta(self, tree, tarball_path, subdir=None, exclude=None):
tmpdir = tempfile.mkdtemp(prefix="builddeb-pristine-")
try:
dest = os.path.join(tmpdir, "orig")
tree.lock_read()
try:
for (dp, ie) in tree.iter_entries_by_dir():
ie._read_tree_state(dp, tree)
export(tree, dest, format='dir', subdir=subdir)
finally:
tree.unlock()
try:
return make_pristine_tar_delta(dest, tarball_path)
except PristineTarDeltaTooLarge:
raise
except PristineTarError: # I.e. not PristineTarDeltaTooLarge
conf = debuild_config(tree, True)
if conf.debug_pristine_tar:
revno, revid = tree.branch.last_revision_info()
preserved = osutils.pathjoin(osutils.dirname(tarball_path),
'orig-%s' % (revno,))
mutter('pristine-tar failed for delta between %s rev: %s'
' and tarball %s'
% (tree.basedir, (revno, revid), tarball_path))
osutils.copy_tree(
dest, preserved)
mutter('The failure can be reproduced with:\n'
' cd %s\n'
' pristine-tar -vdk gendelta %s -'
% (preserved, tarball_path))
raise
finally:
shutil.rmtree(tmpdir)
def _components_by_version(self):
ret = {}
for tag_name, tag_revid in self.branch.tags.get_tag_dict().iteritems():
if not is_upstream_tag(tag_name):
continue
(component, version) = upstream_tag_version(tag_name)
ret.setdefault(version, {})[component] = tag_revid
return ret
def iter_versions(self):
"""Iterate over all upstream versions.
:return: Iterator over (tag_name, version, revid) tuples
"""
ret = self._components_by_version()
return ret.iteritems()
def is_upstream_tag(tag):
"""Return true if tag is an upstream tag.
:param tag: The string name of the tag.
:return: True if the tag name is one generated by upstream tag operations.
"""
return (tag.startswith('upstream-') or tag.startswith('upstream/') or
tag.startswith('upstream_'))
def upstream_tag_version(tag):
"""Return the upstream version portion of an upstream tag name.
:param tag: The string name of the tag.
:return: tuple with version portion of the tag and component name
"""
assert is_upstream_tag(tag), "Not an upstream tag: %s" % tag
if tag.startswith('upstream/'):
tag = tag[len('upstream/'):]
elif tag.startswith('upstream_'):
tag = tag[len('upstream_'):]
elif tag.startswith('upstream-'):
tag = tag[len('upstream-'):]
if tag.startswith('debian-'):
tag = tag[len('debian-'):]
elif tag.startswith('ubuntu-'):
tag = tag[len('ubuntu-'):]
if not '/' in tag:
return (None, tag)
(version, component) = tag.rsplit('/', 1)
if component == "":
component = None
return (component, version)
|