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
17
"""Helper functions for adding files to working trees."""
21
from os.path import dirname
25
import bzrlib.errors as errors
26
from bzrlib.inventory import InventoryEntry
27
from bzrlib.trace import mutter, note, warning
28
from bzrlib.errors import NotBranchError
30
from bzrlib.workingtree import WorkingTree
33
def glob_expand_for_win32(file_list):
34
"""Replacement for glob expansion by the shell.
36
Win32's cmd.exe does not do glob expansion (eg ``*.py``), so we do our own
39
:param file_list: A list of filenames which may include shell globs.
40
:return: An expanded list of filenames.
45
expanded_file_list = []
46
for possible_glob in file_list:
47
glob_files = glob.glob(possible_glob)
50
# special case to let the normal code path handle
51
# files that do not exists
52
expanded_file_list.append(possible_glob)
54
expanded_file_list += glob_files
55
return expanded_file_list
58
def _prepare_file_list(file_list):
59
"""Prepare a file list for use by smart_add_*."""
60
if sys.platform == 'win32':
61
file_list = glob_expand_for_win32(file_list)
64
file_list = list(file_list)
68
class AddAction(object):
69
"""A class which defines what action to take when adding a file."""
71
def __init__(self, to_file=None, should_print=None):
72
"""Initialize an action which prints added files to an output stream.
74
:param to_file: The stream to write into. This is expected to take
75
Unicode paths. If not supplied, it will default to ``sys.stdout``.
76
:param should_print: If False, printing will be supressed.
78
self._to_file = to_file
80
self._to_file = sys.stdout
81
self.should_print = False
82
if should_print is not None:
83
self.should_print = should_print
85
def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
86
"""Add path to inventory.
88
The default action does nothing.
90
:param inv: The inventory we are working with.
91
:param path: The FastPath being added
92
:param kind: The kind of the object being added.
95
self._to_file.write('added %s\n' % _quote(path.raw_path))
99
class AddFromBaseAction(AddAction):
100
"""This class will try to extract file ids from another tree."""
102
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
103
super(AddFromBaseAction, self).__init__(to_file=to_file,
104
should_print=should_print)
105
self.base_tree = base_tree
106
self.base_path = base_path
108
def __call__(self, inv, parent_ie, path, kind):
109
# Place the parent call
110
# Now check to see if we can extract an id for this file
111
file_id, base_path = self._get_base_file_id(path, parent_ie)
112
if file_id is not None:
113
if self.should_print:
114
self._to_file.write('added %s w/ file id from %s\n'
115
% (path.raw_path, base_path))
117
# we aren't doing anything special, so let the default
119
file_id = super(AddFromBaseAction, self).__call__(
120
inv, parent_ie, path, kind)
123
def _get_base_file_id(self, path, parent_ie):
124
"""Look for a file id in the base branch.
126
First, if the base tree has the parent directory,
127
we look for a file with the same name in that directory.
128
Else, we look for an entry in the base tree with the same path.
131
if (parent_ie.file_id in self.base_tree):
132
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
133
base_child_ie = base_parent_ie.children.get(path.base_path)
134
if base_child_ie is not None:
135
return (base_child_ie.file_id,
136
self.base_tree.id2path(base_child_ie.file_id))
137
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
138
# This may return None, but it is our last attempt
139
return self.base_tree.path2id(full_base_path), full_base_path
142
# TODO: jam 20050105 These could be used for compatibility
143
# however, they bind against the current stdout, not the
144
# one which exists at the time they are called, so they
145
# don't work for the test suite.
147
add_action_add = AddAction()
148
add_action_null = add_action_add
149
add_action_add_and_print = AddAction(should_print=True)
150
add_action_print = add_action_add_and_print
153
def smart_add(file_list, recurse=True, action=None, save=True):
154
"""Add files to version, optionally recursing into directories.
156
This is designed more towards DWIM for humans than API simplicity.
157
For the specific behaviour see the help for cmd_add().
159
Returns the number of files added.
160
Please see smart_add_tree for more detail.
162
file_list = _prepare_file_list(file_list)
163
tree = WorkingTree.open_containing(file_list[0])[0]
164
return smart_add_tree(tree, file_list, recurse, action=action, save=save)
167
class FastPath(object):
168
"""A path object with fast accessors for things like basename."""
170
__slots__ = ['raw_path', 'base_path']
172
def __init__(self, path, base_path=None):
173
"""Construct a FastPath from path."""
174
if base_path is None:
175
self.base_path = bzrlib.osutils.basename(path)
177
self.base_path = base_path
180
def __cmp__(self, other):
181
return cmp(self.raw_path, other.raw_path)
184
return hash(self.raw_path)
187
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
188
"""Add files to version, optionally recursing into directories.
190
This is designed more towards DWIM for humans than API simplicity.
191
For the specific behaviour see the help for cmd_add().
193
This calls reporter with each (path, kind, file_id) of added files.
195
Returns the number of files added.
197
:param save: Save the inventory after completing the adds. If False this
198
provides dry-run functionality by doing the add and not saving the
199
inventory. Note that the modified inventory is left in place, allowing
200
further dry-run tasks to take place. To restore the original inventory
201
call tree.read_working_inventory().
203
tree.lock_tree_write()
205
return _smart_add_tree(tree=tree, file_list=file_list, recurse=recurse,
206
action=action, save=save)
211
def _smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
212
"""Helper for smart_add_tree.
214
The tree should be locked before entering this function. See smart_add_tree
215
for parameter definitions.
217
assert isinstance(recurse, bool)
221
prepared_list = _prepare_file_list(file_list)
222
mutter("smart add of %r, originally %r", prepared_list, file_list)
223
inv = tree.read_working_inventory()
229
# validate user file paths and convert all paths to tree
230
# relative : its cheaper to make a tree relative path an abspath
231
# than to convert an abspath to tree relative.
232
for filepath in prepared_list:
233
rf = FastPath(tree.relpath(filepath))
234
# validate user parameters. Our recursive code avoids adding new files
235
# that need such validation
236
if tree.is_control_filename(rf.raw_path):
237
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
239
abspath = tree.abspath(rf.raw_path)
240
kind = bzrlib.osutils.file_kind(abspath)
241
if kind == 'directory':
242
# schedule the dir for scanning
245
if not InventoryEntry.versionable_kind(kind):
246
raise errors.BadFileKindError(filename=abspath, kind=kind)
247
# ensure the named path is added, so that ignore rules in the later directory
249
# we dont have a parent ie known yet.: use the relatively slower inventory
251
versioned = inv.has_filename(rf.raw_path)
254
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
257
# no need to walk any directories at all.
258
if len(added) > 0 and save:
259
tree._write_inventory(inv)
260
return added, ignored
262
# only walk the minimal parents needed: we have user_dirs to override
266
is_inside = bzrlib.osutils.is_inside_or_parent_of_any
267
for path in sorted(user_dirs):
268
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
269
dirs_to_add.append((path, None))
270
prev_dir = path.raw_path
272
# this will eventually be *just* directories, right now it starts off with
274
for directory, parent_ie in dirs_to_add:
275
# directory is tree-relative
276
abspath = tree.abspath(directory.raw_path)
278
# get the contents of this directory.
280
# find the kind of the path being added.
281
kind = bzrlib.osutils.file_kind(abspath)
283
if not InventoryEntry.versionable_kind(kind):
284
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
287
if parent_ie is not None:
288
versioned = directory.base_path in parent_ie.children
290
# without the parent ie, use the relatively slower inventory
292
versioned = inv.has_filename(directory.raw_path)
294
if kind == 'directory':
296
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
298
except NotBranchError:
300
except errors.UnsupportedFormatError:
305
if directory.raw_path == '':
306
# mutter("tree root doesn't need to be added")
310
# mutter("%r is already versioned", abspath)
312
# XXX: This is wrong; people *might* reasonably be trying to add
313
# subtrees as subtrees. This should probably only be done in formats
314
# which can represent subtrees, and even then perhaps only when
315
# the user asked to add subtrees. At the moment you can add them
316
# specially through 'join --reference', which is perhaps
317
# reasonable: adding a new reference is a special operation and
318
# can have a special behaviour. mbp 20070306
319
mutter("%r is a nested bzr tree", abspath)
321
__add_one(tree, inv, parent_ie, directory, kind, action)
322
added.append(directory.raw_path)
324
if kind == 'directory' and not sub_tree:
325
if parent_ie is not None:
327
this_ie = parent_ie.children[directory.base_path]
329
# without the parent ie, use the relatively slower inventory
331
this_id = inv.path2id(directory.raw_path)
335
this_ie = inv[this_id]
337
for subf in sorted(os.listdir(abspath)):
338
# here we could use TreeDirectory rather than
339
# string concatenation.
340
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
341
# TODO: is_control_filename is very slow. Make it faster.
342
# TreeDirectory.is_control_filename could also make this
343
# faster - its impossible for a non root dir to have a
345
if tree.is_control_filename(subp):
346
mutter("skip control directory %r", subp)
347
elif subf in this_ie.children:
348
# recurse into this already versioned subdir.
349
dirs_to_add.append((FastPath(subp, subf), this_ie))
351
# user selection overrides ignoes
352
# ignore while selecting files - if we globbed in the
353
# outer loop we would ignore user files.
354
ignore_glob = tree.is_ignored(subp)
355
if ignore_glob is not None:
356
# mutter("skip ignored sub-file %r", subp)
357
ignored.setdefault(ignore_glob, []).append(subp)
359
#mutter("queue to add sub-file %r", subp)
360
dirs_to_add.append((FastPath(subp, subf), this_ie))
362
if len(added) > 0 and save:
363
tree._write_inventory(inv)
364
return added, ignored
367
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
368
"""Add a new entry to the inventory and automatically add unversioned parents.
370
:param inv: Inventory which will receive the new entry.
371
:param parent_ie: Parent inventory entry if known, or None. If
372
None, the parent is looked up by name and used if present, otherwise it
373
is recursively added.
374
:param kind: Kind of new entry (file, directory, etc)
375
:param action: callback(inv, parent_ie, path, kind); return ignored.
376
:return: A list of paths which have been added.
378
# Nothing to do if path is already versioned.
379
# This is safe from infinite recursion because the tree root is
381
if parent_ie is not None:
382
# we have a parent ie already
385
# slower but does not need parent_ie
386
if inv.has_filename(path.raw_path):
388
# its really not there : add the parent
389
# note that the dirname use leads to some extra str copying etc but as
390
# there are a limited number of dirs we can be nested under, it should
391
# generally find it very fast and not recurse after that.
392
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
393
parent_id = inv.path2id(dirname(path.raw_path))
394
parent_ie = inv[parent_id]
395
__add_one(tree, inv, parent_ie, path, kind, action)
396
return added + [path.raw_path]
399
def __add_one(tree, inv, parent_ie, path, kind, action):
400
"""Add a new entry to the inventory.
402
:param inv: Inventory which will receive the new entry.
403
:param parent_ie: Parent inventory entry.
404
:param kind: Kind of new entry (file, directory, etc)
405
:param action: callback(inv, parent_ie, path, kind); return a file_id
406
or None to generate a new file id
409
file_id = action(inv, parent_ie, path, kind)
410
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/add.py
