55
57
class AddAction(object):
56
58
"""A class which defines what action to take when adding a file."""
58
def __init__(self, to_file=None, should_add=None, should_print=None):
60
def __init__(self, to_file=None, should_print=None):
59
61
self._to_file = to_file
60
62
if to_file is None:
61
63
self._to_file = sys.stdout
62
self.should_add = False
63
if should_add is not None:
64
self.should_add = should_add
65
64
self.should_print = False
66
65
if should_print is not None:
67
66
self.should_print = should_print
69
def __call__(self, inv, parent_ie, path, kind):
68
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
70
69
"""Add path to inventory.
72
71
The default action does nothing.
74
73
:param inv: The inventory we are working with.
75
:param path: The path being added
74
:param path: The FastPath being added
76
75
:param kind: The kind of the object being added.
79
self._add_to_inv(inv, parent_ie, path, kind)
81
self._print(inv, parent_ie, path, kind)
83
def _print(self, inv, parent_ie, path, kind):
84
"""Print a line to self._to_file for each file that would be added."""
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, parent_ie, path, kind):
90
"""Add each file to the given inventory. Produce no output."""
91
if parent_ie is not None:
92
entry = bzrlib.inventory.make_entry(
93
kind, bzrlib.osutils.basename(path), parent_ie.file_id)
96
entry = inv.add_path(path, kind=kind)
97
# mutter("added %r kind %r file_id={%s}", path, kind, entry.file_id)
77
if not self.should_print:
79
self._to_file.write('added %s\n' % _quote(path.raw_path))
100
82
# TODO: jam 20050105 These could be used for compatibility
102
84
# one which exists at the time they are called, so they
103
85
# don't work for the test suite.
105
add_action_null = AddAction()
106
add_action_add = AddAction(should_add=True)
107
add_action_print = AddAction(should_print=True)
108
add_action_add_and_print = AddAction(should_add=True, should_print=True)
111
def smart_add(file_list, recurse=True, action=None):
87
add_action_add = AddAction()
88
add_action_null = add_action_add
89
add_action_add_and_print = AddAction(should_print=True)
90
add_action_print = add_action_add_and_print
93
def smart_add(file_list, recurse=True, action=None, save=True):
112
94
"""Add files to version, optionally recursing into directories.
114
96
This is designed more towards DWIM for humans than API simplicity.
115
97
For the specific behaviour see the help for cmd_add().
117
99
Returns the number of files added.
100
Please see smart_add_tree for more detail.
119
102
file_list = _prepare_file_list(file_list)
120
103
tree = WorkingTree.open_containing(file_list[0])[0]
121
104
return smart_add_tree(tree, file_list, recurse, action=action)
124
def smart_add_tree(tree, file_list, recurse=True, action=None):
107
class FastPath(object):
108
"""A path object with fast accessors for things like basename."""
110
__slots__ = ['raw_path', 'base_path']
112
def __init__(self, path, base_path=None):
113
"""Construct a FastPath from path."""
114
if base_path is None:
115
self.base_path = bzrlib.osutils.basename(path)
117
self.base_path = base_path
120
def __cmp__(self, other):
121
return cmp(self.raw_path, other.raw_path)
124
return hash(self.raw_path)
127
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
125
128
"""Add files to version, optionally recursing into directories.
127
130
This is designed more towards DWIM for humans than API simplicity.
130
133
This calls reporter with each (path, kind, file_id) of added files.
132
135
Returns the number of files added.
137
:param save: Save the inventory after completing the adds. If False this
138
provides dry-run functionality by doing the add and not saving the
139
inventory. Note that the modified inventory is left in place, allowing
140
further dry-run tasks to take place. To restore the original inventory
141
call tree.read_working_inventory().
135
from bzrlib.errors import BadFileKindError, ForbiddenFileError
136
143
assert isinstance(recurse, bool)
137
144
if action is None:
138
action = AddAction(should_add=True)
140
147
prepared_list = _prepare_file_list(file_list)
141
148
mutter("smart add of %r, originally %r", prepared_list, file_list)
142
149
inv = tree.read_working_inventory()
148
155
# validate user file paths and convert all paths to tree
149
156
# relative : its cheaper to make a tree relative path an abspath
150
157
# than to convert an abspath to tree relative.
151
158
for filepath in prepared_list:
152
rf = tree.relpath(filepath)
154
files_to_add.append((rf, None))
159
rf = FastPath(tree.relpath(filepath))
155
160
# validate user parameters. Our recursive code avoids adding new files
156
161
# that need such validation
157
if tree.is_control_filename(rf):
158
raise ForbiddenFileError('cannot add control file %s' % filepath)
160
for filepath, parent_ie in files_to_add:
161
# filepath is tree-relative
162
abspath = tree.abspath(filepath)
164
# find the kind of the path being added. This is not
165
# currently determined when we list directories
166
# recursively, but in theory we can determine while
167
# doing the directory listing on *some* platformans.
168
# TODO: a safe, portable, clean interface which will
169
# be faster than os.listdir() + stat. Specifically,
170
# readdir - dirent.d_type supplies the file type when
171
# it is defined. (Apparently Mac OSX has the field but
172
# does not fill it in ?!) Robert C, Martin P.
174
kind = bzrlib.osutils.file_kind(abspath)
176
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
177
raise errors.NoSuchFile(abspath)
180
# we need to call this to determine the inventory kind to create.
162
if tree.is_control_filename(rf.raw_path):
163
raise errors.ForbiddenControlFileError(filename=rf)
165
abspath = tree.abspath(rf.raw_path)
166
kind = bzrlib.osutils.file_kind(abspath)
167
if kind == 'directory':
168
# schedule the dir for scanning
171
if not InventoryEntry.versionable_kind(kind):
172
raise errors.BadFileKindError(filename=abspath, kind=kind)
173
# ensure the named path is added, so that ignore rules in the later directory
175
# we dont have a parent ie known yet.: use the relatively slower inventory
177
versioned = inv.has_filename(rf.raw_path)
180
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
183
# no need to walk any directories at all.
184
if len(added) > 0 and save:
185
tree._write_inventory(inv)
186
return added, ignored
188
# only walk the minimal parents needed: we have user_dirs to override
192
is_inside = bzrlib.osutils.is_inside_or_parent_of_any
193
for path in sorted(user_dirs):
194
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
195
dirs_to_add.append((path, None))
196
prev_dir = path.raw_path
198
# this will eventually be *just* directories, right now it starts off with
200
for directory, parent_ie in dirs_to_add:
201
# directory is tree-relative
202
abspath = tree.abspath(directory.raw_path)
204
# get the contents of this directory.
206
# find the kind of the path being added.
207
kind = bzrlib.osutils.file_kind(abspath)
181
209
if not InventoryEntry.versionable_kind(kind):
182
if filepath in user_files:
183
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
185
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
210
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
188
213
if parent_ie is not None:
189
versioned = bzrlib.osutils.basename(filepath) in parent_ie.children
214
versioned = directory.base_path in parent_ie.children
191
216
# without the parent ie, use the relatively slower inventory
193
versioned = inv.has_filename(filepath)
218
versioned = inv.has_filename(directory.raw_path)
195
220
if kind == 'directory':
213
238
mutter("%r is a nested bzr tree", abspath)
215
added.extend(__add_one(tree, inv, parent_ie, filepath, kind, action))
240
__add_one(tree, inv, parent_ie, directory, kind, action)
241
added.append(directory.raw_path)
217
if kind == 'directory' and recurse and not sub_tree:
219
if parent_ie is not None:
221
this_ie = parent_ie.children[bzrlib.osutils.basename(filepath)]
243
if kind == 'directory' and not sub_tree:
244
if parent_ie is not None:
246
this_ie = parent_ie.children[directory.base_path]
248
# without the parent ie, use the relatively slower inventory
250
this_id = inv.path2id(directory.raw_path)
223
# without the parent ie, use the relatively slower inventory
225
this_id = inv.path2id(filepath)
229
this_ie = inv[this_id]
254
this_ie = inv[this_id]
233
256
for subf in os.listdir(abspath):
234
257
# here we could use TreeDirectory rather than
235
258
# string concatenation.
236
subp = bzrlib.osutils.pathjoin(filepath, subf)
259
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
237
260
# TODO: is_control_filename is very slow. Make it faster.
238
261
# TreeDirectory.is_control_filename could also make this
239
262
# faster - its impossible for a non root dir to have a
241
264
if tree.is_control_filename(subp):
242
265
mutter("skip control directory %r", subp)
266
elif subf in this_ie.children:
267
# recurse into this already versioned subdir.
268
dirs_to_add.append((FastPath(subp, subf), this_ie))
270
# user selection overrides ignoes
244
271
# ignore while selecting files - if we globbed in the
245
272
# outer loop we would ignore user files.
246
273
ignore_glob = tree.is_ignored(subp)
247
274
if ignore_glob is not None:
248
275
# mutter("skip ignored sub-file %r", subp)
249
if ignore_glob not in ignored:
250
ignored[ignore_glob] = []
251
ignored[ignore_glob].append(subp)
276
ignored.setdefault(ignore_glob, []).append(subp)
253
278
#mutter("queue to add sub-file %r", subp)
254
files_to_add.append((subp, this_ie))
279
dirs_to_add.append((FastPath(subp, subf), this_ie))
281
if len(added) > 0 and save:
257
282
tree._write_inventory(inv)
258
283
return added, ignored
261
def __add_one(tree, inv, parent_ie, path, kind, action):
286
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
262
287
"""Add a new entry to the inventory and automatically add unversioned parents.
264
Actual adding of the entry is delegated to the action callback.
266
289
:param inv: Inventory which will receive the new entry.
267
290
:param parent_ie: Parent inventory entry if known, or None. If
268
291
None, the parent is looked up by name and used if present, otherwise
282
304
# slower but does not need parent_ie
283
if inv.has_filename(path):
305
if inv.has_filename(path.raw_path):
286
added = __add_one(tree, inv, None, dirname(path), 'directory', action)
287
parent_id = inv.path2id(dirname(path))
288
if parent_id is not None:
289
parent_ie = inv[inv.path2id(dirname(path))]
307
# its really not there : add the parent
308
# note that the dirname use leads to some extra str copying etc but as
309
# there are a limited number of dirs we can be nested under, it should
310
# generally find it very fast and not recurse after that.
311
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
312
parent_id = inv.path2id(dirname(path.raw_path))
313
parent_ie = inv[parent_id]
314
__add_one(tree, inv, parent_ie, path, kind, action)
315
return added + [path.raw_path]
318
def __add_one(tree, inv, parent_ie, path, kind, action):
319
"""Add a new entry to the inventory.
321
:param inv: Inventory which will receive the new entry.
322
:param parent_ie: Parent inventory entry.
323
:param kind: Kind of new entry (file, directory, etc)
324
:param action: callback(inv, parent_ie, path, kind); return ignored.
292
327
action(inv, parent_ie, path, kind)
294
return added + [path]
328
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id)
added
removed
bzrlib/add.py
