/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: 2020-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

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
from contextlib import closing
 
22
from io import BytesIO
 
23
import os
 
24
import sys
 
25
import tarfile
 
26
 
 
27
from .. import (
 
28
    errors,
 
29
    osutils,
 
30
    )
 
31
from ..export import _export_iter_entries
 
32
 
 
33
 
 
34
def prepare_tarball_item(tree, root, final_path, tree_path, entry, force_mtime=None):
 
35
    """Prepare a tarball item for exporting
 
36
 
 
37
    :param tree: Tree to export
 
38
    :param final_path: Final path to place item
 
39
    :param tree_path: Path for the entry in the tree
 
40
    :param entry: Entry to export
 
41
    :param force_mtime: Option mtime to force, instead of using tree
 
42
        timestamps.
 
43
 
 
44
    Returns a (tarinfo, fileobj) tuple
 
45
    """
 
46
    file_id = getattr(entry, 'file_id', None)
 
47
    filename = osutils.pathjoin(root, final_path)
 
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)
 
53
    if entry.kind == "file":
 
54
        item.type = tarfile.REGTYPE
 
55
        if tree.is_executable(tree_path):
 
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)
 
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)
 
77
        fileobj = None
 
78
    else:
 
79
        raise errors.BzrError("don't know how to export {%s} of kind %r"
 
80
                              % (file_id, entry.kind))
 
81
    return (item, fileobj)
 
82
 
 
83
 
 
84
def tarball_generator(tree, root, subdir=None, force_mtime=None, format=''):
 
85
    """Export tree contents to a tarball.
 
86
 
 
87
    :returns: A generator that will produce file content chunks.
 
88
 
 
89
    :param tree: Tree to export
 
90
 
 
91
    :param subdir: Sub directory to export
 
92
 
 
93
    :param force_mtime: Option mtime to force, instead of using tree
 
94
        timestamps.
 
95
    """
 
96
    buf = BytesIO()
 
97
    with closing(tarfile.open(None, "w:%s" % format, buf)) as ball, tree.lock_read():
 
98
        for final_path, tree_path, entry in _export_iter_entries(tree, subdir):
 
99
            (item, fileobj) = prepare_tarball_item(
 
100
                tree, root, final_path, tree_path, entry, force_mtime)
 
101
            ball.addfile(item, fileobj)
 
102
            # Yield the data that was written so far, rinse, repeat.
 
103
            yield buf.getvalue()
 
104
            buf.truncate(0)
 
105
            buf.seek(0)
 
106
    yield buf.getvalue()
 
107
 
 
108
 
 
109
def tgz_generator(tree, dest, root, subdir, force_mtime=None):
 
110
    """Export this tree to a new tar file.
 
111
 
 
112
    `dest` will be created holding the contents of this tree; if it
 
113
    already exists, it will be clobbered, like with "tar -c".
 
114
    """
 
115
    with tree.lock_read():
 
116
        import gzip
 
117
        if force_mtime is not None:
 
118
            root_mtime = force_mtime
 
119
        elif (getattr(tree, "repository", None) and
 
120
              getattr(tree, "get_revision_id", None)):
 
121
            # If this is a revision tree, use the revisions' timestamp
 
122
            rev = tree.repository.get_revision(tree.get_revision_id())
 
123
            root_mtime = rev.timestamp
 
124
        elif tree.is_versioned(u''):
 
125
            root_mtime = tree.get_file_mtime('')
 
126
        else:
 
127
            root_mtime = None
 
128
 
 
129
        is_stdout = False
 
130
        basename = None
 
131
        # gzip file is used with an explicit fileobj so that
 
132
        # the basename can be stored in the gzip file rather than
 
133
        # dest. (bug 102234)
 
134
        basename = os.path.basename(dest)
 
135
        buf = BytesIO()
 
136
        zipstream = gzip.GzipFile(basename, 'w', fileobj=buf,
 
137
                                  mtime=root_mtime)
 
138
        for chunk in tarball_generator(tree, root, subdir, force_mtime):
 
139
            zipstream.write(chunk)
 
140
            # Yield the data that was written so far, rinse, repeat.
 
141
            yield buf.getvalue()
 
142
            buf.truncate(0)
 
143
            buf.seek(0)
 
144
        # Closing zipstream may trigger writes to stream
 
145
        zipstream.close()
 
146
        yield buf.getvalue()
 
147
 
 
148
 
 
149
def tbz_generator(tree, dest, root, subdir, force_mtime=None):
 
150
    """Export this tree to a new tar file.
 
151
 
 
152
    `dest` will be created holding the contents of this tree; if it
 
153
    already exists, it will be clobbered, like with "tar -c".
 
154
    """
 
155
    return tarball_generator(
 
156
        tree, root, subdir, force_mtime, format='bz2')
 
157
 
 
158
 
 
159
def plain_tar_generator(tree, dest, root, subdir,
 
160
                        force_mtime=None):
 
161
    """Export this tree to a new tar file.
 
162
 
 
163
    `dest` will be created holding the contents of this tree; if it
 
164
    already exists, it will be clobbered, like with "tar -c".
 
165
    """
 
166
    return tarball_generator(
 
167
        tree, root, subdir, force_mtime, format='')
 
168
 
 
169
 
 
170
def tar_xz_generator(tree, dest, root, subdir, force_mtime=None):
 
171
    return tar_lzma_generator(tree, dest, root, subdir, force_mtime, "xz")
 
172
 
 
173
 
 
174
def tar_lzma_generator(tree, dest, root, subdir, force_mtime=None,
 
175
                       compression_format="alone"):
 
176
    """Export this tree to a new .tar.lzma 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
    try:
 
182
        import lzma
 
183
    except ImportError as e:
 
184
        raise errors.DependencyNotPresent('lzma', e)
 
185
 
 
186
    compressor = lzma.LZMACompressor(
 
187
        format={
 
188
            'xz': lzma.FORMAT_XZ,
 
189
            'raw': lzma.FORMAT_RAW,
 
190
            'alone': lzma.FORMAT_ALONE,
 
191
            }[compression_format])
 
192
 
 
193
    for chunk in tarball_generator(
 
194
            tree, root, subdir, force_mtime=force_mtime):
 
195
        yield compressor.compress(chunk)
 
196
 
 
197
    yield compressor.flush()