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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
19
from os.path import dirname
19
23
import bzrlib.errors as errors
20
24
from bzrlib.inventory import InventoryEntry
21
25
from bzrlib.trace import mutter, note, warning
22
26
from bzrlib.errors import NotBranchError
23
from bzrlib.branch import is_control_file
24
27
import bzrlib.osutils
25
28
from bzrlib.workingtree import WorkingTree
27
31
def glob_expand_for_win32(file_list):
55
def add_action_null(inv, path, kind):
56
"""Absorb add actions and do nothing."""
59
def add_action_print(inv, path, kind):
60
"""Print a line to stdout for each file that would be added."""
61
print "added", bzrlib.osutils.quotefn(path)
63
def add_action_add(inv, path, kind):
64
"""Add each file to the given inventory. Produce no output."""
65
entry = inv.add_path(path, kind=kind)
66
mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
68
def add_action_add_and_print(inv, path, kind):
69
"""Add each file to the given inventory, and print a line to stdout."""
70
add_action_add(inv, path, kind)
71
add_action_print(inv, path, kind)
74
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):
75
138
"""Add files to version, optionally recursing into directories.
77
140
This is designed more towards DWIM for humans than API simplicity.
78
141
For the specific behaviour see the help for cmd_add().
80
143
Returns the number of files added.
144
Please see smart_add_tree for more detail.
82
146
file_list = _prepare_file_list(file_list)
83
147
tree = WorkingTree.open_containing(file_list[0])[0]
84
return smart_add_tree(tree, file_list, recurse, action)
86
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):
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):
87
180
"""Add files to version, optionally recursing into directories.
89
182
This is designed more towards DWIM for humans than API simplicity.
92
185
This calls reporter with each (path, kind, file_id) of added files.
94
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().
97
from bzrlib.errors import BadFileKindError, ForbiddenFileError
98
195
assert isinstance(recurse, bool)
100
file_list = _prepare_file_list(file_list)
101
user_list = file_list[:]
199
prepared_list = _prepare_file_list(file_list)
200
mutter("smart add of %r, originally %r", prepared_list, file_list)
102
201
inv = tree.read_working_inventory()
108
af = tree.abspath(rf)
111
kind = bzrlib.osutils.file_kind(af)
113
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
114
raise errors.NoSuchFile(rf)
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)
117
261
if not InventoryEntry.versionable_kind(kind):
119
raise BadFileKindError("cannot add %s of type %s" % (f, kind))
121
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)
124
mutter("smart add of %r, abs=%r", f, af)
126
if is_control_file(af):
127
raise ForbiddenFileError('cannot add control file %s' % f)
129
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)
131
272
if kind == 'directory':
133
sub_branch = WorkingTree(af)
274
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
135
276
except NotBranchError:
143
mutter("tree root doesn't need to be added")
283
if directory.raw_path == '':
284
# mutter("tree root doesn't need to be added")
146
mutter("%r is already versioned", f)
288
# mutter("%r is already versioned", abspath)
148
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. mbp 20070306
294
mutter("%r is a nested bzr tree", abspath)
150
added.extend(__add_one(tree, inv, rf, kind, action))
152
if kind == 'directory' and recurse and not sub_tree:
153
for subf in os.listdir(af):
154
subp = bzrlib.osutils.pathjoin(rf, subf)
155
if subf == bzrlib.BZRDIR:
296
__add_one(tree, inv, parent_ie, directory, kind, action)
297
added.append(directory.raw_path)
299
if kind == 'directory' and not sub_tree:
300
if parent_ie is not None:
302
this_ie = parent_ie.children[directory.base_path]
304
# without the parent ie, use the relatively slower inventory
306
this_id = inv.path2id(directory.raw_path)
310
this_ie = inv[this_id]
312
for subf in sorted(os.listdir(abspath)):
313
# here we could use TreeDirectory rather than
314
# string concatenation.
315
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
316
# TODO: is_control_filename is very slow. Make it faster.
317
# TreeDirectory.is_control_filename could also make this
318
# faster - its impossible for a non root dir to have a
320
if tree.is_control_filename(subp):
156
321
mutter("skip control directory %r", subp)
322
elif subf in this_ie.children:
323
# recurse into this already versioned subdir.
324
dirs_to_add.append((FastPath(subp, subf), this_ie))
326
# user selection overrides ignoes
327
# ignore while selecting files - if we globbed in the
328
# outer loop we would ignore user files.
158
329
ignore_glob = tree.is_ignored(subp)
159
330
if ignore_glob is not None:
160
mutter("skip ignored sub-file %r", subp)
161
if ignore_glob not in ignored:
162
ignored[ignore_glob] = []
163
ignored[ignore_glob].append(subp)
331
# mutter("skip ignored sub-file %r", subp)
332
ignored.setdefault(ignore_glob, []).append(subp)
165
mutter("queue to add sub-file %r", subp)
166
file_list.append(tree.abspath(subp))
169
mutter('added %d entries', len(added))
334
#mutter("queue to add sub-file %r", subp)
335
dirs_to_add.append((FastPath(subp, subf), this_ie))
337
if len(added) > 0 and save:
172
338
tree._write_inventory(inv)
174
339
return added, ignored
176
def __add_one(tree, inv, path, kind, action):
177
"""Add a file or directory, automatically add unversioned parents."""
342
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
343
"""Add a new entry to the inventory and automatically add unversioned parents.
345
:param inv: Inventory which will receive the new entry.
346
:param parent_ie: Parent inventory entry if known, or None. If
347
None, the parent is looked up by name and used if present, otherwise
348
it is recursively added.
349
:param kind: Kind of new entry (file, directory, etc)
350
:param action: callback(inv, parent_ie, path, kind); return ignored.
351
:returns: A list of paths which have been added.
179
353
# Nothing to do if path is already versioned.
180
354
# This is safe from infinite recursion because the tree root is
181
355
# always versioned.
182
if inv.path2id(path) != None:
186
added = __add_one(tree, inv, dirname(path), 'directory', action)
187
action(inv, path, kind)
189
return added + [path]
356
if parent_ie is not None:
357
# we have a parent ie already
360
# slower but does not need parent_ie
361
if inv.has_filename(path.raw_path):
363
# its really not there : add the parent
364
# note that the dirname use leads to some extra str copying etc but as
365
# there are a limited number of dirs we can be nested under, it should
366
# generally find it very fast and not recurse after that.
367
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
368
parent_id = inv.path2id(dirname(path.raw_path))
369
parent_ie = inv[parent_id]
370
__add_one(tree, inv, parent_ie, path, kind, action)
371
return added + [path.raw_path]
374
def __add_one(tree, inv, parent_ie, path, kind, action):
375
"""Add a new entry to the inventory.
377
:param inv: Inventory which will receive the new entry.
378
:param parent_ie: Parent inventory entry.
379
:param kind: Kind of new entry (file, directory, etc)
380
:param action: callback(inv, parent_ie, path, kind); return a file_id
381
or None to generate a new file id
384
file_id = action(inv, parent_ie, path, kind)
385
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/add.py
