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.
78
self._to_file.write('added %s\n' % _quote(path.raw_path))
82
class AddFromBaseAction(AddAction):
83
"""This class will try to extract file ids from another tree."""
85
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
86
super(AddFromBaseAction, self).__init__(to_file=to_file,
87
should_print=should_print)
88
self.base_tree = base_tree
89
self.base_path = base_path
91
def __call__(self, inv, parent_ie, path, kind):
92
# Place the parent call
93
# Now check to see if we can extract an id for this file
94
file_id, base_path = self._get_base_file_id(path, parent_ie)
95
if file_id is not None:
97
self._to_file.write('added %s w/ file id from %s\n'
98
% (path.raw_path, base_path))
100
# we aren't doing anything special, so let the default
102
file_id = super(AddFromBaseAction, self).__call__(
103
inv, parent_ie, path, kind)
106
def _get_base_file_id(self, path, parent_ie):
107
"""Look for a file id in the base branch.
109
First, if the base tree has the parent directory,
110
we look for a file with the same name in that directory.
111
Else, we look for an entry in the base tree with the same path.
114
if (parent_ie.file_id in self.base_tree):
115
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
116
base_child_ie = base_parent_ie.children.get(path.base_path)
117
if base_child_ie is not None:
118
return (base_child_ie.file_id,
119
self.base_tree.id2path(base_child_ie.file_id))
120
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
121
# This may return None, but it is our last attempt
122
return self.base_tree.path2id(full_base_path), full_base_path
125
# TODO: jam 20050105 These could be used for compatibility
126
# however, they bind against the current stdout, not the
127
# one which exists at the time they are called, so they
128
# don't work for the test suite.
130
add_action_add = AddAction()
131
add_action_null = add_action_add
132
add_action_add_and_print = AddAction(should_print=True)
133
add_action_print = add_action_add_and_print
136
def smart_add(file_list, recurse=True, action=None, save=True):
137
"""Add files to version, optionally recursing into directories.
139
This is designed more towards DWIM for humans than API simplicity.
140
For the specific behaviour see the help for cmd_add().
142
Returns the number of files added.
143
Please see smart_add_tree for more detail.
145
file_list = _prepare_file_list(file_list)
146
tree = WorkingTree.open_containing(file_list[0])[0]
147
return smart_add_tree(tree, file_list, recurse, action=action, save=save)
150
class FastPath(object):
151
"""A path object with fast accessors for things like basename."""
153
__slots__ = ['raw_path', 'base_path']
155
def __init__(self, path, base_path=None):
156
"""Construct a FastPath from path."""
157
if base_path is None:
158
self.base_path = bzrlib.osutils.basename(path)
160
self.base_path = base_path
163
def __cmp__(self, other):
164
return cmp(self.raw_path, other.raw_path)
167
return hash(self.raw_path)
170
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
171
"""Add files to version, optionally recursing into directories.
173
This is designed more towards DWIM for humans than API simplicity.
174
For the specific behaviour see the help for cmd_add().
176
This calls reporter with each (path, kind, file_id) of added files.
178
Returns the number of files added.
180
:param save: Save the inventory after completing the adds. If False this
181
provides dry-run functionality by doing the add and not saving the
182
inventory. Note that the modified inventory is left in place, allowing
183
further dry-run tasks to take place. To restore the original inventory
184
call tree.read_working_inventory().
186
assert isinstance(recurse, bool)
190
prepared_list = _prepare_file_list(file_list)
191
mutter("smart add of %r, originally %r", prepared_list, file_list)
192
inv = tree.read_working_inventory()
198
# validate user file paths and convert all paths to tree
199
# relative : its cheaper to make a tree relative path an abspath
200
# than to convert an abspath to tree relative.
201
for filepath in prepared_list:
202
rf = FastPath(tree.relpath(filepath))
203
# validate user parameters. Our recursive code avoids adding new files
204
# that need such validation
205
if tree.is_control_filename(rf.raw_path):
206
raise errors.ForbiddenControlFileError(filename=rf)
208
abspath = tree.abspath(rf.raw_path)
209
kind = bzrlib.osutils.file_kind(abspath)
210
if kind == 'directory':
211
# schedule the dir for scanning
214
if not InventoryEntry.versionable_kind(kind):
215
raise errors.BadFileKindError(filename=abspath, kind=kind)
216
# ensure the named path is added, so that ignore rules in the later directory
218
# we dont have a parent ie known yet.: use the relatively slower inventory
220
versioned = inv.has_filename(rf.raw_path)
223
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
226
# no need to walk any directories at all.
227
if len(added) > 0 and save:
228
tree._write_inventory(inv)
229
return added, ignored
231
# only walk the minimal parents needed: we have user_dirs to override
235
is_inside = bzrlib.osutils.is_inside_or_parent_of_any
236
for path in sorted(user_dirs):
237
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
238
dirs_to_add.append((path, None))
239
prev_dir = path.raw_path
241
# this will eventually be *just* directories, right now it starts off with
243
for directory, parent_ie in dirs_to_add:
244
# directory is tree-relative
245
abspath = tree.abspath(directory.raw_path)
247
# get the contents of this directory.
249
# find the kind of the path being added.
250
kind = bzrlib.osutils.file_kind(abspath)
252
if not InventoryEntry.versionable_kind(kind):
253
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
256
if parent_ie is not None:
257
versioned = directory.base_path in parent_ie.children
259
# without the parent ie, use the relatively slower inventory
261
versioned = inv.has_filename(directory.raw_path)
263
if kind == 'directory':
265
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
267
except NotBranchError:
269
except errors.UnsupportedFormatError:
274
if directory.raw_path == '':
275
# mutter("tree root doesn't need to be added")
279
# mutter("%r is already versioned", abspath)
281
mutter("%r is a nested bzr tree", abspath)
283
__add_one(tree, inv, parent_ie, directory, kind, action)
284
added.append(directory.raw_path)
286
if kind == 'directory' and not sub_tree:
287
if parent_ie is not None:
289
this_ie = parent_ie.children[directory.base_path]
291
# without the parent ie, use the relatively slower inventory
293
this_id = inv.path2id(directory.raw_path)
297
this_ie = inv[this_id]
299
for subf in os.listdir(abspath):
300
# here we could use TreeDirectory rather than
301
# string concatenation.
302
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
303
# TODO: is_control_filename is very slow. Make it faster.
304
# TreeDirectory.is_control_filename could also make this
305
# faster - its impossible for a non root dir to have a
307
if tree.is_control_filename(subp):
308
mutter("skip control directory %r", subp)
309
elif subf in this_ie.children:
310
# recurse into this already versioned subdir.
311
dirs_to_add.append((FastPath(subp, subf), this_ie))
313
# user selection overrides ignoes
314
# ignore while selecting files - if we globbed in the
315
# outer loop we would ignore user files.
316
ignore_glob = tree.is_ignored(subp)
317
if ignore_glob is not None:
318
# mutter("skip ignored sub-file %r", subp)
319
ignored.setdefault(ignore_glob, []).append(subp)
321
#mutter("queue to add sub-file %r", subp)
322
dirs_to_add.append((FastPath(subp, subf), this_ie))
324
if len(added) > 0 and save:
325
tree._write_inventory(inv)
326
return added, ignored
329
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
330
"""Add a new entry to the inventory and automatically add unversioned parents.
332
:param inv: Inventory which will receive the new entry.
333
:param parent_ie: Parent inventory entry if known, or None. If
334
None, the parent is looked up by name and used if present, otherwise
335
it is recursively added.
336
:param kind: Kind of new entry (file, directory, etc)
337
:param action: callback(inv, parent_ie, path, kind); return ignored.
338
:returns: A list of paths which have been added.
340
# Nothing to do if path is already versioned.
341
# This is safe from infinite recursion because the tree root is
343
if parent_ie is not None:
344
# we have a parent ie already
347
# slower but does not need parent_ie
348
if inv.has_filename(path.raw_path):
350
# its really not there : add the parent
351
# note that the dirname use leads to some extra str copying etc but as
352
# there are a limited number of dirs we can be nested under, it should
353
# generally find it very fast and not recurse after that.
354
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
355
parent_id = inv.path2id(dirname(path.raw_path))
356
parent_ie = inv[parent_id]
357
__add_one(tree, inv, parent_ie, path, kind, action)
358
return added + [path.raw_path]
361
def __add_one(tree, inv, parent_ie, path, kind, action):
362
"""Add a new entry to the inventory.
364
:param inv: Inventory which will receive the new entry.
365
:param parent_ie: Parent inventory entry.
366
:param kind: Kind of new entry (file, directory, etc)
367
:param action: callback(inv, parent_ie, path, kind); return a file_id
368
or None to generate a new file id
371
file_id = action(inv, parent_ie, path, kind)
372
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/add.py
