1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Helper functions for adding files to working trees."""
18
from os.path import dirname
20
import bzrlib.errors as errors
21
from bzrlib.inventory import InventoryEntry
22
from bzrlib.trace import mutter, note, warning
23
from bzrlib.errors import NotBranchError
24
from bzrlib.workingtree import is_control_file
25
22
import bzrlib.osutils
26
from bzrlib.workingtree import WorkingTree
28
def glob_expand_for_win32(file_list):
32
expanded_file_list = []
33
for possible_glob in file_list:
34
glob_files = glob.glob(possible_glob)
37
# special case to let the normal code path handle
38
# files that do not exists
39
expanded_file_list.append(possible_glob)
41
expanded_file_list += glob_files
42
return expanded_file_list
45
def _prepare_file_list(file_list):
46
"""Prepare a file list for use by smart_add_*."""
47
if sys.platform == 'win32':
48
file_list = glob_expand_for_win32(file_list)
51
file_list = list(file_list)
23
from bzrlib.symbol_versioning import *
55
26
class AddAction(object):
56
27
"""A class which defines what action to take when adding a file."""
29
def __init__(self, to_file=None, should_print=None):
30
"""Initialize an action which prints added files to an output stream.
61
def __init__(self, to_file=None, should_add=None, should_print=None):
32
:param to_file: The stream to write into. This is expected to take
33
Unicode paths. If not supplied, it will default to ``sys.stdout``.
34
:param should_print: If False, printing will be suppressed.
62
36
self._to_file = to_file
63
37
if to_file is None:
64
38
self._to_file = sys.stdout
65
if should_add is not None:
66
self.should_add = should_add
39
self.should_print = False
67
40
if should_print is not None:
68
41
self.should_print = should_print
70
def __call__(self, inv, path, kind):
43
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
71
44
"""Add path to inventory.
73
46
The default action does nothing.
75
48
:param inv: The inventory we are working with.
76
:param path: The path being added
49
:param path: The FastPath being added
77
50
:param kind: The kind of the object being added.
80
self._add_to_inv(inv, path, kind)
81
52
if self.should_print:
82
self._print(inv, path, kind)
84
def _print(self, inv, path, kind):
85
self._to_file.write('added ')
86
self._to_file.write(bzrlib.osutils.quotefn(path))
87
self._to_file.write('\n')
89
def _add_to_inv(self, inv, path, kind):
90
entry = inv.add_path(path, kind=kind)
91
mutter("added %r kind %r file_id={%s}", path, kind, entry.file_id)
53
self._to_file.write('adding %s\n' % _quote(path.raw_path))
57
class AddFromBaseAction(AddAction):
58
"""This class will try to extract file ids from another tree."""
60
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
61
super(AddFromBaseAction, self).__init__(to_file=to_file,
62
should_print=should_print)
63
self.base_tree = base_tree
64
self.base_path = base_path
66
def __call__(self, inv, parent_ie, path, kind):
67
# Place the parent call
68
# Now check to see if we can extract an id for this file
69
file_id, base_path = self._get_base_file_id(path, parent_ie)
70
if file_id is not None:
72
self._to_file.write('adding %s w/ file id from %s\n'
73
% (path.raw_path, base_path))
75
# we aren't doing anything special, so let the default
77
file_id = super(AddFromBaseAction, self).__call__(
78
inv, parent_ie, path, kind)
81
def _get_base_file_id(self, path, parent_ie):
82
"""Look for a file id in the base branch.
84
First, if the base tree has the parent directory,
85
we look for a file with the same name in that directory.
86
Else, we look for an entry in the base tree with the same path.
89
if (parent_ie.file_id in self.base_tree):
90
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
91
base_child_ie = base_parent_ie.children.get(path.base_path)
92
if base_child_ie is not None:
93
return (base_child_ie.file_id,
94
self.base_tree.id2path(base_child_ie.file_id))
95
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
96
# This may return None, but it is our last attempt
97
return self.base_tree.path2id(full_base_path), full_base_path
94
100
# TODO: jam 20050105 These could be used for compatibility
96
102
# one which exists at the time they are called, so they
97
103
# don't work for the test suite.
99
add_action_null = AddAction()
100
add_action_add = AddAction(should_add=True)
101
add_action_print = AddAction(should_print=True)
102
add_action_add_and_print = AddAction(should_add=True, should_print=True)
105
def smart_add(file_list, recurse=True, action=None):
106
"""Add files to version, optionally recursing into directories.
108
This is designed more towards DWIM for humans than API simplicity.
109
For the specific behaviour see the help for cmd_add().
111
Returns the number of files added.
114
file_list = _prepare_file_list(file_list)
115
tree = WorkingTree.open_containing(file_list[0])[0]
116
return smart_add_tree(tree, file_list, recurse, action=action)
119
def smart_add_tree(tree, file_list, recurse=True, action=None):
120
"""Add files to version, optionally recursing into directories.
122
This is designed more towards DWIM for humans than API simplicity.
123
For the specific behaviour see the help for cmd_add().
125
This calls reporter with each (path, kind, file_id) of added files.
127
Returns the number of files added.
130
from bzrlib.errors import BadFileKindError, ForbiddenFileError
131
assert isinstance(recurse, bool)
133
action = AddAction(should_add=True)
135
file_list = _prepare_file_list(file_list)
136
user_list = file_list[:]
137
inv = tree.read_working_inventory()
143
af = tree.abspath(rf)
146
kind = bzrlib.osutils.file_kind(af)
148
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
149
raise errors.NoSuchFile(rf)
152
if not InventoryEntry.versionable_kind(kind):
154
raise BadFileKindError("cannot add %s of type %s" % (f, kind))
156
warning("skipping %s (can't add file of kind '%s')", f, kind)
159
mutter("smart add of %r, abs=%r", f, af)
161
if tree.is_control_filename(af):
162
raise ForbiddenFileError('cannot add control file %s' % f)
164
versioned = (inv.path2id(rf) != None)
166
if kind == 'directory':
168
sub_branch = WorkingTree.open(af)
170
except NotBranchError:
172
except errors.UnsupportedFormatError:
178
mutter("tree root doesn't need to be added")
181
mutter("%r is already versioned", f)
183
mutter("%r is a bzr tree", f)
185
added.extend(__add_one(tree, inv, rf, kind, action))
187
if kind == 'directory' and recurse and not sub_tree:
188
for subf in os.listdir(af):
189
subp = bzrlib.osutils.pathjoin(rf, subf)
190
if tree.is_control_filename(subp):
191
mutter("skip control directory %r", subp)
193
ignore_glob = tree.is_ignored(subp)
194
if ignore_glob is not None:
195
mutter("skip ignored sub-file %r", subp)
196
if ignore_glob not in ignored:
197
ignored[ignore_glob] = []
198
ignored[ignore_glob].append(subp)
200
mutter("queue to add sub-file %r", subp)
201
file_list.append(tree.abspath(subp))
204
mutter('added %d entries', len(added))
207
tree._write_inventory(inv)
209
return added, ignored
212
def __add_one(tree, inv, path, kind, action):
213
"""Add a file or directory, automatically add unversioned parents."""
215
# Nothing to do if path is already versioned.
216
# This is safe from infinite recursion because the tree root is
218
if inv.path2id(path) != None:
222
added = __add_one(tree, inv, dirname(path), 'directory', action)
223
action(inv, path, kind)
225
return added + [path]
105
add_action_add = AddAction()
106
add_action_null = add_action_add
107
add_action_add_and_print = AddAction(should_print=True)
108
add_action_print = add_action_add_and_print
added
removed
bzrlib/add.py
