40
45
return expanded_file_list
43
def add_reporter_null(path, kind, entry):
44
"""Absorb add reports and do nothing."""
47
def add_reporter_print(path, kind, entry):
48
"""Print a line to stdout for each file that's added."""
49
print "added", quotefn(path)
51
48
def _prepare_file_list(file_list):
52
49
"""Prepare a file list for use by smart_add_*."""
54
50
if sys.platform == 'win32':
55
51
file_list = glob_expand_for_win32(file_list)
58
54
file_list = list(file_list)
62
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
58
class AddAction(object):
59
"""A class which defines what action to take when adding a file."""
61
def __init__(self, to_file=None, should_print=None):
62
self._to_file = to_file
64
self._to_file = sys.stdout
65
self.should_print = False
66
if should_print is not None:
67
self.should_print = should_print
69
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
70
"""Add path to inventory.
72
The default action does nothing.
74
:param inv: The inventory we are working with.
75
:param path: The FastPath being added
76
:param kind: The kind of the object being added.
79
self._to_file.write('added %s\n' % _quote(path.raw_path))
83
class AddFromBaseAction(AddAction):
84
"""This class will try to extract file ids from another tree."""
86
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
87
super(AddFromBaseAction, self).__init__(to_file=to_file,
88
should_print=should_print)
89
self.base_tree = base_tree
90
self.base_path = base_path
92
def __call__(self, inv, parent_ie, path, kind):
93
# Place the parent call
94
# Now check to see if we can extract an id for this file
95
file_id, base_path = self._get_base_file_id(path, parent_ie)
96
if file_id is not None:
98
self._to_file.write('added %s w/ file id from %s\n'
99
% (path.raw_path, base_path))
101
# we aren't doing anything special, so let the default
103
file_id = super(AddFromBaseAction, self).__call__(
104
inv, parent_ie, path, kind)
107
def _get_base_file_id(self, path, parent_ie):
108
"""Look for a file id in the base branch.
110
First, if the base tree has the parent directory,
111
we look for a file with the same name in that directory.
112
Else, we look for an entry in the base tree with the same path.
115
if (parent_ie.file_id in self.base_tree):
116
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
117
base_child_ie = base_parent_ie.children.get(path.base_path)
118
if base_child_ie is not None:
119
return (base_child_ie.file_id,
120
self.base_tree.id2path(base_child_ie.file_id))
121
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
122
# This may return None, but it is our last attempt
123
return self.base_tree.path2id(full_base_path), full_base_path
126
# TODO: jam 20050105 These could be used for compatibility
127
# however, they bind against the current stdout, not the
128
# one which exists at the time they are called, so they
129
# don't work for the test suite.
131
add_action_add = AddAction()
132
add_action_null = add_action_add
133
add_action_add_and_print = AddAction(should_print=True)
134
add_action_print = add_action_add_and_print
137
def smart_add(file_list, recurse=True, action=None, save=True):
63
138
"""Add files to version, optionally recursing into directories.
65
140
This is designed more towards DWIM for humans than API simplicity.
66
141
For the specific behaviour see the help for cmd_add().
68
143
Returns the number of files added.
144
Please see smart_add_tree for more detail.
70
146
file_list = _prepare_file_list(file_list)
71
b = Branch.open_containing(file_list[0])[0]
72
return smart_add_branch(b, file_list, recurse, reporter)
75
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
147
tree = WorkingTree.open_containing(file_list[0])[0]
148
return smart_add_tree(tree, file_list, recurse, action=action, save=save)
151
class FastPath(object):
152
"""A path object with fast accessors for things like basename."""
154
__slots__ = ['raw_path', 'base_path']
156
def __init__(self, path, base_path=None):
157
"""Construct a FastPath from path."""
158
if base_path is None:
159
self.base_path = bzrlib.osutils.basename(path)
161
self.base_path = base_path
164
def __cmp__(self, other):
165
return cmp(self.raw_path, other.raw_path)
168
return hash(self.raw_path)
171
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
172
tree.lock_tree_write()
174
return _smart_add_tree(tree=tree, file_list=file_list, recurse=recurse,
175
action=action, save=save)
179
def _smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
76
180
"""Add files to version, optionally recursing into directories.
78
182
This is designed more towards DWIM for humans than API simplicity.
79
183
For the specific behaviour see the help for cmd_add().
81
This yields a sequence of (path, kind, file_id) for added files.
185
This calls reporter with each (path, kind, file_id) of added files.
83
187
Returns the number of files added.
189
:param save: Save the inventory after completing the adds. If False this
190
provides dry-run functionality by doing the add and not saving the
191
inventory. Note that the modified inventory is left in place, allowing
192
further dry-run tasks to take place. To restore the original inventory
193
call tree.read_working_inventory().
86
from bzrlib.errors import BadFileKindError, ForbiddenFileError
89
195
assert isinstance(recurse, bool)
91
file_list = _prepare_file_list(file_list)
92
user_list = file_list[:]
93
tree = branch.working_tree()
199
prepared_list = _prepare_file_list(file_list)
200
mutter("smart add of %r, originally %r", prepared_list, file_list)
94
201
inv = tree.read_working_inventory()
99
af = branch.abspath(rf)
101
kind = bzrlib.osutils.file_kind(af)
207
# validate user file paths and convert all paths to tree
208
# relative : its cheaper to make a tree relative path an abspath
209
# than to convert an abspath to tree relative.
210
for filepath in prepared_list:
211
rf = FastPath(tree.relpath(filepath))
212
# validate user parameters. Our recursive code avoids adding new files
213
# that need such validation
214
if tree.is_control_filename(rf.raw_path):
215
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
217
abspath = tree.abspath(rf.raw_path)
218
kind = bzrlib.osutils.file_kind(abspath)
219
if kind == 'directory':
220
# schedule the dir for scanning
223
if not InventoryEntry.versionable_kind(kind):
224
raise errors.BadFileKindError(filename=abspath, kind=kind)
225
# ensure the named path is added, so that ignore rules in the later directory
227
# we dont have a parent ie known yet.: use the relatively slower inventory
229
versioned = inv.has_filename(rf.raw_path)
232
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
235
# no need to walk any directories at all.
236
if len(added) > 0 and save:
237
tree._write_inventory(inv)
238
return added, ignored
240
# only walk the minimal parents needed: we have user_dirs to override
244
is_inside = bzrlib.osutils.is_inside_or_parent_of_any
245
for path in sorted(user_dirs):
246
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
247
dirs_to_add.append((path, None))
248
prev_dir = path.raw_path
250
# this will eventually be *just* directories, right now it starts off with
252
for directory, parent_ie in dirs_to_add:
253
# directory is tree-relative
254
abspath = tree.abspath(directory.raw_path)
256
# get the contents of this directory.
258
# find the kind of the path being added.
259
kind = bzrlib.osutils.file_kind(abspath)
103
261
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)
262
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
110
mutter("smart add of %r, abs=%r", f, af)
112
if bzrlib.branch.is_control_file(af):
113
raise ForbiddenFileError('cannot add control file %s' % f)
115
versioned = (inv.path2id(rf) != None)
265
if parent_ie is not None:
266
versioned = directory.base_path in parent_ie.children
268
# without the parent ie, use the relatively slower inventory
270
versioned = inv.has_filename(directory.raw_path)
117
272
if kind == 'directory':
119
sub_branch = Branch.open(af)
274
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
121
276
except NotBranchError:
129
mutter("branch root doesn't need to be added")
283
if directory.raw_path == '':
284
# mutter("tree root doesn't need to be added")
132
mutter("%r is already versioned", f)
288
# mutter("%r is already versioned", abspath)
134
mutter("%r is a bzr tree", f)
290
# XXX: This is wrong; people *might* reasonably be trying to add
291
# subtrees as subtrees. This should probably only be done in formats
292
# which can represent subtrees, and even then perhaps only when
293
# the user asked to add subtrees. At the moment you can add them
294
# specially through 'join --reference', which is perhaps
295
# reasonable: adding a new reference is a special operation and
296
# can have a special behaviour. mbp 20070306
297
mutter("%r is a nested bzr tree", abspath)
136
count += __add_one(branch, 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:
299
__add_one(tree, inv, parent_ie, directory, kind, action)
300
added.append(directory.raw_path)
302
if kind == 'directory' and not sub_tree:
303
if parent_ie is not None:
305
this_ie = parent_ie.children[directory.base_path]
307
# without the parent ie, use the relatively slower inventory
309
this_id = inv.path2id(directory.raw_path)
313
this_ie = inv[this_id]
315
for subf in sorted(os.listdir(abspath)):
316
# here we could use TreeDirectory rather than
317
# string concatenation.
318
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
319
# TODO: is_control_filename is very slow. Make it faster.
320
# TreeDirectory.is_control_filename could also make this
321
# faster - its impossible for a non root dir to have a
323
if tree.is_control_filename(subp):
142
324
mutter("skip control directory %r", subp)
143
elif tree.is_ignored(subp):
144
mutter("skip ignored sub-file %r", subp)
325
elif subf in this_ie.children:
326
# recurse into this already versioned subdir.
327
dirs_to_add.append((FastPath(subp, subf), this_ie))
146
mutter("queue to add sub-file %r", subp)
147
file_list.append(branch.abspath(subp))
150
mutter('added %d entries', count)
153
branch.working_tree()._write_inventory(inv)
157
def __add_one(branch, inv, path, kind, reporter):
158
"""Add a file or directory, automatically add unversioned parents."""
329
# user selection overrides ignoes
330
# ignore while selecting files - if we globbed in the
331
# outer loop we would ignore user files.
332
ignore_glob = tree.is_ignored(subp)
333
if ignore_glob is not None:
334
# mutter("skip ignored sub-file %r", subp)
335
ignored.setdefault(ignore_glob, []).append(subp)
337
#mutter("queue to add sub-file %r", subp)
338
dirs_to_add.append((FastPath(subp, subf), this_ie))
340
if len(added) > 0 and save:
341
tree._write_inventory(inv)
342
return added, ignored
345
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
346
"""Add a new entry to the inventory and automatically add unversioned parents.
348
:param inv: Inventory which will receive the new entry.
349
:param parent_ie: Parent inventory entry if known, or None. If
350
None, the parent is looked up by name and used if present, otherwise
351
it is recursively added.
352
:param kind: Kind of new entry (file, directory, etc)
353
:param action: callback(inv, parent_ie, path, kind); return ignored.
354
:returns: A list of paths which have been added.
160
356
# Nothing to do if path is already versioned.
161
# This is safe from infinite recursion because the branch root is
357
# This is safe from infinite recursion because the tree root is
162
358
# always versioned.
163
if inv.path2id(path) != None:
167
count = __add_one(branch, 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)
359
if parent_ie is not None:
360
# we have a parent ie already
363
# slower but does not need parent_ie
364
if inv.has_filename(path.raw_path):
366
# its really not there : add the parent
367
# note that the dirname use leads to some extra str copying etc but as
368
# there are a limited number of dirs we can be nested under, it should
369
# generally find it very fast and not recurse after that.
370
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
371
parent_id = inv.path2id(dirname(path.raw_path))
372
parent_ie = inv[parent_id]
373
__add_one(tree, inv, parent_ie, path, kind, action)
374
return added + [path.raw_path]
377
def __add_one(tree, inv, parent_ie, path, kind, action):
378
"""Add a new entry to the inventory.
380
:param inv: Inventory which will receive the new entry.
381
:param parent_ie: Parent inventory entry.
382
:param kind: Kind of new entry (file, directory, etc)
383
:param action: callback(inv, parent_ie, path, kind); return a file_id
384
or None to generate a new file id
387
file_id = action(inv, parent_ie, path, kind)
388
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/add.py
