~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
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
22
import time
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
23
import zipfile
24
2024.2.8 by John Arbash Meinel
paths are always forward slashed for python zipfiles
25
from bzrlib import (
26
    osutils,
27
    )
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
28
from bzrlib.export import _export_iter_entries
3368.2.32 by Ian Clatworthy
add --filters to export command
29
from bzrlib.filters import (
30
    ContentFilterContext,
31
    filtered_output_bytes,
32
    )
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
33
from bzrlib.trace import mutter
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
34
35
36
# Windows expects this bit to be set in the 'external_attr' section
37
# Or it won't consider the entry a directory
38
ZIP_DIRECTORY_BIT = (1 << 4)
4823.1.2 by Ivan Sagalaev
File mode is given a name and gets tested
39
FILE_PERMISSIONS = (0644 << 16)
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
40
4823.1.2 by Ivan Sagalaev
File mode is given a name and gets tested
41
_FILE_ATTR = stat.S_IFREG | FILE_PERMISSIONS
2024.2.8 by John Arbash Meinel
paths are always forward slashed for python zipfiles
42
_DIR_ATTR = stat.S_IFDIR | ZIP_DIRECTORY_BIT
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
43
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
44
3368.2.41 by Ian Clatworthy
1st cut merge of bzr.dev r3907
45
def zip_exporter(tree, dest, root, subdir, filtered=False):
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
46
    """ Export this tree to a new zip file.
47
48
    `dest` will be created holding the contents of this tree; if it
49
    already exists, it will be overwritten".
50
    """
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
51
    mutter('export version %r', tree)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
52
53
    now = time.localtime()[:6]
54
55
    compression = zipfile.ZIP_DEFLATED
56
    zipf = zipfile.ZipFile(dest, "w", compression)
57
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.
65
            filename = osutils.pathjoin(root, dp).encode('utf8')
2024.2.6 by John Arbash Meinel
In zip files, directories must have trailing slashes
66
            if ie.kind == "file":
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
67
                zinfo = zipfile.ZipInfo(
2024.2.1 by John Arbash Meinel
Fix bug #56815 by exporting paths in utf8 to tarfile and zipfile
68
                            filename=filename,
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
69
                            date_time=now)
70
                zinfo.compress_type = compression
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
71
                zinfo.external_attr = _FILE_ATTR
3368.2.32 by Ian Clatworthy
add --filters to export command
72
                if filtered:
73
                    chunks = tree.get_file_lines(file_id)
74
                    filters = tree._content_filter_stack(dp)
3368.2.33 by Ian Clatworthy
expand filter context to support interesting stuff
75
                    context = ContentFilterContext(dp, tree, ie)
3368.2.32 by Ian Clatworthy
add --filters to export command
76
                    contents = filtered_output_bytes(chunks, filters, context)
77
                    content = ''.join(contents)
78
                else:
79
                    content = tree.get_file_text(file_id)
80
                zipf.writestr(zinfo, content)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
81
            elif ie.kind == "directory":
2024.2.6 by John Arbash Meinel
In zip files, directories must have trailing slashes
82
                # Directories must contain a trailing slash, to indicate
83
                # to the zip routine that they are really directories and
84
                # not just empty files.
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
85
                zinfo = zipfile.ZipInfo(
2024.2.8 by John Arbash Meinel
paths are always forward slashed for python zipfiles
86
                            filename=filename + '/',
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
87
                            date_time=now)
88
                zinfo.compress_type = compression
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
89
                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.
90
                zipf.writestr(zinfo,'')
91
            elif ie.kind == "symlink":
92
                zinfo = zipfile.ZipInfo(
2024.2.1 by John Arbash Meinel
Fix bug #56815 by exporting paths in utf8 to tarfile and zipfile
93
                            filename=(filename + '.lnk'),
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
94
                            date_time=now)
95
                zinfo.compress_type = compression
2024.2.7 by John Arbash Meinel
Set the external_attr bits so Windows respects our directories
96
                zinfo.external_attr = _FILE_ATTR
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
97
                zipf.writestr(zinfo, ie.symlink_target)
98
99
        zipf.close()
100
101
    except UnicodeEncodeError:
102
        zipf.close()
103
        os.remove(dest)
104
        from bzrlib.errors import BzrError
105
        raise BzrError("Can't export non-ascii filenames to zip")