54
def add_action_null(inv, parent_ie, path, kind):
55
"""Absorb add actions and do nothing."""
59
def add_action_print(inv, parent_ie, path, kind):
60
"""Print a line to stdout for each file that would be added."""
61
print "added", bzrlib.osutils.quotefn(path)
64
def add_action_add(inv, parent_ie, path, kind):
65
"""Add each file to the given inventory. Produce no output."""
66
if parent_ie is not None:
67
entry = bzrlib.inventory.make_entry(
68
kind, bzrlib.osutils.basename(path), parent_ie.file_id)
71
entry = inv.add_path(path, kind=kind)
72
# mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
75
def add_action_add_and_print(inv, parent_ie, path, kind):
76
"""Add each file to the given inventory, and print a line to stdout."""
77
add_action_add(inv, parent_ie, path, kind)
78
add_action_print(inv, parent_ie, path, kind)
81
def smart_add(file_list, recurse=True, action=add_action_add):
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):
82
138
"""Add files to version, optionally recursing into directories.
84
140
This is designed more towards DWIM for humans than API simplicity.
85
141
For the specific behaviour see the help for cmd_add().
87
143
Returns the number of files added.
144
Please see smart_add_tree for more detail.
89
146
file_list = _prepare_file_list(file_list)
90
147
tree = WorkingTree.open_containing(file_list[0])[0]
91
return smart_add_tree(tree, file_list, recurse, action)
94
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
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):
95
172
"""Add files to version, optionally recursing into directories.
97
174
This is designed more towards DWIM for humans than API simplicity.
100
177
This calls reporter with each (path, kind, file_id) of added files.
102
179
Returns the number of files added.
181
:param save: Save the inventory after completing the adds. If False this
182
provides dry-run functionality by doing the add and not saving the
183
inventory. Note that the modified inventory is left in place, allowing
184
further dry-run tasks to take place. To restore the original inventory
185
call tree.read_working_inventory().
105
from bzrlib.errors import BadFileKindError, ForbiddenFileError
106
187
assert isinstance(recurse, bool)
108
191
prepared_list = _prepare_file_list(file_list)
109
192
mutter("smart add of %r, originally %r", prepared_list, file_list)
110
193
inv = tree.read_working_inventory()
116
199
# validate user file paths and convert all paths to tree
117
200
# relative : its cheaper to make a tree relative path an abspath
118
201
# than to convert an abspath to tree relative.
119
202
for filepath in prepared_list:
120
rf = tree.relpath(filepath)
122
files_to_add.append((rf, None))
203
rf = FastPath(tree.relpath(filepath))
123
204
# validate user parameters. Our recursive code avoids adding new files
124
205
# that need such validation
125
if tree.is_control_filename(rf):
126
raise ForbiddenFileError('cannot add control file %s' % filepath)
128
for filepath, parent_ie in files_to_add:
129
# filepath is tree-relative
130
abspath = tree.abspath(filepath)
132
# find the kind of the path being added. This is not
133
# currently determined when we list directories
134
# recursively, but in theory we can determine while
135
# doing the directory listing on *some* platformans.
136
# TODO: a safe, portable, clean interface which will
137
# be faster than os.listdir() + stat. Specifically,
138
# readdir - dirent.d_type supplies the file type when
139
# it is defined. (Apparently Mac OSX has the field but
140
# does not fill it in ?!) Robert C, Martin P.
142
kind = bzrlib.osutils.file_kind(abspath)
144
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
145
raise errors.NoSuchFile(abspath)
148
# we need to call this to determine the inventory kind to create.
206
if tree.is_control_filename(rf.raw_path):
207
raise errors.ForbiddenControlFileError(filename=rf)
209
abspath = tree.abspath(rf.raw_path)
210
kind = bzrlib.osutils.file_kind(abspath)
211
if kind == 'directory':
212
# schedule the dir for scanning
215
if not InventoryEntry.versionable_kind(kind):
216
raise errors.BadFileKindError(filename=abspath, kind=kind)
217
# ensure the named path is added, so that ignore rules in the later directory
219
# we dont have a parent ie known yet.: use the relatively slower inventory
221
versioned = inv.has_filename(rf.raw_path)
224
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
227
# no need to walk any directories at all.
228
if len(added) > 0 and save:
229
tree._write_inventory(inv)
230
return added, ignored
232
# only walk the minimal parents needed: we have user_dirs to override
236
is_inside = bzrlib.osutils.is_inside_or_parent_of_any
237
for path in sorted(user_dirs):
238
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
239
dirs_to_add.append((path, None))
240
prev_dir = path.raw_path
242
# this will eventually be *just* directories, right now it starts off with
244
for directory, parent_ie in dirs_to_add:
245
# directory is tree-relative
246
abspath = tree.abspath(directory.raw_path)
248
# get the contents of this directory.
250
# find the kind of the path being added.
251
kind = bzrlib.osutils.file_kind(abspath)
149
253
if not InventoryEntry.versionable_kind(kind):
150
if filepath in user_files:
151
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
153
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
254
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
156
257
if parent_ie is not None:
157
versioned = bzrlib.osutils.basename(filepath) in parent_ie.children
258
versioned = directory.base_path in parent_ie.children
159
260
# without the parent ie, use the relatively slower inventory
161
versioned = inv.has_filename(filepath)
262
versioned = inv.has_filename(directory.raw_path)
163
264
if kind == 'directory':
181
282
mutter("%r is a nested bzr tree", abspath)
183
added.extend(__add_one(tree, inv, parent_ie, filepath, kind, action))
284
__add_one(tree, inv, parent_ie, directory, kind, action)
285
added.append(directory.raw_path)
185
if kind == 'directory' and recurse and not sub_tree:
187
if parent_ie is not None:
189
this_ie = parent_ie.children[bzrlib.osutils.basename(filepath)]
287
if kind == 'directory' and not sub_tree:
288
if parent_ie is not None:
290
this_ie = parent_ie.children[directory.base_path]
292
# without the parent ie, use the relatively slower inventory
294
this_id = inv.path2id(directory.raw_path)
191
# without the parent ie, use the relatively slower inventory
193
this_id = inv.path2id(filepath)
197
this_ie = inv[this_id]
298
this_ie = inv[this_id]
201
for subf in os.listdir(abspath):
300
for subf in sorted(os.listdir(abspath)):
202
301
# here we could use TreeDirectory rather than
203
302
# string concatenation.
204
subp = bzrlib.osutils.pathjoin(filepath, subf)
303
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
205
304
# TODO: is_control_filename is very slow. Make it faster.
206
305
# TreeDirectory.is_control_filename could also make this
207
306
# faster - its impossible for a non root dir to have a
209
308
if tree.is_control_filename(subp):
210
309
mutter("skip control directory %r", subp)
310
elif subf in this_ie.children:
311
# recurse into this already versioned subdir.
312
dirs_to_add.append((FastPath(subp, subf), this_ie))
314
# user selection overrides ignoes
212
315
# ignore while selecting files - if we globbed in the
213
316
# outer loop we would ignore user files.
214
317
ignore_glob = tree.is_ignored(subp)
215
318
if ignore_glob is not None:
216
319
# mutter("skip ignored sub-file %r", subp)
217
if ignore_glob not in ignored:
218
ignored[ignore_glob] = []
219
ignored[ignore_glob].append(subp)
320
ignored.setdefault(ignore_glob, []).append(subp)
221
322
#mutter("queue to add sub-file %r", subp)
222
files_to_add.append((subp, this_ie))
323
dirs_to_add.append((FastPath(subp, subf), this_ie))
325
if len(added) > 0 and save:
225
326
tree._write_inventory(inv)
226
327
return added, ignored
229
def __add_one(tree, inv, parent_ie, path, kind, action):
330
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
230
331
"""Add a new entry to the inventory and automatically add unversioned parents.
232
Actual adding of the entry is delegated to the action callback.
234
333
:param inv: Inventory which will receive the new entry.
235
334
:param parent_ie: Parent inventory entry if known, or None. If
236
335
None, the parent is looked up by name and used if present, otherwise
250
348
# slower but does not need parent_ie
251
if inv.has_filename(path):
349
if inv.has_filename(path.raw_path):
254
added = __add_one(tree, inv, None, dirname(path), 'directory', action)
255
parent_id = inv.path2id(dirname(path))
256
if parent_id is not None:
257
parent_ie = inv[inv.path2id(dirname(path))]
260
action(inv, parent_ie, path, kind)
262
return added + [path]
351
# its really not there : add the parent
352
# note that the dirname use leads to some extra str copying etc but as
353
# there are a limited number of dirs we can be nested under, it should
354
# generally find it very fast and not recurse after that.
355
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
356
parent_id = inv.path2id(dirname(path.raw_path))
357
parent_ie = inv[parent_id]
358
__add_one(tree, inv, parent_ie, path, kind, action)
359
return added + [path.raw_path]
362
def __add_one(tree, inv, parent_ie, path, kind, action):
363
"""Add a new entry to the inventory.
365
:param inv: Inventory which will receive the new entry.
366
:param parent_ie: Parent inventory entry.
367
:param kind: Kind of new entry (file, directory, etc)
368
:param action: callback(inv, parent_ie, path, kind); return a file_id
369
or None to generate a new file id
372
file_id = action(inv, parent_ie, path, kind)
373
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/add.py
