~bzr-pqm/bzr/bzr.dev

5273.1.8 by Vincent Ladeuil
Merge bzr.dev into cleanup
1
# Copyright (C) 2005-2010 Canonical Ltd
1685.1.80 by Wouter van Heyst
more code cleanup
2
#
70 by mbp at sourcefrog
Prepare for smart recursive add.
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.
1685.1.80 by Wouter van Heyst
more code cleanup
7
#
70 by mbp at sourcefrog
Prepare for smart recursive add.
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.
1685.1.80 by Wouter van Heyst
more code cleanup
12
#
70 by mbp at sourcefrog
Prepare for smart recursive add.
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
70 by mbp at sourcefrog
Prepare for smart recursive add.
16
6379.6.1 by Jelmer Vernooij
Import absolute_import in a few places.
17
from __future__ import absolute_import
18
2399.1.5 by John Arbash Meinel
Clean up add.py documentation.
19
"""Helper functions for adding files to working trees."""
20
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
21
import sys
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
22
import os
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
23
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
24
from bzrlib import (
25
    osutils,
6046.2.8 by Shannon Weyrick
Minor cleanup
26
    ui, 
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
27
    )
6138.3.13 by Jonathan Riddell
add missing import
28
from bzrlib.i18n import gettext
1685.1.80 by Wouter van Heyst
more code cleanup
29
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
30
class AddAction(object):
31
    """A class which defines what action to take when adding a file."""
32
1757.2.6 by Robert Collins
Steps towards a nicer smart add - unwind the conditional add logic - having parents not in the inventory was overly complicating the rest of the code.
33
    def __init__(self, to_file=None, should_print=None):
2399.1.5 by John Arbash Meinel
Clean up add.py documentation.
34
        """Initialize an action which prints added files to an output stream.
35
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``.
4031.3.1 by Frank Aspell
Fixing various typos
38
        :param should_print: If False, printing will be suppressed.
2399.1.5 by John Arbash Meinel
Clean up add.py documentation.
39
        """
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
40
        self._to_file = to_file
41
        if to_file is None:
42
            self._to_file = sys.stdout
1685.1.69 by Wouter van Heyst
merge bzr.dev 1740
43
        self.should_print = False
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
44
        if should_print is not None:
45
            self.should_print = should_print
46
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
47
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
48
        """Add path to inventory.
49
50
        The default action does nothing.
51
52
        :param inv: The inventory we are working with.
1757.2.2 by Robert Collins
Merge basename call eliminate for smart_add.
53
        :param path: The FastPath being added
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
54
        :param kind: The kind of the object being added.
55
        """
1911.3.1 by John Arbash Meinel
Updated smart_add so that the AddAction can return a custom id.
56
        if self.should_print:
5870.1.36 by Jelmer Vernooij
kill _FastPath.
57
            self._to_file.write('adding %s\n' % _quote(path))
1911.3.1 by John Arbash Meinel
Updated smart_add so that the AddAction can return a custom id.
58
        return None
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
59
6046.2.8 by Shannon Weyrick
Minor cleanup
60
    def skip_file(self, tree, path, kind, stat_value = None):
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
61
        """Test whether the given file should be skipped or not.
62
        
6046.2.9 by Shannon Weyrick
Make it explicit in docs that large file skips happen only in recursive mode. Add test.
63
        The default action never skips. Note this is only called during
64
        recursive adds
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
65
        
66
        :param tree: The tree we are working in
67
        :param path: The path being added
68
        :param kind: The kind of object being added.
6046.2.7 by Shannon Weyrick
Switch add to use file_stat, and reuse stat result in AddAction
69
        :param stat: Stat result for this file, if available already
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
70
        :return bool. True if the file should be skipped (not added)
71
        """
72
        return False
73
6046.2.9 by Shannon Weyrick
Make it explicit in docs that large file skips happen only in recursive mode. Add test.
74
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
75
class AddWithSkipLargeAction(AddAction):
76
    """A class that can decide to skip a file if it's considered too large"""
77
78
    # default 20 MB
79
    _DEFAULT_MAX_FILE_SIZE = 20000000
80
    _optionName = 'add.maximum_file_size'
81
    _maxSize = None
82
6046.2.8 by Shannon Weyrick
Minor cleanup
83
    def skip_file(self, tree, path, kind, stat_value = None):
84
        if kind != 'file':
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
85
            return False            
86
        if self._maxSize is None:
87
            config = tree.branch.get_config()
88
            self._maxSize = config.get_user_option_as_int_from_SI(
89
                self._optionName,  
90
                self._DEFAULT_MAX_FILE_SIZE)
6046.2.8 by Shannon Weyrick
Minor cleanup
91
        if stat_value is None:
6046.2.7 by Shannon Weyrick
Switch add to use file_stat, and reuse stat result in AddAction
92
            file_size = os.path.getsize(path);
93
        else:
94
            file_size = stat_value.st_size;
6046.2.8 by Shannon Weyrick
Minor cleanup
95
        if self._maxSize > 0 and file_size > self._maxSize:
6138.3.10 by Jonathan Riddell
gettext() show_warning usage
96
            ui.ui_factory.show_warning(gettext(
97
                "skipping {0} (larger than {1} of {2} bytes)").format(
98
                path, self._optionName,  self._maxSize))
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
99
            return True
100
        return False
101
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
102
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
103
class AddFromBaseAction(AddAction):
104
    """This class will try to extract file ids from another tree."""
105
106
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
107
        super(AddFromBaseAction, self).__init__(to_file=to_file,
108
                                                should_print=should_print)
109
        self.base_tree = base_tree
110
        self.base_path = base_path
111
112
    def __call__(self, inv, parent_ie, path, kind):
113
        # Place the parent call
114
        # Now check to see if we can extract an id for this file
115
        file_id, base_path = self._get_base_file_id(path, parent_ie)
116
        if file_id is not None:
117
            if self.should_print:
3985.2.3 by Daniel Watkins
Changed output of add to not suggest partial success.
118
                self._to_file.write('adding %s w/ file id from %s\n'
5870.1.36 by Jelmer Vernooij
kill _FastPath.
119
                                    % (path, base_path))
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
120
        else:
121
            # we aren't doing anything special, so let the default
122
            # reporter happen
123
            file_id = super(AddFromBaseAction, self).__call__(
124
                        inv, parent_ie, path, kind)
125
        return file_id
126
127
    def _get_base_file_id(self, path, parent_ie):
128
        """Look for a file id in the base branch.
129
130
        First, if the base tree has the parent directory,
131
        we look for a file with the same name in that directory.
132
        Else, we look for an entry in the base tree with the same path.
133
        """
134
5967.7.1 by Martin Pool
Deprecate __contains__ on Tree and Inventory
135
        if self.base_tree.has_id(parent_ie.file_id):
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
136
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
5870.1.36 by Jelmer Vernooij
kill _FastPath.
137
            base_child_ie = base_parent_ie.children.get(
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
138
                osutils.basename(path))
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
139
            if base_child_ie is not None:
140
                return (base_child_ie.file_id,
141
                        self.base_tree.id2path(base_child_ie.file_id))
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
142
        full_base_path = osutils.pathjoin(self.base_path, path)
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
143
        # This may return None, but it is our last attempt
144
        return self.base_tree.path2id(full_base_path), full_base_path