1
# Copyright (C) 2005, 2006 Canonical Ltd
 
 
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.
 
 
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.
 
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""Helper functions for adding files to working trees."""
 
 
24
import bzrlib.errors as errors
 
 
26
from bzrlib.symbol_versioning import *
 
 
27
from bzrlib.workingtree import WorkingTree
 
 
30
class AddAction(object):
 
 
31
    """A class which defines what action to take when adding a file."""
 
 
33
    def __init__(self, to_file=None, should_print=None):
 
 
34
        """Initialize an action which prints added files to an output stream.
 
 
36
        :param to_file: The stream to write into. This is expected to take
 
 
37
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
 
 
38
        :param should_print: If False, printing will be supressed.
 
 
40
        self._to_file = to_file
 
 
42
            self._to_file = sys.stdout
 
 
43
        self.should_print = False
 
 
44
        if should_print is not None:
 
 
45
            self.should_print = should_print
 
 
47
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
 
 
48
        """Add path to inventory.
 
 
50
        The default action does nothing.
 
 
52
        :param inv: The inventory we are working with.
 
 
53
        :param path: The FastPath being added
 
 
54
        :param kind: The kind of the object being added.
 
 
57
            self._to_file.write('added %s\n' % _quote(path.raw_path))
 
 
61
class AddFromBaseAction(AddAction):
 
 
62
    """This class will try to extract file ids from another tree."""
 
 
64
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
 
 
65
        super(AddFromBaseAction, self).__init__(to_file=to_file,
 
 
66
                                                should_print=should_print)
 
 
67
        self.base_tree = base_tree
 
 
68
        self.base_path = base_path
 
 
70
    def __call__(self, inv, parent_ie, path, kind):
 
 
71
        # Place the parent call
 
 
72
        # Now check to see if we can extract an id for this file
 
 
73
        file_id, base_path = self._get_base_file_id(path, parent_ie)
 
 
74
        if file_id is not None:
 
 
76
                self._to_file.write('added %s w/ file id from %s\n'
 
 
77
                                    % (path.raw_path, base_path))
 
 
79
            # we aren't doing anything special, so let the default
 
 
81
            file_id = super(AddFromBaseAction, self).__call__(
 
 
82
                        inv, parent_ie, path, kind)
 
 
85
    def _get_base_file_id(self, path, parent_ie):
 
 
86
        """Look for a file id in the base branch.
 
 
88
        First, if the base tree has the parent directory,
 
 
89
        we look for a file with the same name in that directory.
 
 
90
        Else, we look for an entry in the base tree with the same path.
 
 
93
        if (parent_ie.file_id in self.base_tree):
 
 
94
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
 
 
95
            base_child_ie = base_parent_ie.children.get(path.base_path)
 
 
96
            if base_child_ie is not None:
 
 
97
                return (base_child_ie.file_id,
 
 
98
                        self.base_tree.id2path(base_child_ie.file_id))
 
 
99
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
 
 
100
        # This may return None, but it is our last attempt
 
 
101
        return self.base_tree.path2id(full_base_path), full_base_path
 
 
104
# TODO: jam 20050105 These could be used for compatibility
 
 
105
#       however, they bind against the current stdout, not the
 
 
106
#       one which exists at the time they are called, so they
 
 
107
#       don't work for the test suite.
 
 
109
add_action_add = AddAction()
 
 
110
add_action_null = add_action_add
 
 
111
add_action_add_and_print = AddAction(should_print=True)
 
 
112
add_action_print = add_action_add_and_print