/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/archive/tar.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-19 13:16:11 UTC
  • mto: (6968.4.3 git-archive)
  • mto: This revision was merged to the branch mainline in revision 6972.
  • Revision ID: jelmer@jelmer.uk-20180519131611-l9h9ud41j7qg1m03
Move tar/zip to breezy.archive.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/archive/tar.py
 
1
# Copyright (C) 2005, 2006, 2008-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Export a tree to a tarball."""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
import os
 
22
import sys
 
23
import tarfile
 
24
 
 
25
from .. import (
 
26
    errors,
 
27
    osutils,
 
28
    )
 
29
from ..archive import _export_iter_entries
 
30
from ..sixish import (
 
31
    BytesIO,
 
32
    )
 
33
 
 
34
 
 
35
def prepare_tarball_item(tree, root, final_path, tree_path, entry, force_mtime=None):
 
36
    """Prepare a tarball item for exporting
 
37
 
 
38
    :param tree: Tree to export
 
39
    :param final_path: Final path to place item
 
40
    :param tree_path: Path for the entry in the tree
 
41
    :param entry: Entry to export
 
42
    :param force_mtime: Option mtime to force, instead of using tree
 
43
        timestamps.
 
44
 
 
45
    Returns a (tarinfo, fileobj) tuple
 
46
    """
 
47
    filename = osutils.pathjoin(root, final_path).encode('utf8')
 
48
    item = tarfile.TarInfo(filename)
 
49
    if force_mtime is not None:
 
50
        item.mtime = force_mtime
 
51
    else:
 
52
        item.mtime = tree.get_file_mtime(tree_path, entry.file_id)
 
53
    if entry.kind == "file":
 
54
        item.type = tarfile.REGTYPE
 
55
        if tree.is_executable(tree_path, entry.file_id):
 
56
            item.mode = 0o755
 
57
        else:
 
58
            item.mode = 0o644
 
59
        # This brings the whole file into memory, but that's almost needed for
 
60
        # the tarfile contract, which wants the size of the file up front.  We
 
61
        # want to make sure it doesn't change, and we need to read it in one
 
62
        # go for content filtering.
 
63
        content = tree.get_file_text(tree_path, entry.file_id)
 
64
        item.size = len(content)
 
65
        fileobj = BytesIO(content)
 
66
    elif entry.kind in ("directory", "tree-reference"):
 
67
        item.type = tarfile.DIRTYPE
 
68
        item.name += '/'
 
69
        item.size = 0
 
70
        item.mode = 0o755
 
71
        fileobj = None
 
72
    elif entry.kind == "symlink":
 
73
        item.type = tarfile.SYMTYPE
 
74
        item.size = 0
 
75
        item.mode = 0o755
 
76
        item.linkname = tree.get_symlink_target(tree_path, entry.file_id)
 
77
        fileobj = None
 
78
    else:
 
79
        raise errors.BzrError("don't know how to export {%s} of kind %r"
 
80
                              % (entry.file_id, entry.kind))
 
81
    return (item, fileobj)
 
82
 
 
83
 
 
84
def export_tarball_generator(tree, ball, root, subdir=None, force_mtime=None):
 
85
    """Export tree contents to a tarball.
 
86
 
 
87
    :returns: A generator that will repeatedly produce None as each file is
 
88
        emitted.  The entire generator must be consumed to complete writing
 
89
        the file.
 
90
 
 
91
    :param tree: Tree to export
 
92
 
 
93
    :param ball: Tarball to export to; it will be closed when writing is
 
94
        complete.
 
95
 
 
96
    :param subdir: Sub directory to export
 
97
 
 
98
    :param force_mtime: Option mtime to force, instead of using tree
 
99
        timestamps.
 
100
    """
 
101
    try:
 
102
        for final_path, tree_path, entry in _export_iter_entries(tree, subdir):
 
103
            (item, fileobj) = prepare_tarball_item(
 
104
                tree, root, final_path, tree_path, entry, force_mtime)
 
105
            ball.addfile(item, fileobj)
 
106
            yield
 
107
    finally:
 
108
        ball.close()
 
109
 
 
110
 
 
111
def tgz_archive_generator(tree, dest, root, subdir, force_mtime=None,
 
112
    fileobj=None):
 
113
    """Export this tree to a new tar file.
 
114
 
 
115
    `dest` will be created holding the contents of this tree; if it
 
116
    already exists, it will be clobbered, like with "tar -c".
 
117
    """
 
118
    import gzip
 
119
    if force_mtime is not None:
 
120
        root_mtime = force_mtime
 
121
    elif (getattr(tree, "repository", None) and
 
122
          getattr(tree, "get_revision_id", None)):
 
123
        # If this is a revision tree, use the revisions' timestamp
 
124
        rev = tree.repository.get_revision(tree.get_revision_id())
 
125
        root_mtime = rev.timestamp
 
126
    elif tree.get_root_id() is not None:
 
127
        root_mtime = tree.get_file_mtime('', tree.get_root_id())
 
128
    else:
 
129
        root_mtime = None
 
130
 
 
131
    is_stdout = False
 
132
    basename = None
 
133
    if fileobj is not None:
 
134
        stream = fileobj
 
135
    elif dest == '-':
 
136
        stream = sys.stdout
 
137
        is_stdout = True
 
138
    else:
 
139
        stream = open(dest, 'wb')
 
140
    # gzip file is used with an explicit fileobj so that
 
141
    # the basename can be stored in the gzip file rather than
 
142
    # dest. (bug 102234)
 
143
    basename = os.path.basename(dest)
 
144
    zipstream = gzip.GzipFile(basename, 'w', fileobj=stream,
 
145
                              mtime=root_mtime)
 
146
    ball = tarfile.open(None, 'w|', fileobj=zipstream)
 
147
    for _ in export_tarball_generator(
 
148
        tree, ball, root, subdir, force_mtime):
 
149
        yield
 
150
    # Closing zipstream may trigger writes to stream
 
151
    zipstream.close()
 
152
    if not is_stdout:
 
153
        # Now we can safely close the stream
 
154
        stream.close()
 
155
 
 
156
 
 
157
def tbz_archive_generator(tree, dest, root, subdir,
 
158
                           force_mtime=None, fileobj=None):
 
159
    """Export this tree to a new tar file.
 
160
 
 
161
    `dest` will be created holding the contents of this tree; if it
 
162
    already exists, it will be clobbered, like with "tar -c".
 
163
    """
 
164
    if fileobj is not None:
 
165
        ball = tarfile.open(None, 'w|bz2', fileobj)
 
166
    elif dest == '-':
 
167
        ball = tarfile.open(None, 'w|bz2', sys.stdout)
 
168
    else:
 
169
        ball = tarfile.open(dest, 'w:bz2')
 
170
    return export_tarball_generator(
 
171
        tree, ball, root, subdir, force_mtime)
 
172
 
 
173
 
 
174
def plain_tar_archive_generator(tree, dest, root, subdir, compression=None,
 
175
    force_mtime=None, fileobj=None):
 
176
    """Export this tree to a new tar file.
 
177
 
 
178
    `dest` will be created holding the contents of this tree; if it
 
179
    already exists, it will be clobbered, like with "tar -c".
 
180
    """
 
181
    if fileobj is not None:
 
182
        stream = fileobj
 
183
    elif dest == '-':
 
184
        stream = sys.stdout
 
185
    else:
 
186
        stream = open(dest, 'wb')
 
187
    ball = tarfile.open(None, 'w|', stream)
 
188
    return export_tarball_generator(
 
189
        tree, ball, root, subdir, force_mtime)
 
190
 
 
191
 
 
192
def tar_xz_archive_generator(tree, dest, root, subdir,
 
193
                              force_mtime=None, fileobj=None):
 
194
    return tar_lzma_archive_generator(tree, dest, root, subdir,
 
195
                                       force_mtime, fileobj, "xz")
 
196
 
 
197
 
 
198
def tar_lzma_archive_generator(tree, dest, root, subdir,
 
199
                      force_mtime=None, fileobj=None,
 
200
                                compression_format="alone"):
 
201
    """Export this tree to a new .tar.lzma file.
 
202
 
 
203
    `dest` will be created holding the contents of this tree; if it
 
204
    already exists, it will be clobbered, like with "tar -c".
 
205
    """
 
206
    if dest == '-':
 
207
        raise errors.BzrError("Writing to stdout not supported for .tar.lzma")
 
208
 
 
209
    if fileobj is not None:
 
210
        raise errors.BzrError(
 
211
            "Writing to fileobject not supported for .tar.lzma")
 
212
    try:
 
213
        import lzma
 
214
    except ImportError as e:
 
215
        raise errors.DependencyNotPresent('lzma', e)
 
216
 
 
217
    stream = lzma.LZMAFile(dest.encode(osutils._fs_enc), 'w',
 
218
        options={"format": compression_format})
 
219
    ball = tarfile.open(None, 'w:', fileobj=stream)
 
220
    return export_tarball_generator(
 
221
        tree, ball, root, subdir, force_mtime=force_mtime)