1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005 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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
17
"""Helper functions for adding files to working trees."""
26
from bzrlib.i18n import gettext
28
class AddAction(object):
29
"""A class which defines what action to take when adding a file."""
31
def __init__(self, to_file=None, should_print=None):
32
"""Initialize an action which prints added files to an output stream.
34
:param to_file: The stream to write into. This is expected to take
35
Unicode paths. If not supplied, it will default to ``sys.stdout``.
36
:param should_print: If False, printing will be suppressed.
38
self._to_file = to_file
40
self._to_file = sys.stdout
41
self.should_print = False
42
if should_print is not None:
43
self.should_print = should_print
45
def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
46
"""Add path to inventory.
48
The default action does nothing.
50
:param inv: The inventory we are working with.
51
:param path: The FastPath being added
52
:param kind: The kind of the object being added.
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))
101
class AddFromBaseAction(AddAction):
102
"""This class will try to extract file ids from another tree."""
104
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
105
super(AddFromBaseAction, self).__init__(to_file=to_file,
106
should_print=should_print)
107
self.base_tree = base_tree
108
self.base_path = base_path
110
def __call__(self, inv, parent_ie, path, kind):
111
# Place the parent call
112
# Now check to see if we can extract an id for this file
113
file_id, base_path = self._get_base_file_id(path, parent_ie)
114
if file_id is not None:
115
if self.should_print:
116
self._to_file.write('adding %s w/ file id from %s\n'
119
# we aren't doing anything special, so let the default
121
file_id = super(AddFromBaseAction, self).__call__(
122
inv, parent_ie, path, kind)
125
def _get_base_file_id(self, path, parent_ie):
126
"""Look for a file id in the base branch.
128
First, if the base tree has the parent directory,
129
we look for a file with the same name in that directory.
130
Else, we look for an entry in the base tree with the same path.
133
if self.base_tree.has_id(parent_ie.file_id):
134
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
135
base_child_ie = base_parent_ie.children.get(
136
osutils.basename(path))
137
if base_child_ie is not None:
138
return (base_child_ie.file_id,
139
self.base_tree.id2path(base_child_ie.file_id))
140
full_base_path = osutils.pathjoin(self.base_path, path)
141
# This may return None, but it is our last attempt
142
return self.base_tree.path2id(full_base_path), full_base_path
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from os.path import dirname
19
import bzrlib.errors as errors
20
from bzrlib.inventory import InventoryEntry
21
from bzrlib.trace import mutter, note, warning
22
from bzrlib.errors import NotBranchError
23
from bzrlib.branch import is_control_file
25
from bzrlib.workingtree import WorkingTree
27
def glob_expand_for_win32(file_list):
31
expanded_file_list = []
32
for possible_glob in file_list:
33
glob_files = glob.glob(possible_glob)
36
# special case to let the normal code path handle
37
# files that do not exists
38
expanded_file_list.append(possible_glob)
40
expanded_file_list += glob_files
41
return expanded_file_list
44
def add_reporter_null(path, kind, entry):
45
"""Absorb add reports and do nothing."""
49
def add_reporter_print(path, kind, entry):
50
"""Print a line to stdout for each file that's added."""
51
print "added", bzrlib.osutils.quotefn(path)
54
def _prepare_file_list(file_list):
55
"""Prepare a file list for use by smart_add_*."""
57
if sys.platform == 'win32':
58
file_list = glob_expand_for_win32(file_list)
61
file_list = list(file_list)
65
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
66
"""Add files to version, optionally recursing into directories.
68
This is designed more towards DWIM for humans than API simplicity.
69
For the specific behaviour see the help for cmd_add().
71
Returns the number of files added.
73
file_list = _prepare_file_list(file_list)
74
tree = WorkingTree.open_containing(file_list[0])[0]
75
return smart_add_tree(tree, file_list, recurse, reporter)
78
def smart_add_tree(tree, file_list, recurse=True, reporter=add_reporter_null):
79
"""Add files to version, optionally recursing into directories.
81
This is designed more towards DWIM for humans than API simplicity.
82
For the specific behaviour see the help for cmd_add().
84
This calls reporter with each (path, kind, file_id) of added files.
86
Returns the number of files added.
89
from bzrlib.errors import BadFileKindError, ForbiddenFileError
90
assert isinstance(recurse, bool)
92
file_list = _prepare_file_list(file_list)
93
user_list = file_list[:]
94
inv = tree.read_working_inventory()
101
kind = bzrlib.osutils.file_kind(af)
103
if not InventoryEntry.versionable_kind(kind):
105
raise BadFileKindError("cannot add %s of type %s" % (f, kind))
107
warning("skipping %s (can't add file of kind '%s')", f, kind)
110
mutter("smart add of %r, abs=%r", f, af)
112
if is_control_file(af):
113
raise ForbiddenFileError('cannot add control file %s' % f)
115
versioned = (inv.path2id(rf) != None)
117
if kind == 'directory':
119
sub_branch = WorkingTree(af)
121
except NotBranchError:
123
except errors.UnsupportedFormatError:
129
mutter("tree root doesn't need to be added")
132
mutter("%r is already versioned", f)
134
mutter("%r is a bzr tree", f)
136
count += __add_one(tree, inv, rf, kind, reporter)
138
if kind == 'directory' and recurse and not sub_tree:
139
for subf in os.listdir(af):
140
subp = os.path.join(rf, subf)
141
if subf == bzrlib.BZRDIR:
142
mutter("skip control directory %r", subp)
143
elif tree.is_ignored(subp):
144
mutter("skip ignored sub-file %r", subp)
146
mutter("queue to add sub-file %r", subp)
147
file_list.append(tree.abspath(subp))
150
mutter('added %d entries', count)
153
tree._write_inventory(inv)
157
def __add_one(tree, inv, path, kind, reporter):
158
"""Add a file or directory, automatically add unversioned parents."""
160
# Nothing to do if path is already versioned.
161
# This is safe from infinite recursion because the tree root is
163
if inv.path2id(path) != None:
167
count = __add_one(tree, inv, dirname(path), 'directory', reporter)
169
entry = inv.add_path(path, kind=kind)
170
mutter("added %r kind %r file_id={%s}", path, kind, entry.file_id)
171
reporter(path, kind, entry)
added
removed
bzrlib/add.py
