1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
19
from os.path import dirname
23
import bzrlib.errors as errors
24
from bzrlib.inventory import InventoryEntry
25
from bzrlib.trace import mutter, note, warning
26
from bzrlib.errors import NotBranchError
28
from bzrlib.workingtree import WorkingTree
31
def glob_expand_for_win32(file_list):
35
expanded_file_list = []
36
for possible_glob in file_list:
37
glob_files = glob.glob(possible_glob)
40
# special case to let the normal code path handle
41
# files that do not exists
42
expanded_file_list.append(possible_glob)
44
expanded_file_list += glob_files
45
return expanded_file_list
48
def _prepare_file_list(file_list):
49
"""Prepare a file list for use by smart_add_*."""
50
if sys.platform == 'win32':
51
file_list = glob_expand_for_win32(file_list)
54
file_list = list(file_list)
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):
138
"""Add files to version, optionally recursing into directories.
140
This is designed more towards DWIM for humans than API simplicity.
141
For the specific behaviour see the help for cmd_add().
143
Returns the number of files added.
144
Please see smart_add_tree for more detail.
146
file_list = _prepare_file_list(file_list)
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
"""Add files to version, optionally recursing into directories.
174
This is designed more towards DWIM for humans than API simplicity.
175
For the specific behaviour see the help for cmd_add().
177
This calls reporter with each (path, kind, file_id) of added files.
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().
187
assert isinstance(recurse, bool)
191
prepared_list = _prepare_file_list(file_list)
192
mutter("smart add of %r, originally %r", prepared_list, file_list)
193
inv = tree.read_working_inventory()
199
# validate user file paths and convert all paths to tree
200
# relative : its cheaper to make a tree relative path an abspath
201
# than to convert an abspath to tree relative.
202
for filepath in prepared_list:
203
rf = FastPath(tree.relpath(filepath))
204
# validate user parameters. Our recursive code avoids adding new files
205
# that need such validation
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)
253
if not InventoryEntry.versionable_kind(kind):
254
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
257
if parent_ie is not None:
258
versioned = directory.base_path in parent_ie.children
260
# without the parent ie, use the relatively slower inventory
262
versioned = inv.has_filename(directory.raw_path)
264
if kind == 'directory':
266
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
268
except NotBranchError:
270
except errors.UnsupportedFormatError:
275
if directory.raw_path == '':
276
# mutter("tree root doesn't need to be added")
280
# mutter("%r is already versioned", abspath)
282
mutter("%r is a nested bzr tree", abspath)
284
__add_one(tree, inv, parent_ie, directory, kind, action)
285
added.append(directory.raw_path)
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)
298
this_ie = inv[this_id]
300
for subf in sorted(os.listdir(abspath)):
301
# here we could use TreeDirectory rather than
302
# string concatenation.
303
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
304
# TODO: is_control_filename is very slow. Make it faster.
305
# TreeDirectory.is_control_filename could also make this
306
# faster - its impossible for a non root dir to have a
308
if tree.is_control_filename(subp):
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
315
# ignore while selecting files - if we globbed in the
316
# outer loop we would ignore user files.
317
ignore_glob = tree.is_ignored(subp)
318
if ignore_glob is not None:
319
# mutter("skip ignored sub-file %r", subp)
320
ignored.setdefault(ignore_glob, []).append(subp)
322
#mutter("queue to add sub-file %r", subp)
323
dirs_to_add.append((FastPath(subp, subf), this_ie))
325
if len(added) > 0 and save:
326
tree._write_inventory(inv)
327
return added, ignored
330
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
331
"""Add a new entry to the inventory and automatically add unversioned parents.
333
:param inv: Inventory which will receive the new entry.
334
:param parent_ie: Parent inventory entry if known, or None. If
335
None, the parent is looked up by name and used if present, otherwise
336
it is recursively added.
337
:param kind: Kind of new entry (file, directory, etc)
338
:param action: callback(inv, parent_ie, path, kind); return ignored.
339
:returns: A list of paths which have been added.
341
# Nothing to do if path is already versioned.
342
# This is safe from infinite recursion because the tree root is
344
if parent_ie is not None:
345
# we have a parent ie already
348
# slower but does not need parent_ie
349
if inv.has_filename(path.raw_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
