13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Helper functions for adding files to working trees."""
19
from __future__ import absolute_import
28
from bzrlib.i18n import gettext
24
import bzrlib.errors as errors
26
from bzrlib.symbol_versioning import *
27
from bzrlib.workingtree import WorkingTree
30
30
class AddAction(object):
31
31
"""A class which defines what action to take when adding a file."""
44
44
if should_print is not None:
45
45
self.should_print = should_print
47
def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
47
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
48
48
"""Add path to inventory.
50
50
The default action does nothing.
54
54
:param kind: The kind of the object being added.
56
56
if self.should_print:
57
self._to_file.write('adding %s\n' % _quote(path))
57
self._to_file.write('added %s\n' % _quote(path.raw_path))
60
def skip_file(self, tree, path, kind, stat_value = None):
61
"""Test whether the given file should be skipped or not.
63
The default action never skips. Note this is only called during
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.
69
:param stat: Stat result for this file, if available already
70
:return bool. True if the file should be skipped (not added)
75
class AddWithSkipLargeAction(AddAction):
76
"""A class that can decide to skip a file if it's considered too large"""
80
def skip_file(self, tree, path, kind, stat_value = None):
83
opt_name = 'add.maximum_file_size'
84
if self._maxSize is None:
85
config = tree.get_config_stack()
86
self._maxSize = config.get(opt_name)
87
if stat_value is None:
88
file_size = os.path.getsize(path);
90
file_size = stat_value.st_size;
91
if self._maxSize > 0 and file_size > self._maxSize:
92
ui.ui_factory.show_warning(gettext(
93
"skipping {0} (larger than {1} of {2} bytes)").format(
94
path, opt_name, self._maxSize))
99
61
class AddFromBaseAction(AddAction):
100
62
"""This class will try to extract file ids from another tree."""
111
73
file_id, base_path = self._get_base_file_id(path, parent_ie)
112
74
if file_id is not None:
113
75
if self.should_print:
114
self._to_file.write('adding %s w/ file id from %s\n'
76
self._to_file.write('added %s w/ file id from %s\n'
77
% (path.raw_path, base_path))
117
79
# we aren't doing anything special, so let the default
127
89
we look for a file with the same name in that directory.
128
90
Else, we look for an entry in the base tree with the same path.
130
if self.base_tree.has_id(parent_ie.file_id):
131
base_path = osutils.pathjoin(
132
self.base_tree.id2path(parent_ie.file_id),
133
osutils.basename(path))
134
base_id = self.base_tree.path2id(base_path)
135
if base_id is not None:
136
return (base_id, base_path)
137
full_base_path = osutils.pathjoin(self.base_path, 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)
138
100
# This may return None, but it is our last attempt
139
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
115
@deprecated_function(zero_eighteen)
116
def smart_add(file_list, recurse=True, action=None, save=True):
117
"""Add files to version, optionally recursing into directories.
119
This is designed more towards DWIM for humans than API simplicity.
120
For the specific behaviour see the help for cmd_add().
122
Returns the number of files added.
123
Deprecated in 0.18. Please use MutableTree.smart_add.
125
tree = WorkingTree.open_containing(file_list[0])[0]
126
return smart_add_tree(tree, file_list, recurse, action=action, save=save)
129
@deprecated_function(zero_eighteen)
130
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
131
"""Deprecated in 0.18. Please use MutableTree.smart_add."""
132
return tree.smart_add(file_list, recurse, action, save)