1
# Copyright (C) 2005 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
18
from os.path import dirname
20
import bzrlib.errors as errors
21
from bzrlib.inventory import InventoryEntry
22
from bzrlib.trace import mutter, note, warning
23
from bzrlib.errors import NotBranchError
25
from bzrlib.workingtree import WorkingTree
28
def glob_expand_for_win32(file_list):
32
expanded_file_list = []
33
for possible_glob in file_list:
34
glob_files = glob.glob(possible_glob)
37
# special case to let the normal code path handle
38
# files that do not exists
39
expanded_file_list.append(possible_glob)
41
expanded_file_list += glob_files
42
return expanded_file_list
45
def _prepare_file_list(file_list):
46
"""Prepare a file list for use by smart_add_*."""
47
if sys.platform == 'win32':
48
file_list = glob_expand_for_win32(file_list)
51
file_list = list(file_list)
55
class AddAction(object):
56
"""A class which defines what action to take when adding a file."""
58
def __init__(self, to_file=None, should_print=None):
59
self._to_file = to_file
61
self._to_file = sys.stdout
62
self.should_print = False
63
if should_print is not None:
64
self.should_print = should_print
66
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
67
"""Add path to inventory.
69
The default action does nothing.
71
:param inv: The inventory we are working with.
72
:param path: The FastPath being added
73
:param kind: The kind of the object being added.
75
if not self.should_print:
77
self._to_file.write('added %s\n' % _quote(path.raw_path))
80
# TODO: jam 20050105 These could be used for compatibility
81
# however, they bind against the current stdout, not the
82
# one which exists at the time they are called, so they
83
# don't work for the test suite.
85
add_action_add = AddAction()
86
add_action_null = add_action_add
87
add_action_add_and_print = AddAction(should_print=True)
88
add_action_print = add_action_add_and_print
91
def smart_add(file_list, recurse=True, action=None, save=True):
92
"""Add files to version, optionally recursing into directories.
94
This is designed more towards DWIM for humans than API simplicity.
95
For the specific behaviour see the help for cmd_add().
97
Returns the number of files added.
98
Please see smart_add_tree for more detail.
100
file_list = _prepare_file_list(file_list)
101
tree = WorkingTree.open_containing(file_list[0])[0]
102
return smart_add_tree(tree, file_list, recurse, action=action)
105
class FastPath(object):
106
"""A path object with fast accessors for things like basename."""
108
__slots__ = ['raw_path', 'base_path']
110
def __init__(self, path, base_path=None):
111
"""Construct a FastPath from path."""
112
if base_path is None:
113
self.base_path = bzrlib.osutils.basename(path)
115
self.base_path = base_path
119
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
120
"""Add files to version, optionally recursing into directories.
122
This is designed more towards DWIM for humans than API simplicity.
123
For the specific behaviour see the help for cmd_add().
125
This calls reporter with each (path, kind, file_id) of added files.
127
Returns the number of files added.
129
:param save: Save the inventory after completing the adds. If False this
130
provides dry-run functionality by doing the add and not saving the
131
inventory. Note that the modified inventory is left in place, allowing
132
further dry-run tasks to take place. To restore the original inventory
133
call tree.read_working_inventory().
136
from bzrlib.errors import BadFileKindError, ForbiddenFileError
137
assert isinstance(recurse, bool)
141
prepared_list = _prepare_file_list(file_list)
142
mutter("smart add of %r, originally %r", prepared_list, file_list)
143
inv = tree.read_working_inventory()
149
# validate user file paths and convert all paths to tree
150
# relative : its cheaper to make a tree relative path an abspath
151
# than to convert an abspath to tree relative.
152
for filepath in prepared_list:
153
rf = FastPath(tree.relpath(filepath))
154
# validate user parameters. Our recursive code avoids adding new files
155
# that need such validation
156
if tree.is_control_filename(rf.raw_path):
157
raise ForbiddenFileError('cannot add control file %s' % filepath)
159
abspath = tree.abspath(rf.raw_path)
160
kind = bzrlib.osutils.file_kind(abspath)
161
if kind == 'directory':
162
# schedule the dir for scanning
163
user_dirs.add(rf.raw_path)
165
if not InventoryEntry.versionable_kind(kind):
166
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
167
# ensure the named path is added, so that ignore rules in the later directory
169
# we dont have a parent ie known yet.: use the relatively slower inventory
171
versioned = inv.has_filename(rf.raw_path)
174
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
177
# no need to walk any directories at all.
178
if len(added) > 0 and save:
179
tree._write_inventory(inv)
180
return added, ignored
182
# only walk the minimal parents needed: we have user_dirs to override
185
for path in sorted(user_dirs):
186
if (prev_dir is None or not
187
bzrlib.osutils.is_inside_or_parent_of_any([prev_dir], path)):
188
dirs_to_add.append((rf, None))
191
# this will eventually be *just* directories, right now it starts off with
193
for directory, parent_ie in dirs_to_add:
194
# directory is tree-relative
195
abspath = tree.abspath(directory.raw_path)
197
# get the contents of this directory.
199
# find the kind of the path being added.
200
kind = bzrlib.osutils.file_kind(abspath)
202
if not InventoryEntry.versionable_kind(kind):
203
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
206
if parent_ie is not None:
207
versioned = directory.base_path in parent_ie.children
209
# without the parent ie, use the relatively slower inventory
211
versioned = inv.has_filename(directory.raw_path)
213
if kind == 'directory':
215
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
217
except NotBranchError:
219
except errors.UnsupportedFormatError:
224
if directory.raw_path == '':
225
# mutter("tree root doesn't need to be added")
229
# mutter("%r is already versioned", abspath)
231
mutter("%r is a nested bzr tree", abspath)
233
__add_one(tree, inv, parent_ie, directory, kind, action)
234
added.append(directory.raw_path)
236
if kind == 'directory' and not sub_tree:
237
if parent_ie is not None:
239
this_ie = parent_ie.children[directory.base_path]
241
# without the parent ie, use the relatively slower inventory
243
this_id = inv.path2id(directory.raw_path)
247
this_ie = inv[this_id]
249
for subf in os.listdir(abspath):
250
# here we could use TreeDirectory rather than
251
# string concatenation.
252
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
253
# TODO: is_control_filename is very slow. Make it faster.
254
# TreeDirectory.is_control_filename could also make this
255
# faster - its impossible for a non root dir to have a
257
if tree.is_control_filename(subp):
258
mutter("skip control directory %r", subp)
259
elif subf in this_ie.children:
260
# recurse into this already versioned subdir.
261
dirs_to_add.append((FastPath(subp, subf), this_ie))
263
# user selection overrides ignoes
264
# ignore while selecting files - if we globbed in the
265
# outer loop we would ignore user files.
266
ignore_glob = tree.is_ignored(subp)
267
if ignore_glob is not None:
268
# mutter("skip ignored sub-file %r", subp)
269
if ignore_glob not in ignored:
270
ignored[ignore_glob] = []
271
ignored[ignore_glob].append(subp)
273
#mutter("queue to add sub-file %r", subp)
274
dirs_to_add.append((FastPath(subp, subf), this_ie))
276
if len(added) > 0 and save:
277
tree._write_inventory(inv)
278
return added, ignored
281
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
282
"""Add a new entry to the inventory and automatically add unversioned parents.
284
:param inv: Inventory which will receive the new entry.
285
:param parent_ie: Parent inventory entry if known, or None. If
286
None, the parent is looked up by name and used if present, otherwise
287
it is recursively added.
288
:param kind: Kind of new entry (file, directory, etc)
289
:param action: callback(inv, parent_ie, path, kind); return ignored.
290
:returns: A list of paths which have been added.
292
# Nothing to do if path is already versioned.
293
# This is safe from infinite recursion because the tree root is
295
if parent_ie is not None:
296
# we have a parent ie already
299
# slower but does not need parent_ie
300
if inv.has_filename(path.raw_path):
302
# its really not there : add the parent
303
# note that the dirname use leads to some extra str copying etc but as
304
# there are a limited number of dirs we can be nested under, it should
305
# generally find it very fast and not recurse after that.
306
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
307
parent_id = inv.path2id(dirname(path.raw_path))
308
parent_ie = inv[parent_id]
309
__add_one(tree, inv, parent_ie, path, kind, action)
310
return added + [path.raw_path]
313
def __add_one(tree, inv, parent_ie, path, kind, action):
314
"""Add a new entry to the inventory.
316
:param inv: Inventory which will receive the new entry.
317
:param parent_ie: Parent inventory entry.
318
:param kind: Kind of new entry (file, directory, etc)
319
:param action: callback(inv, parent_ie, path, kind); return ignored.
322
action(inv, parent_ie, path, kind)
323
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id)
added
removed
bzrlib/add.py
