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
22
import bzrlib.errors as errors
23
from bzrlib.inventory import InventoryEntry
24
from bzrlib.trace import mutter, note, warning
25
from bzrlib.errors import NotBranchError
27
from bzrlib.workingtree import WorkingTree
30
def glob_expand_for_win32(file_list):
34
expanded_file_list = []
35
for possible_glob in file_list:
36
glob_files = glob.glob(possible_glob)
39
# special case to let the normal code path handle
40
# files that do not exists
41
expanded_file_list.append(possible_glob)
43
expanded_file_list += glob_files
44
return expanded_file_list
47
def _prepare_file_list(file_list):
48
"""Prepare a file list for use by smart_add_*."""
49
if sys.platform == 'win32':
50
file_list = glob_expand_for_win32(file_list)
53
file_list = list(file_list)
57
class AddAction(object):
58
"""A class which defines what action to take when adding a file."""
60
def __init__(self, to_file=None, should_print=None):
61
self._to_file = to_file
63
self._to_file = sys.stdout
64
self.should_print = False
65
if should_print is not None:
66
self.should_print = should_print
68
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
69
"""Add path to inventory.
71
The default action does nothing.
73
:param inv: The inventory we are working with.
74
:param path: The FastPath being added
75
:param kind: The kind of the object being added.
77
if not self.should_print:
79
self._to_file.write('added %s\n' % _quote(path.raw_path))
82
# TODO: jam 20050105 These could be used for compatibility
83
# however, they bind against the current stdout, not the
84
# one which exists at the time they are called, so they
85
# don't work for the test suite.
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):
94
"""Add files to version, optionally recursing into directories.
96
This is designed more towards DWIM for humans than API simplicity.
97
For the specific behaviour see the help for cmd_add().
99
Returns the number of files added.
100
Please see smart_add_tree for more detail.
102
file_list = _prepare_file_list(file_list)
103
tree = WorkingTree.open_containing(file_list[0])[0]
104
return smart_add_tree(tree, file_list, recurse, action=action)
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):
128
"""Add files to version, optionally recursing into directories.
130
This is designed more towards DWIM for humans than API simplicity.
131
For the specific behaviour see the help for cmd_add().
133
This calls reporter with each (path, kind, file_id) of added files.
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().
143
assert isinstance(recurse, bool)
147
prepared_list = _prepare_file_list(file_list)
148
mutter("smart add of %r, originally %r", prepared_list, file_list)
149
inv = tree.read_working_inventory()
155
# validate user file paths and convert all paths to tree
156
# relative : its cheaper to make a tree relative path an abspath
157
# than to convert an abspath to tree relative.
158
for filepath in prepared_list:
159
rf = FastPath(tree.relpath(filepath))
160
# validate user parameters. Our recursive code avoids adding new files
161
# that need such validation
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)
209
if not InventoryEntry.versionable_kind(kind):
210
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
213
if parent_ie is not None:
214
versioned = directory.base_path in parent_ie.children
216
# without the parent ie, use the relatively slower inventory
218
versioned = inv.has_filename(directory.raw_path)
220
if kind == 'directory':
222
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
224
except NotBranchError:
226
except errors.UnsupportedFormatError:
231
if directory.raw_path == '':
232
# mutter("tree root doesn't need to be added")
236
# mutter("%r is already versioned", abspath)
238
mutter("%r is a nested bzr tree", abspath)
240
__add_one(tree, inv, parent_ie, directory, kind, action)
241
added.append(directory.raw_path)
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)
254
this_ie = inv[this_id]
256
for subf in os.listdir(abspath):
257
# here we could use TreeDirectory rather than
258
# string concatenation.
259
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
260
# TODO: is_control_filename is very slow. Make it faster.
261
# TreeDirectory.is_control_filename could also make this
262
# faster - its impossible for a non root dir to have a
264
if tree.is_control_filename(subp):
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
271
# ignore while selecting files - if we globbed in the
272
# outer loop we would ignore user files.
273
ignore_glob = tree.is_ignored(subp)
274
if ignore_glob is not None:
275
# mutter("skip ignored sub-file %r", subp)
276
ignored.setdefault(ignore_glob, []).append(subp)
278
#mutter("queue to add sub-file %r", subp)
279
dirs_to_add.append((FastPath(subp, subf), this_ie))
281
if len(added) > 0 and save:
282
tree._write_inventory(inv)
283
return added, ignored
286
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
287
"""Add a new entry to the inventory and automatically add unversioned parents.
289
:param inv: Inventory which will receive the new entry.
290
:param parent_ie: Parent inventory entry if known, or None. If
291
None, the parent is looked up by name and used if present, otherwise
292
it is recursively added.
293
:param kind: Kind of new entry (file, directory, etc)
294
:param action: callback(inv, parent_ie, path, kind); return ignored.
295
:returns: A list of paths which have been added.
297
# Nothing to do if path is already versioned.
298
# This is safe from infinite recursion because the tree root is
300
if parent_ie is not None:
301
# we have a parent ie already
304
# slower but does not need parent_ie
305
if inv.has_filename(path.raw_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.
327
action(inv, parent_ie, path, kind)
328
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id)
added
removed
bzrlib/add.py
