~bzr-pqm/bzr/bzr.dev

5967.6.2 by Martin Pool
Delete fairly useless and repetitive per-format export single-call functions.
1
# Copyright (C) 2005-2011 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
4996.1.1 by Robert Collins
Set the file mtime when exporting to a directory to prevent triggering make rebuilds unnecessarily.
17
"""Export a bzrlib.tree.Tree to a new or empty directory."""
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
18
4576.1.1 by Alexander Belchenko
Fixed export to existing empty directory.
19
import errno
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
20
import os
3368.2.32 by Ian Clatworthy
add --filters to export command
21
22
from bzrlib import errors, osutils
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
23
from bzrlib.export import _export_iter_entries
6006.3.7 by Martin Pool
Remove duplicated content-filtering code from exporters
24
25
26
def dir_exporter_generator(tree, dest, root, subdir=None,
5952.1.20 by geoffreyfishing at gmail
Fixed compatibility issues with directory exporter.
27
                           force_mtime=None, fileobj=None):
5952.1.15 by geoffreyfishing at gmail
Major code cleanup.
28
    """Return a generator that exports this tree to a new directory.
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
29
4996.1.1 by Robert Collins
Set the file mtime when exporting to a directory to prevent triggering make rebuilds unnecessarily.
30
    `dest` should either not exist or should be empty. If it does not exist it
31
    will be created holding the contents of this tree.
5967.6.2 by Martin Pool
Delete fairly useless and repetitive per-format export single-call functions.
32
5952.1.9 by geoffreyfishing at gmail
Updated directory exporter.
33
    :param fileobj: Is not used in this exporter
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
34
35
    :note: If the export fails, the destination directory will be
4996.1.1 by Robert Collins
Set the file mtime when exporting to a directory to prevent triggering make rebuilds unnecessarily.
36
           left in an incompletely exported state: export is not transactional.
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
37
    """
4576.1.1 by Alexander Belchenko
Fixed export to existing empty directory.
38
    try:
39
        os.mkdir(dest)
40
    except OSError, e:
41
        if e.errno == errno.EEXIST:
42
            # check if directory empty
43
            if os.listdir(dest) != []:
5952.2.1 by Vincent Ladeuil
PEP8 tweaks, lines too long, spaces at end of lines.
44
                raise errors.BzrError(
45
                    "Can't export tree to non-empty directory.")
4576.1.1 by Alexander Belchenko
Fixed export to existing empty directory.
46
        else:
47
            raise
4634.111.1 by John Arbash Meinel
First cut at a possible fix for bug #343218
48
    # Iterate everything, building up the files we will want to export, and
49
    # creating the directories and symlinks that we need.
50
    # This tracks (file_id, (destination_path, executable))
51
    # This matches the api that tree.iter_files_bytes() wants
52
    # Note in the case of revision trees, this does trigger a double inventory
53
    # lookup, hopefully it isn't too expensive.
54
    to_fetch = []
3613.2.2 by Robert Collins
Refactor exporters to remove obvious duplication to a helper function.
55
    for dp, ie in _export_iter_entries(tree, subdir):
3368.2.32 by Ian Clatworthy
add --filters to export command
56
        fullpath = osutils.pathjoin(dest, dp)
57
        if ie.kind == "file":
4634.111.1 by John Arbash Meinel
First cut at a possible fix for bug #343218
58
            to_fetch.append((ie.file_id, (dp, tree.is_executable(ie.file_id))))
3368.2.32 by Ian Clatworthy
add --filters to export command
59
        elif ie.kind == "directory":
60
            os.mkdir(fullpath)
61
        elif ie.kind == "symlink":
62
            try:
4562.1.1 by Jelmer Vernooij
Support exporting symlinks when exporting from a working tree.
63
                symlink_target = tree.get_symlink_target(ie.file_id)
64
                os.symlink(symlink_target, fullpath)
5967.6.2 by Martin Pool
Delete fairly useless and repetitive per-format export single-call functions.
65
            except OSError, e:
3368.2.32 by Ian Clatworthy
add --filters to export command
66
                raise errors.BzrError(
67
                    "Failed to create symlink %r -> %r, error: %s"
4562.1.1 by Jelmer Vernooij
Support exporting symlinks when exporting from a working tree.
68
                    % (fullpath, symlink_target, e))
3368.2.32 by Ian Clatworthy
add --filters to export command
69
        else:
70
            raise errors.BzrError("don't know how to export {%s} of kind %r" %
71
               (ie.file_id, ie.kind))
5952.1.15 by geoffreyfishing at gmail
Major code cleanup.
72
5952.1.9 by geoffreyfishing at gmail
Updated directory exporter.
73
        yield
4634.111.1 by John Arbash Meinel
First cut at a possible fix for bug #343218
74
    # The data returned here can be in any order, but we've already created all
75
    # the directories
4634.111.5 by John Arbash Meinel
Change to using os.open() allowing the users umask to handle perms.
76
    flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | getattr(os, 'O_BINARY', 0)
4634.111.1 by John Arbash Meinel
First cut at a possible fix for bug #343218
77
    for (relpath, executable), chunks in tree.iter_files_bytes(to_fetch):
78
        fullpath = osutils.pathjoin(dest, relpath)
4634.111.5 by John Arbash Meinel
Change to using os.open() allowing the users umask to handle perms.
79
        # We set the mode and let the umask sort out the file info
80
        mode = 0666
81
        if executable:
82
            mode = 0777
4634.111.6 by John Arbash Meinel
Of course, it helps if you tell the buffered file that it is writable.
83
        out = os.fdopen(os.open(fullpath, flags, mode), 'wb')
4634.111.1 by John Arbash Meinel
First cut at a possible fix for bug #343218
84
        try:
85
            out.writelines(chunks)
86
        finally:
87
            out.close()
5718.5.1 by Jelmer Vernooij
per_file_timestamp -> force_mtime.
88
        if force_mtime is not None:
89
            mtime = force_mtime
90
        else:
5966.1.1 by Szilveszter Farkas
Fixed exporting subdirectories with per file timestamps.
91
            if subdir is None:
92
                file_id = tree.path2id(relpath)
93
            else:
94
                file_id = tree.path2id(osutils.pathjoin(subdir, relpath))
95
            mtime = tree.get_file_mtime(file_id, relpath)
5076.2.1 by Jelmer Vernooij
Add use_tree_timestamp argument to exporters.
96
        os.utime(fullpath, (mtime, mtime))
5952.1.15 by geoffreyfishing at gmail
Major code cleanup.
97
5952.1.9 by geoffreyfishing at gmail
Updated directory exporter.
98
        yield