~bzr-pqm/bzr/bzr.dev

4763.2.4 by John Arbash Meinel
merge bzr.2.1 in preparation for NEWS entry.
1
# Copyright (C) 2005, 2006, 2008, 2009, 2010 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
16
17
"""Export a Tree to a non-versioned directory.
18
"""
19
20
import os
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
21
import stat
5718.5.7 by Jelmer Vernooij
Support bzr zip exporting to stdout.
22
import sys
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
23
import time
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
24
import zipfile
25
2024.2.8 by John Arbash Meinel
paths are always forward slashed for python zipfiles
26
from bzrlib import (
27
    osutils,
28
    )
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
29
from bzrlib.export import _export_iter_entries
3368.2.32 by Ian Clatworthy
add --filters to export command
30
from bzrlib.filters import (
31
    ContentFilterContext,
32
    filtered_output_bytes,
33
    )
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
34
from bzrlib.trace import mutter
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
35
36
37
# Windows expects this bit to be set in the 'external_attr' section
38
# Or it won't consider the entry a directory
39
ZIP_DIRECTORY_BIT = (1 << 4)
4823.1.2 by Ivan Sagalaev
File mode is given a name and gets tested
40
FILE_PERMISSIONS = (0644 << 16)
5664.2.1 by Jelmer Vernooij
Fix setting of mode on directories in zip files.
41
DIR_PERMISSIONS = (0755 << 16)
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
42
4823.1.2 by Ivan Sagalaev
File mode is given a name and gets tested
43
_FILE_ATTR = stat.S_IFREG | FILE_PERMISSIONS
5664.2.1 by Jelmer Vernooij
Fix setting of mode on directories in zip files.
44
_DIR_ATTR = stat.S_IFDIR | ZIP_DIRECTORY_BIT | DIR_PERMISSIONS
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
45
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
46
5718.5.14 by Jelmer Vernooij
Add test for per-file-timestamp zipfiles.
47
def zip_exporter(tree, dest, root, subdir=None, filtered=False, force_mtime=None):
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
48
    """ Export this tree to a new zip file.
49
50
    `dest` will be created holding the contents of this tree; if it
51
    already exists, it will be overwritten".
52
    """
53
54
    compression = zipfile.ZIP_DEFLATED
5718.5.7 by Jelmer Vernooij
Support bzr zip exporting to stdout.
55
    if dest == "-":
56
        dest = sys.stdout
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
57
    zipf = zipfile.ZipFile(dest, "w", compression)
58
    try:
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
59
        for dp, ie in _export_iter_entries(tree, subdir):
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
60
            file_id = ie.file_id
61
            mutter("  export {%s} kind %s to %s", file_id, ie.kind, dest)
62
2024.2.8 by John Arbash Meinel
paths are always forward slashed for python zipfiles
63
            # zipfile.ZipFile switches all paths to forward
64
            # slashes anyway, so just stick with that.
5718.5.1 by Jelmer Vernooij
per_file_timestamp -> force_mtime.
65
            if force_mtime is not None:
66
                mtime = force_mtime
67
            else:
5076.2.1 by Jelmer Vernooij
Add use_tree_timestamp argument to exporters.
68
                mtime = tree.get_file_mtime(ie.file_id, dp)
5718.5.1 by Jelmer Vernooij
per_file_timestamp -> force_mtime.
69
            date_time = time.localtime(mtime)[:6]
2024.2.8 by John Arbash Meinel
paths are always forward slashed for python zipfiles
70
            filename = osutils.pathjoin(root, dp).encode('utf8')
2024.2.6 by John Arbash Meinel
In zip files, directories must have trailing slashes
71
            if ie.kind == "file":
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
72
                zinfo = zipfile.ZipInfo(
2024.2.1 by John Arbash Meinel
Fix bug #56815 by exporting paths in utf8 to tarfile and zipfile
73
                            filename=filename,
5718.5.1 by Jelmer Vernooij
per_file_timestamp -> force_mtime.
74
                            date_time=date_time)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
75
                zinfo.compress_type = compression
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
76
                zinfo.external_attr = _FILE_ATTR
3368.2.32 by Ian Clatworthy
add --filters to export command
77
                if filtered:
78
                    chunks = tree.get_file_lines(file_id)
79
                    filters = tree._content_filter_stack(dp)
3368.2.33 by Ian Clatworthy
expand filter context to support interesting stuff
80
                    context = ContentFilterContext(dp, tree, ie)
3368.2.32 by Ian Clatworthy
add --filters to export command
81
                    contents = filtered_output_bytes(chunks, filters, context)
82
                    content = ''.join(contents)
83
                else:
84
                    content = tree.get_file_text(file_id)
85
                zipf.writestr(zinfo, content)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
86
            elif ie.kind == "directory":
2024.2.6 by John Arbash Meinel
In zip files, directories must have trailing slashes
87
                # Directories must contain a trailing slash, to indicate
88
                # to the zip routine that they are really directories and
89
                # not just empty files.
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
90
                zinfo = zipfile.ZipInfo(
2024.2.8 by John Arbash Meinel
paths are always forward slashed for python zipfiles
91
                            filename=filename + '/',
5718.5.1 by Jelmer Vernooij
per_file_timestamp -> force_mtime.
92
                            date_time=date_time)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
93
                zinfo.compress_type = compression
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
94
                zinfo.external_attr = _DIR_ATTR
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
95
                zipf.writestr(zinfo,'')
96
            elif ie.kind == "symlink":
97
                zinfo = zipfile.ZipInfo(
2024.2.1 by John Arbash Meinel
Fix bug #56815 by exporting paths in utf8 to tarfile and zipfile
98
                            filename=(filename + '.lnk'),
5718.5.1 by Jelmer Vernooij
per_file_timestamp -> force_mtime.
99
                            date_time=date_time)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
100
                zinfo.compress_type = compression
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
101
                zinfo.external_attr = _FILE_ATTR
5809.3.8 by Aaron Bentley
Test zip files with all tree types.
102
                zipf.writestr(zinfo, tree.get_symlink_target(file_id))
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
103
104
        zipf.close()
105
106
    except UnicodeEncodeError:
107
        zipf.close()
108
        os.remove(dest)
109
        from bzrlib.errors import BzrError
110
        raise BzrError("Can't export non-ascii filenames to zip")