1
# Copyright (C) 2006, 2007 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
"""MutableTree object.
19
See MutableTree for more details.
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
32
from bzrlib.osutils import dirname
33
from bzrlib.revisiontree import RevisionTree
34
from bzrlib.trace import mutter, warning
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.osutils import splitpath
44
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
47
def needs_tree_write_lock(unbound):
48
"""Decorate unbound to take out and release a tree_write lock."""
49
def tree_write_locked(self, *args, **kwargs):
50
self.lock_tree_write()
52
return unbound(self, *args, **kwargs)
55
tree_write_locked.__doc__ = unbound.__doc__
56
tree_write_locked.__name__ = unbound.__name__
57
return tree_write_locked
60
class MutableTree(tree.Tree):
61
"""A MutableTree is a specialisation of Tree which is able to be mutated.
63
Generally speaking these mutations are only possible within a lock_write
64
context, and will revert if the lock is broken abnormally - but this cannot
65
be guaranteed - depending on the exact implementation of the mutable state.
67
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
68
For tests we also have MemoryTree which is a MutableTree whose contents are
71
For now, we are not treating MutableTree as an interface to provide
72
conformance tests for - rather we are testing MemoryTree specifically, and
73
interface testing implementations of WorkingTree.
75
A mutable tree always has an associated Branch and BzrDir object - the
76
branch and bzrdir attributes.
78
def __init__(self, *args, **kw):
79
super(MutableTree, self).__init__(*args, **kw)
80
# Is this tree on a case-insensitive or case-preserving file-system?
81
# Sub-classes may initialize to False if they detect they are being
82
# used on media which doesn't differentiate the case of names.
83
self.case_sensitive = True
85
@needs_tree_write_lock
86
def add(self, files, ids=None, kinds=None):
87
"""Add paths to the set of versioned paths.
89
Note that the command line normally calls smart_add instead,
90
which can automatically recurse.
92
This adds the files to the inventory, so that they will be
93
recorded by the next commit.
95
:param files: List of paths to add, relative to the base of the tree.
96
:param ids: If set, use these instead of automatically generated ids.
97
Must be the same length as the list of files, but may
98
contain None for ids that are to be autogenerated.
99
:param kinds: Optional parameter to specify the kinds to be used for
102
TODO: Perhaps callback with the ids and paths as they're added.
104
if isinstance(files, basestring):
105
# XXX: Passing a single string is inconsistent and should be
107
if not (ids is None or isinstance(ids, basestring)):
108
raise AssertionError()
109
if not (kinds is None or isinstance(kinds, basestring)):
110
raise AssertionError()
114
if kinds is not None:
117
files = [path.strip('/') for path in files]
120
ids = [None] * len(files)
122
if not (len(ids) == len(files)):
123
raise AssertionError()
125
kinds = [None] * len(files)
126
elif not len(kinds) == len(files):
127
raise AssertionError()
129
# generic constraint checks:
130
if self.is_control_filename(f):
131
raise errors.ForbiddenControlFileError(filename=f)
133
# fill out file kinds for all files [not needed when we stop
134
# caring about the instantaneous file kind within a uncommmitted tree
136
self._gather_kinds(files, kinds)
137
self._add(files, ids, kinds)
139
def add_reference(self, sub_tree):
140
"""Add a TreeReference to the tree, pointing at sub_tree"""
141
raise errors.UnsupportedOperation(self.add_reference, self)
143
def _add_reference(self, sub_tree):
144
"""Standard add_reference implementation, for use by subclasses"""
146
sub_tree_path = self.relpath(sub_tree.basedir)
147
except errors.PathNotChild:
148
raise errors.BadReferenceTarget(self, sub_tree,
149
'Target not inside tree.')
150
sub_tree_id = sub_tree.get_root_id()
151
if sub_tree_id == self.get_root_id():
152
raise errors.BadReferenceTarget(self, sub_tree,
153
'Trees have the same root id.')
154
if sub_tree_id in self.inventory:
155
raise errors.BadReferenceTarget(self, sub_tree,
156
'Root id already present in tree')
157
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
159
def _add(self, files, ids, kinds):
160
"""Helper function for add - updates the inventory.
162
:param files: sequence of pathnames, relative to the tree root
163
:param ids: sequence of suggested ids for the files (may be None)
164
:param kinds: sequence of inventory kinds of the files (i.e. may
165
contain "tree-reference")
167
raise NotImplementedError(self._add)
169
@needs_tree_write_lock
170
def apply_inventory_delta(self, changes):
171
"""Apply changes to the inventory as an atomic operation.
173
:param changes: An inventory delta to apply to the working tree's
176
:seealso Inventory.apply_delta: For details on the changes parameter.
180
inv.apply_delta(changes)
181
self._write_inventory(inv)
184
def commit(self, message=None, revprops=None, *args,
186
# avoid circular imports
187
from bzrlib import commit
190
possible_master_transports=[]
191
if not 'branch-nick' in revprops:
192
revprops['branch-nick'] = self.branch._get_nick(
193
kwargs.get('local', False),
194
possible_master_transports)
195
author = kwargs.pop('author', None)
196
if author is not None:
197
if 'author' in revprops:
198
# XXX: maybe we should just accept one of them?
199
raise AssertionError('author property given twice')
200
revprops['author'] = author
201
# args for wt.commit start at message from the Commit.commit method,
202
args = (message, ) + args
203
for hook in MutableTree.hooks['start_commit']:
205
committed_id = commit.Commit().commit(working_tree=self,
207
possible_master_transports=possible_master_transports,
211
def _gather_kinds(self, files, kinds):
212
"""Helper function for add - sets the entries of kinds."""
213
raise NotImplementedError(self._gather_kinds)
215
def get_file_with_stat(self, file_id, path=None):
216
"""Get a file handle and stat object for file_id.
218
The default implementation returns (self.get_file, None) for backwards
221
:param file_id: The file id to read.
222
:param path: The path of the file, if it is known.
223
:return: A tuple (file_handle, stat_value_or_None). If the tree has
224
no stat facility, or need for a stat cache feedback during commit,
225
it may return None for the second element of the tuple.
227
return (self.get_file(file_id, path), None)
230
def last_revision(self):
231
"""Return the revision id of the last commit performed in this tree.
233
In early tree formats the result of last_revision is the same as the
234
branch last_revision, but that is no longer the case for modern tree
237
last_revision returns the left most parent id, or None if there are no
240
last_revision was deprecated as of 0.11. Please use get_parent_ids
243
raise NotImplementedError(self.last_revision)
245
def lock_tree_write(self):
246
"""Lock the working tree for write, and the branch for read.
248
This is useful for operations which only need to mutate the working
249
tree. Taking out branch write locks is a relatively expensive process
250
and may fail if the branch is on read only media. So branch write locks
251
should only be taken out when we are modifying branch data - such as in
252
operations like commit, pull, uncommit and update.
254
raise NotImplementedError(self.lock_tree_write)
256
def lock_write(self):
257
"""Lock the tree and its branch. This allows mutating calls to be made.
259
Some mutating methods will take out implicit write locks, but in
260
general you should always obtain a write lock before calling mutating
263
raise NotImplementedError(self.lock_write)
266
def mkdir(self, path, file_id=None):
267
"""Create a directory in the tree. if file_id is None, one is assigned.
269
:param path: A unicode file path.
270
:param file_id: An optional file-id.
271
:return: the file id of the new directory.
273
raise NotImplementedError(self.mkdir)
275
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
276
"""Tell the tree we have observed a paths sha1.
278
The intent of this function is to allow trees that have a hashcache to
279
update the hashcache during commit. If the observed file is too new
280
(based on the stat_value) to be safely hash-cached the tree will ignore
283
The default implementation does nothing.
285
:param file_id: The file id
286
:param path: The file path
287
:param sha1: The sha 1 that was observed.
288
:param stat_value: A stat result for the file the sha1 was read from.
292
def _fix_case_of_inventory_path(self, path):
293
"""If our tree isn't case sensitive, return the canonical path"""
294
if not self.case_sensitive:
295
path = self.get_canonical_inventory_path(path)
299
def put_file_bytes_non_atomic(self, file_id, bytes):
300
"""Update the content of a file in the tree.
302
Note that the file is written in-place rather than being
303
written to a temporary location and renamed. As a consequence,
304
readers can potentially see the file half-written.
306
:param file_id: file-id of the file
307
:param bytes: the new file contents
309
raise NotImplementedError(self.put_file_bytes_non_atomic)
311
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
312
"""Set the parents ids of the working tree.
314
:param revision_ids: A list of revision_ids.
316
raise NotImplementedError(self.set_parent_ids)
318
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
319
"""Set the parents of the working tree.
321
:param parents_list: A list of (revision_id, tree) tuples.
322
If tree is None, then that element is treated as an unreachable
323
parent tree - i.e. a ghost.
325
raise NotImplementedError(self.set_parent_trees)
327
@needs_tree_write_lock
328
def smart_add(self, file_list, recurse=True, action=None, save=True):
329
"""Version file_list, optionally recursing into directories.
331
This is designed more towards DWIM for humans than API clarity.
332
For the specific behaviour see the help for cmd_add().
334
:param action: A reporter to be called with the inventory, parent_ie,
335
path and kind of the path being added. It may return a file_id if
336
a specific one should be used.
337
:param save: Save the inventory after completing the adds. If False
338
this provides dry-run functionality by doing the add and not saving
340
:return: A tuple - files_added, ignored_files. files_added is the count
341
of added files, and ignored_files is a dict mapping files that were
342
ignored to the rule that caused them to be ignored.
344
# not in an inner loop; and we want to remove direct use of this,
345
# so here as a reminder for now. RBC 20070703
346
from bzrlib.inventory import InventoryEntry
348
action = add.AddAction()
351
# no paths supplied: add the entire tree.
353
# mutter("smart add of %r")
360
# validate user file paths and convert all paths to tree
361
# relative : it's cheaper to make a tree relative path an abspath
362
# than to convert an abspath to tree relative, and it's cheaper to
363
# perform the canonicalization in bulk.
364
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
365
rf = _FastPath(filepath)
366
# validate user parameters. Our recursive code avoids adding new files
367
# that need such validation
368
if self.is_control_filename(rf.raw_path):
369
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
371
abspath = self.abspath(rf.raw_path)
372
kind = osutils.file_kind(abspath)
373
if kind == 'directory':
374
# schedule the dir for scanning
377
if not InventoryEntry.versionable_kind(kind):
378
raise errors.BadFileKindError(filename=abspath, kind=kind)
379
# ensure the named path is added, so that ignore rules in the later directory
381
# we dont have a parent ie known yet.: use the relatively slower inventory
383
versioned = inv.has_filename(rf.raw_path)
386
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
389
# no need to walk any directories at all.
390
if len(added) > 0 and save:
391
self._write_inventory(inv)
392
return added, ignored
394
# only walk the minimal parents needed: we have user_dirs to override
398
is_inside = osutils.is_inside_or_parent_of_any
399
for path in sorted(user_dirs):
400
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
401
dirs_to_add.append((path, None))
402
prev_dir = path.raw_path
404
# dirs_to_add is initialised to a list of directories, but as we scan
405
# directories we append files to it.
406
# XXX: We should determine kind of files when we scan them rather than
407
# adding to this list. RBC 20070703
408
for directory, parent_ie in dirs_to_add:
409
# directory is tree-relative
410
abspath = self.abspath(directory.raw_path)
412
# get the contents of this directory.
414
# find the kind of the path being added.
415
kind = osutils.file_kind(abspath)
417
if not InventoryEntry.versionable_kind(kind):
418
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
421
if parent_ie is not None:
422
versioned = directory.base_path in parent_ie.children
424
# without the parent ie, use the relatively slower inventory
426
versioned = inv.has_filename(
427
self._fix_case_of_inventory_path(directory.raw_path))
429
if kind == 'directory':
431
sub_branch = bzrdir.BzrDir.open(abspath)
433
except errors.NotBranchError:
435
except errors.UnsupportedFormatError:
440
if directory.raw_path == '':
441
# mutter("tree root doesn't need to be added")
445
# mutter("%r is already versioned", abspath)
447
# XXX: This is wrong; people *might* reasonably be trying to add
448
# subtrees as subtrees. This should probably only be done in formats
449
# which can represent subtrees, and even then perhaps only when
450
# the user asked to add subtrees. At the moment you can add them
451
# specially through 'join --reference', which is perhaps
452
# reasonable: adding a new reference is a special operation and
453
# can have a special behaviour. mbp 20070306
454
mutter("%r is a nested bzr tree", abspath)
456
_add_one(self, inv, parent_ie, directory, kind, action)
457
added.append(directory.raw_path)
459
if kind == 'directory' and not sub_tree:
460
if parent_ie is not None:
462
this_ie = parent_ie.children[directory.base_path]
464
# without the parent ie, use the relatively slower inventory
466
this_id = inv.path2id(
467
self._fix_case_of_inventory_path(directory.raw_path))
471
this_ie = inv[this_id]
473
for subf in sorted(os.listdir(abspath)):
474
# here we could use TreeDirectory rather than
475
# string concatenation.
476
subp = osutils.pathjoin(directory.raw_path, subf)
477
# TODO: is_control_filename is very slow. Make it faster.
478
# TreeDirectory.is_control_filename could also make this
479
# faster - its impossible for a non root dir to have a
481
if self.is_control_filename(subp):
482
mutter("skip control directory %r", subp)
483
elif subf in this_ie.children:
484
# recurse into this already versioned subdir.
485
dirs_to_add.append((_FastPath(subp, subf), this_ie))
487
# user selection overrides ignoes
488
# ignore while selecting files - if we globbed in the
489
# outer loop we would ignore user files.
490
ignore_glob = self.is_ignored(subp)
491
if ignore_glob is not None:
492
# mutter("skip ignored sub-file %r", subp)
493
ignored.setdefault(ignore_glob, []).append(subp)
495
#mutter("queue to add sub-file %r", subp)
496
dirs_to_add.append((_FastPath(subp, subf), this_ie))
500
self._write_inventory(inv)
502
self.read_working_inventory()
503
return added, ignored
505
def update_basis_by_delta(self, new_revid, delta):
506
"""Update the parents of this tree after a commit.
508
This gives the tree one parent, with revision id new_revid. The
509
inventory delta is applied to the current basis tree to generate the
510
inventory for the parent new_revid, and all other parent trees are
513
All the changes in the delta should be changes synchronising the basis
514
tree with some or all of the working tree, with a change to a directory
515
requiring that its contents have been recursively included. That is,
516
this is not a general purpose tree modification routine, but a helper
517
for commit which is not required to handle situations that do not arise
520
:param new_revid: The new revision id for the trees parent.
521
:param delta: An inventory delta (see apply_inventory_delta) describing
522
the changes from the current left most parent revision to new_revid.
524
# if the tree is updated by a pull to the branch, as happens in
525
# WorkingTree2, when there was no separation between branch and tree,
526
# then just clear merges, efficiency is not a concern for now as this
527
# is legacy environments only, and they are slow regardless.
528
if self.last_revision() == new_revid:
529
self.set_parent_ids([new_revid])
531
# generic implementation based on Inventory manipulation. See
532
# WorkingTree classes for optimised versions for specific format trees.
533
basis = self.basis_tree()
535
inventory = basis.inventory
537
inventory.apply_delta(delta)
538
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
539
self.set_parent_trees([(new_revid, rev_tree)])
542
class MutableTreeHooks(hooks.Hooks):
543
"""A dictionary mapping a hook name to a list of callables for mutabletree
548
"""Create the default hooks.
551
hooks.Hooks.__init__(self)
552
# Invoked before a commit is done in a tree. New in 1.4
553
self['start_commit'] = []
556
# install the default hooks into the MutableTree class.
557
MutableTree.hooks = MutableTreeHooks()
560
class _FastPath(object):
561
"""A path object with fast accessors for things like basename."""
563
__slots__ = ['raw_path', 'base_path']
565
def __init__(self, path, base_path=None):
566
"""Construct a FastPath from path."""
567
if base_path is None:
568
self.base_path = osutils.basename(path)
570
self.base_path = base_path
573
def __cmp__(self, other):
574
return cmp(self.raw_path, other.raw_path)
577
return hash(self.raw_path)
580
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
581
"""Add a new entry to the inventory and automatically add unversioned parents.
583
:param inv: Inventory which will receive the new entry.
584
:param parent_ie: Parent inventory entry if known, or None. If
585
None, the parent is looked up by name and used if present, otherwise it
586
is recursively added.
587
:param kind: Kind of new entry (file, directory, etc)
588
:param action: callback(inv, parent_ie, path, kind); return ignored.
589
:return: A list of paths which have been added.
591
# Nothing to do if path is already versioned.
592
# This is safe from infinite recursion because the tree root is
594
if parent_ie is not None:
595
# we have a parent ie already
598
# slower but does not need parent_ie
599
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
601
# its really not there : add the parent
602
# note that the dirname use leads to some extra str copying etc but as
603
# there are a limited number of dirs we can be nested under, it should
604
# generally find it very fast and not recurse after that.
605
added = _add_one_and_parent(tree, inv, None,
606
_FastPath(dirname(path.raw_path)), 'directory', action)
607
parent_id = inv.path2id(dirname(path.raw_path))
608
parent_ie = inv[parent_id]
609
_add_one(tree, inv, parent_ie, path, kind, action)
610
return added + [path.raw_path]
613
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
614
"""Add a new entry to the inventory.
616
:param inv: Inventory which will receive the new entry.
617
:param parent_ie: Parent inventory entry.
618
:param kind: Kind of new entry (file, directory, etc)
619
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
620
file_id or None to generate a new file id
623
file_id = file_id_callback(inv, parent_ie, path, kind)
624
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
