/usr/lib/python2.7/dist-packages/bzrlib/export/tar_exporter.py is in python-bzrlib 2.7.0-2ubuntu3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # Copyright (C) 2005, 2006, 2008-2011 Canonical Ltd
#
# This program 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.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Export a tree to a tarball."""
from __future__ import absolute_import
import os
import StringIO
import sys
import tarfile
from bzrlib import (
errors,
osutils,
)
from bzrlib.export import _export_iter_entries
def prepare_tarball_item(tree, root, final_path, tree_path, entry, force_mtime=None):
"""Prepare a tarball item for exporting
:param tree: Tree to export
:param final_path: Final path to place item
:param tree_path: Path for the entry in the tree
:param entry: Entry to export
:param force_mtime: Option mtime to force, instead of using tree
timestamps.
Returns a (tarinfo, fileobj) tuple
"""
filename = osutils.pathjoin(root, final_path).encode('utf8')
item = tarfile.TarInfo(filename)
if force_mtime is not None:
item.mtime = force_mtime
else:
item.mtime = tree.get_file_mtime(entry.file_id, tree_path)
if entry.kind == "file":
item.type = tarfile.REGTYPE
if tree.is_executable(entry.file_id, tree_path):
item.mode = 0755
else:
item.mode = 0644
# This brings the whole file into memory, but that's almost needed for
# the tarfile contract, which wants the size of the file up front. We
# want to make sure it doesn't change, and we need to read it in one
# go for content filtering.
content = tree.get_file_text(entry.file_id, tree_path)
item.size = len(content)
fileobj = StringIO.StringIO(content)
elif entry.kind == "directory":
item.type = tarfile.DIRTYPE
item.name += '/'
item.size = 0
item.mode = 0755
fileobj = None
elif entry.kind == "symlink":
item.type = tarfile.SYMTYPE
item.size = 0
item.mode = 0755
item.linkname = tree.get_symlink_target(entry.file_id, tree_path)
fileobj = None
else:
raise errors.BzrError("don't know how to export {%s} of kind %r"
% (entry.file_id, entry.kind))
return (item, fileobj)
def export_tarball_generator(tree, ball, root, subdir=None, force_mtime=None):
"""Export tree contents to a tarball.
:returns: A generator that will repeatedly produce None as each file is
emitted. The entire generator must be consumed to complete writing
the file.
:param tree: Tree to export
:param ball: Tarball to export to; it will be closed when writing is
complete.
:param subdir: Sub directory to export
:param force_mtime: Option mtime to force, instead of using tree
timestamps.
"""
try:
for final_path, tree_path, entry in _export_iter_entries(tree, subdir):
(item, fileobj) = prepare_tarball_item(
tree, root, final_path, tree_path, entry, force_mtime)
ball.addfile(item, fileobj)
yield
finally:
ball.close()
def tgz_exporter_generator(tree, dest, root, subdir, force_mtime=None,
fileobj=None):
"""Export this tree to a new tar file.
`dest` will be created holding the contents of this tree; if it
already exists, it will be clobbered, like with "tar -c".
"""
import gzip
if force_mtime is not None:
root_mtime = force_mtime
elif (getattr(tree, "repository", None) and
getattr(tree, "get_revision_id", None)):
# If this is a revision tree, use the revisions' timestamp
rev = tree.repository.get_revision(tree.get_revision_id())
root_mtime = rev.timestamp
elif tree.get_root_id() is not None:
root_mtime = tree.get_file_mtime(tree.get_root_id())
else:
root_mtime = None
is_stdout = False
basename = None
if fileobj is not None:
stream = fileobj
elif dest == '-':
stream = sys.stdout
is_stdout = True
else:
stream = open(dest, 'wb')
# gzip file is used with an explicit fileobj so that
# the basename can be stored in the gzip file rather than
# dest. (bug 102234)
basename = os.path.basename(dest)
try:
zipstream = gzip.GzipFile(basename, 'w', fileobj=stream,
mtime=root_mtime)
except TypeError:
# Python < 2.7 doesn't support the mtime argument
zipstream = gzip.GzipFile(basename, 'w', fileobj=stream)
ball = tarfile.open(None, 'w|', fileobj=zipstream)
for _ in export_tarball_generator(
tree, ball, root, subdir, force_mtime):
yield
# Closing zipstream may trigger writes to stream
zipstream.close()
if not is_stdout:
# Now we can safely close the stream
stream.close()
def tbz_exporter_generator(tree, dest, root, subdir,
force_mtime=None, fileobj=None):
"""Export this tree to a new tar file.
`dest` will be created holding the contents of this tree; if it
already exists, it will be clobbered, like with "tar -c".
"""
if fileobj is not None:
ball = tarfile.open(None, 'w|bz2', fileobj)
elif dest == '-':
ball = tarfile.open(None, 'w|bz2', sys.stdout)
else:
# tarfile.open goes on to do 'os.getcwd() + dest' for opening the
# tar file. With dest being unicode, this throws UnicodeDecodeError
# unless we encode dest before passing it on. This works around
# upstream python bug http://bugs.python.org/issue8396 (fixed in
# Python 2.6.5 and 2.7b1)
ball = tarfile.open(dest.encode(osutils._fs_enc), 'w:bz2')
return export_tarball_generator(
tree, ball, root, subdir, force_mtime)
def plain_tar_exporter_generator(tree, dest, root, subdir, compression=None,
force_mtime=None, fileobj=None):
"""Export this tree to a new tar file.
`dest` will be created holding the contents of this tree; if it
already exists, it will be clobbered, like with "tar -c".
"""
if fileobj is not None:
stream = fileobj
elif dest == '-':
stream = sys.stdout
else:
stream = open(dest, 'wb')
ball = tarfile.open(None, 'w|', stream)
return export_tarball_generator(
tree, ball, root, subdir, force_mtime)
def tar_xz_exporter_generator(tree, dest, root, subdir,
force_mtime=None, fileobj=None):
return tar_lzma_exporter_generator(tree, dest, root, subdir,
force_mtime, fileobj, "xz")
def tar_lzma_exporter_generator(tree, dest, root, subdir,
force_mtime=None, fileobj=None,
compression_format="alone"):
"""Export this tree to a new .tar.lzma file.
`dest` will be created holding the contents of this tree; if it
already exists, it will be clobbered, like with "tar -c".
"""
if dest == '-':
raise errors.BzrError("Writing to stdout not supported for .tar.lzma")
if fileobj is not None:
raise errors.BzrError(
"Writing to fileobject not supported for .tar.lzma")
try:
import lzma
except ImportError, e:
raise errors.DependencyNotPresent('lzma', e)
stream = lzma.LZMAFile(dest.encode(osutils._fs_enc), 'w',
options={"format": compression_format})
ball = tarfile.open(None, 'w:', fileobj=stream)
return export_tarball_generator(
tree, ball, root, subdir, force_mtime=force_mtime)
|