13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Helper functions for adding files to working trees."""
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from os.path import dirname
23
22
import bzrlib.bzrdir
24
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
25
27
import bzrlib.osutils
26
from bzrlib.symbol_versioning import *
27
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)
30
58
class AddAction(object):
31
59
"""A class which defines what action to take when adding a file."""
33
61
def __init__(self, to_file=None, should_print=None):
34
"""Initialize an action which prints added files to an output stream.
36
:param to_file: The stream to write into. This is expected to take
37
Unicode paths. If not supplied, it will default to ``sys.stdout``.
38
:param should_print: If False, printing will be suppressed.
40
62
self._to_file = to_file
41
63
if to_file is None:
42
64
self._to_file = sys.stdout
110
132
add_action_null = add_action_add
111
133
add_action_add_and_print = AddAction(should_print=True)
112
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
tree.lock_tree_write()
174
return _smart_add_tree(tree=tree, file_list=file_list, recurse=recurse,
175
action=action, save=save)
179
def _smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
180
"""Add files to version, optionally recursing into directories.
182
This is designed more towards DWIM for humans than API simplicity.
183
For the specific behaviour see the help for cmd_add().
185
This calls reporter with each (path, kind, file_id) of added files.
187
Returns the number of files added.
189
:param save: Save the inventory after completing the adds. If False this
190
provides dry-run functionality by doing the add and not saving the
191
inventory. Note that the modified inventory is left in place, allowing
192
further dry-run tasks to take place. To restore the original inventory
193
call tree.read_working_inventory().
195
assert isinstance(recurse, bool)
199
prepared_list = _prepare_file_list(file_list)
200
mutter("smart add of %r, originally %r", prepared_list, file_list)
201
inv = tree.read_working_inventory()
207
# validate user file paths and convert all paths to tree
208
# relative : its cheaper to make a tree relative path an abspath
209
# than to convert an abspath to tree relative.
210
for filepath in prepared_list:
211
rf = FastPath(tree.relpath(filepath))
212
# validate user parameters. Our recursive code avoids adding new files
213
# that need such validation
214
if tree.is_control_filename(rf.raw_path):
215
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
217
abspath = tree.abspath(rf.raw_path)
218
kind = bzrlib.osutils.file_kind(abspath)
219
if kind == 'directory':
220
# schedule the dir for scanning
223
if not InventoryEntry.versionable_kind(kind):
224
raise errors.BadFileKindError(filename=abspath, kind=kind)
225
# ensure the named path is added, so that ignore rules in the later directory
227
# we dont have a parent ie known yet.: use the relatively slower inventory
229
versioned = inv.has_filename(rf.raw_path)
232
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
235
# no need to walk any directories at all.
236
if len(added) > 0 and save:
237
tree._write_inventory(inv)
238
return added, ignored
240
# only walk the minimal parents needed: we have user_dirs to override
244
is_inside = bzrlib.osutils.is_inside_or_parent_of_any
245
for path in sorted(user_dirs):
246
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
247
dirs_to_add.append((path, None))
248
prev_dir = path.raw_path
250
# this will eventually be *just* directories, right now it starts off with
252
for directory, parent_ie in dirs_to_add:
253
# directory is tree-relative
254
abspath = tree.abspath(directory.raw_path)
256
# get the contents of this directory.
258
# find the kind of the path being added.
259
kind = bzrlib.osutils.file_kind(abspath)
261
if not InventoryEntry.versionable_kind(kind):
262
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
265
if parent_ie is not None:
266
versioned = directory.base_path in parent_ie.children
268
# without the parent ie, use the relatively slower inventory
270
versioned = inv.has_filename(directory.raw_path)
272
if kind == 'directory':
274
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
276
except NotBranchError:
278
except errors.UnsupportedFormatError:
283
if directory.raw_path == '':
284
# mutter("tree root doesn't need to be added")
288
# mutter("%r is already versioned", abspath)
290
# XXX: This is wrong; people *might* reasonably be trying to add
291
# subtrees as subtrees. This should probably only be done in formats
292
# which can represent subtrees, and even then perhaps only when
293
# the user asked to add subtrees. At the moment you can add them
294
# specially through 'join --reference', which is perhaps
295
# reasonable: adding a new reference is a special operation and
296
# can have a special behaviour. mbp 20070306
297
mutter("%r is a nested bzr tree", abspath)
299
__add_one(tree, inv, parent_ie, directory, kind, action)
300
added.append(directory.raw_path)
302
if kind == 'directory' and not sub_tree:
303
if parent_ie is not None:
305
this_ie = parent_ie.children[directory.base_path]
307
# without the parent ie, use the relatively slower inventory
309
this_id = inv.path2id(directory.raw_path)
313
this_ie = inv[this_id]
315
for subf in sorted(os.listdir(abspath)):
316
# here we could use TreeDirectory rather than
317
# string concatenation.
318
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
319
# TODO: is_control_filename is very slow. Make it faster.
320
# TreeDirectory.is_control_filename could also make this
321
# faster - its impossible for a non root dir to have a
323
if tree.is_control_filename(subp):
324
mutter("skip control directory %r", subp)
325
elif subf in this_ie.children:
326
# recurse into this already versioned subdir.
327
dirs_to_add.append((FastPath(subp, subf), this_ie))
329
# user selection overrides ignoes
330
# ignore while selecting files - if we globbed in the
331
# outer loop we would ignore user files.
332
ignore_glob = tree.is_ignored(subp)
333
if ignore_glob is not None:
334
# mutter("skip ignored sub-file %r", subp)
335
ignored.setdefault(ignore_glob, []).append(subp)
337
#mutter("queue to add sub-file %r", subp)
338
dirs_to_add.append((FastPath(subp, subf), this_ie))
340
if len(added) > 0 and save:
341
tree._write_inventory(inv)
342
return added, ignored
345
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
346
"""Add a new entry to the inventory and automatically add unversioned parents.
348
:param inv: Inventory which will receive the new entry.
349
:param parent_ie: Parent inventory entry if known, or None. If
350
None, the parent is looked up by name and used if present, otherwise
351
it is recursively added.
352
:param kind: Kind of new entry (file, directory, etc)
353
:param action: callback(inv, parent_ie, path, kind); return ignored.
354
:returns: A list of paths which have been added.
356
# Nothing to do if path is already versioned.
357
# This is safe from infinite recursion because the tree root is
359
if parent_ie is not None:
360
# we have a parent ie already
363
# slower but does not need parent_ie
364
if inv.has_filename(path.raw_path):
366
# its really not there : add the parent
367
# note that the dirname use leads to some extra str copying etc but as
368
# there are a limited number of dirs we can be nested under, it should
369
# generally find it very fast and not recurse after that.
370
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
371
parent_id = inv.path2id(dirname(path.raw_path))
372
parent_ie = inv[parent_id]
373
__add_one(tree, inv, parent_ie, path, kind, action)
374
return added + [path.raw_path]
377
def __add_one(tree, inv, parent_ie, path, kind, action):
378
"""Add a new entry to the inventory.
380
:param inv: Inventory which will receive the new entry.
381
:param parent_ie: Parent inventory entry.
382
:param kind: Kind of new entry (file, directory, etc)
383
:param action: callback(inv, parent_ie, path, kind); return a file_id
384
or None to generate a new file id
387
file_id = action(inv, parent_ie, path, kind)
388
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/add.py
