1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
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
26
from bzrlib.i18n import gettext
30
28
class AddAction(object):
31
29
"""A class which defines what action to take when adding a file."""
36
34
:param to_file: The stream to write into. This is expected to take
37
35
Unicode paths. If not supplied, it will default to ``sys.stdout``.
38
:param should_print: If False, printing will be supressed.
36
:param should_print: If False, printing will be suppressed.
40
38
self._to_file = to_file
41
39
if to_file is None:
44
42
if should_print is not None:
45
43
self.should_print = should_print
47
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
45
def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
48
46
"""Add path to inventory.
50
48
The default action does nothing.
54
52
:param kind: The kind of the object being added.
56
54
if self.should_print:
57
self._to_file.write('adding %s\n' % _quote(path.raw_path))
55
self._to_file.write('adding %s\n' % _quote(path))
58
def skip_file(self, tree, path, kind, stat_value = None):
59
"""Test whether the given file should be skipped or not.
61
The default action never skips. Note this is only called during
64
:param tree: The tree we are working in
65
:param path: The path being added
66
:param kind: The kind of object being added.
67
:param stat: Stat result for this file, if available already
68
:return bool. True if the file should be skipped (not added)
73
class AddWithSkipLargeAction(AddAction):
74
"""A class that can decide to skip a file if it's considered too large"""
77
_DEFAULT_MAX_FILE_SIZE = 20000000
78
_optionName = 'add.maximum_file_size'
81
def skip_file(self, tree, path, kind, stat_value = None):
84
if self._maxSize is None:
85
config = tree.branch.get_config()
86
self._maxSize = config.get_user_option_as_int_from_SI(
88
self._DEFAULT_MAX_FILE_SIZE)
89
if stat_value is None:
90
file_size = os.path.getsize(path);
92
file_size = stat_value.st_size;
93
if self._maxSize > 0 and file_size > self._maxSize:
94
ui.ui_factory.show_warning(gettext(
95
"skipping {0} (larger than {1} of {2} bytes)").format(
96
path, self._optionName, self._maxSize))
61
101
class AddFromBaseAction(AddAction):
62
102
"""This class will try to extract file ids from another tree."""
90
130
Else, we look for an entry in the base tree with the same path.
93
if (parent_ie.file_id in self.base_tree):
133
if self.base_tree.has_id(parent_ie.file_id):
94
134
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
95
base_child_ie = base_parent_ie.children.get(path.base_path)
135
base_child_ie = base_parent_ie.children.get(
136
osutils.basename(path))
96
137
if base_child_ie is not None:
97
138
return (base_child_ie.file_id,
98
139
self.base_tree.id2path(base_child_ie.file_id))
99
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
140
full_base_path = osutils.pathjoin(self.base_path, path)
100
141
# This may return None, but it is our last attempt
101
142
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