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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""MutableTree object.
43
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
43
from bzrlib.osutils import splitpath
44
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
47
47
def needs_tree_write_lock(unbound):
69
69
entirely in memory.
71
71
For now, we are not treating MutableTree as an interface to provide
72
conformance tests for - rather we are testing MemoryTree specifically, and
72
conformance tests for - rather we are testing MemoryTree specifically, and
73
73
interface testing implementations of WorkingTree.
75
75
A mutable tree always has an associated Branch and BzrDir object - the
76
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
79
@needs_tree_write_lock
86
80
def add(self, files, ids=None, kinds=None):
130
124
if self.is_control_filename(f):
131
125
raise errors.ForbiddenControlFileError(filename=f)
132
126
fp = splitpath(f)
133
# fill out file kinds for all files [not needed when we stop
127
# fill out file kinds for all files [not needed when we stop
134
128
# caring about the instantaneous file kind within a uncommmitted tree
136
130
self._gather_kinds(files, kinds)
187
181
from bzrlib import commit
188
182
if revprops is None:
190
possible_master_transports=[]
191
184
if not 'branch-nick' in revprops:
192
revprops['branch-nick'] = self.branch._get_nick(
193
kwargs.get('local', False),
194
possible_master_transports)
195
authors = kwargs.pop('authors', None)
185
revprops['branch-nick'] = self.branch.nick
196
186
author = kwargs.pop('author', None)
197
if authors is not None:
198
if author is not None:
199
raise AssertionError('Specifying both author and authors '
200
'is not allowed. Specify just authors instead')
201
if 'author' in revprops or 'authors' in revprops:
202
# XXX: maybe we should just accept one of them?
203
raise AssertionError('author property given twice')
205
for individual in authors:
206
if '\n' in individual:
207
raise AssertionError('\\n is not a valid character '
208
'in an author identity')
209
revprops['authors'] = '\n'.join(authors)
210
187
if author is not None:
211
symbol_versioning.warn('The parameter author was deprecated'
212
' in version 1.13. Use authors instead',
214
if 'author' in revprops or 'authors' in revprops:
188
if 'author' in revprops:
215
189
# XXX: maybe we should just accept one of them?
216
190
raise AssertionError('author property given twice')
218
raise AssertionError('\\n is not a valid character '
219
'in an author identity')
220
revprops['authors'] = author
191
revprops['author'] = author
221
192
# args for wt.commit start at message from the Commit.commit method,
222
193
args = (message, ) + args
223
194
for hook in MutableTree.hooks['start_commit']:
225
196
committed_id = commit.Commit().commit(working_tree=self,
227
possible_master_transports=possible_master_transports,
197
revprops=revprops, *args, **kwargs)
229
198
return committed_id
231
200
def _gather_kinds(self, files, kinds):
233
202
raise NotImplementedError(self._gather_kinds)
236
def has_changes(self, from_tree):
237
"""Quickly check that the tree contains at least one change.
239
:return: True if a change is found. False otherwise
241
changes = self.iter_changes(from_tree)
243
change = changes.next()
244
# Exclude root (talk about black magic... --vila 20090629)
245
if change[4] == (None, None):
246
change = changes.next()
248
except StopIteration:
253
205
def last_revision(self):
254
206
"""Return the revision id of the last commit performed in this tree.
256
208
In early tree formats the result of last_revision is the same as the
257
209
branch last_revision, but that is no longer the case for modern tree
260
212
last_revision returns the left most parent id, or None if there are no
279
231
def lock_write(self):
280
232
"""Lock the tree and its branch. This allows mutating calls to be made.
282
Some mutating methods will take out implicit write locks, but in
234
Some mutating methods will take out implicit write locks, but in
283
235
general you should always obtain a write lock before calling mutating
284
236
methods on a tree.
296
248
raise NotImplementedError(self.mkdir)
298
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
299
"""Tell the tree we have observed a paths sha1.
301
The intent of this function is to allow trees that have a hashcache to
302
update the hashcache during commit. If the observed file is too new
303
(based on the stat_value) to be safely hash-cached the tree will ignore
306
The default implementation does nothing.
308
:param file_id: The file id
309
:param path: The file path
310
:param sha1: The sha 1 that was observed.
311
:param stat_value: A stat result for the file the sha1 was read from.
315
def _fix_case_of_inventory_path(self, path):
316
"""If our tree isn't case sensitive, return the canonical path"""
317
if not self.case_sensitive:
318
path = self.get_canonical_inventory_path(path)
321
250
@needs_write_lock
322
251
def put_file_bytes_non_atomic(self, file_id, bytes):
323
252
"""Update the content of a file in the tree.
325
254
Note that the file is written in-place rather than being
326
255
written to a temporary location and renamed. As a consequence,
327
256
readers can potentially see the file half-written.
341
270
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
342
271
"""Set the parents of the working tree.
344
:param parents_list: A list of (revision_id, tree) tuples.
273
:param parents_list: A list of (revision_id, tree) tuples.
345
274
If tree is None, then that element is treated as an unreachable
346
275
parent tree - i.e. a ghost.
355
284
For the specific behaviour see the help for cmd_add().
357
286
:param action: A reporter to be called with the inventory, parent_ie,
358
path and kind of the path being added. It may return a file_id if
287
path and kind of the path being added. It may return a file_id if
359
288
a specific one should be used.
360
289
:param save: Save the inventory after completing the adds. If False
361
290
this provides dry-run functionality by doing the add and not saving
381
310
user_dirs = set()
383
# validate user file paths and convert all paths to tree
312
# validate user file paths and convert all paths to tree
384
313
# relative : it's cheaper to make a tree relative path an abspath
385
# than to convert an abspath to tree relative, and it's cheaper to
386
# perform the canonicalization in bulk.
387
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
388
rf = _FastPath(filepath)
314
# than to convert an abspath to tree relative.
315
for filepath in file_list:
316
rf = _FastPath(self.relpath(filepath))
389
317
# validate user parameters. Our recursive code avoids adding new files
390
# that need such validation
318
# that need such validation
391
319
if self.is_control_filename(rf.raw_path):
392
320
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
394
322
abspath = self.abspath(rf.raw_path)
395
323
kind = osutils.file_kind(abspath)
396
324
if kind == 'directory':
401
329
raise errors.BadFileKindError(filename=abspath, kind=kind)
402
330
# ensure the named path is added, so that ignore rules in the later directory
403
331
# walk dont skip it.
404
# we dont have a parent ie known yet.: use the relatively slower inventory
332
# we dont have a parent ie known yet.: use the relatively slower inventory
406
334
versioned = inv.has_filename(rf.raw_path)
444
372
if parent_ie is not None:
445
373
versioned = directory.base_path in parent_ie.children
447
# without the parent ie, use the relatively slower inventory
375
# without the parent ie, use the relatively slower inventory
449
versioned = inv.has_filename(
450
self._fix_case_of_inventory_path(directory.raw_path))
377
versioned = inv.has_filename(directory.raw_path)
452
379
if kind == 'directory':
468
395
# mutter("%r is already versioned", abspath)
470
397
# XXX: This is wrong; people *might* reasonably be trying to add
471
# subtrees as subtrees. This should probably only be done in formats
398
# subtrees as subtrees. This should probably only be done in formats
472
399
# which can represent subtrees, and even then perhaps only when
473
400
# the user asked to add subtrees. At the moment you can add them
474
401
# specially through 'join --reference', which is perhaps
484
411
# must be present:
485
412
this_ie = parent_ie.children[directory.base_path]
487
# without the parent ie, use the relatively slower inventory
414
# without the parent ie, use the relatively slower inventory
489
this_id = inv.path2id(
490
self._fix_case_of_inventory_path(directory.raw_path))
416
this_id = inv.path2id(directory.raw_path)
491
417
if this_id is None:
494
420
this_ie = inv[this_id]
496
422
for subf in sorted(os.listdir(abspath)):
497
# here we could use TreeDirectory rather than
423
# here we could use TreeDirectory rather than
498
424
# string concatenation.
499
425
subp = osutils.pathjoin(directory.raw_path, subf)
500
# TODO: is_control_filename is very slow. Make it faster.
501
# TreeDirectory.is_control_filename could also make this
502
# faster - its impossible for a non root dir to have a
426
# TODO: is_control_filename is very slow. Make it faster.
427
# TreeDirectory.is_control_filename could also make this
428
# faster - its impossible for a non root dir to have a
504
430
if self.is_control_filename(subp):
505
431
mutter("skip control directory %r", subp)
540
466
for commit which is not required to handle situations that do not arise
541
467
outside of commit.
543
See the inventory developers documentation for the theory behind
546
469
:param new_revid: The new revision id for the trees parent.
547
470
:param delta: An inventory delta (see apply_inventory_delta) describing
548
471
the changes from the current left most parent revision to new_revid.
558
481
# WorkingTree classes for optimised versions for specific format trees.
559
482
basis = self.basis_tree()
560
483
basis.lock_read()
561
# TODO: Consider re-evaluating the need for this with CHKInventory
562
# we don't strictly need to mutate an inventory for this
563
# it only makes sense when apply_delta is cheaper than get_inventory()
564
inventory = basis.inventory._get_mutable_inventory()
484
inventory = basis.inventory
566
486
inventory.apply_delta(delta)
567
487
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
580
500
hooks.Hooks.__init__(self)
581
self.create_hook(hooks.HookPoint('start_commit',
582
"Called before a commit is performed on a tree. The start commit "
583
"hook is able to change the tree before the commit takes place. "
584
"start_commit is called with the bzrlib.tree.MutableTree that the "
585
"commit is being performed on.", (1, 4), None))
501
# Invoked before a commit is done in a tree. New in 1.4
502
self['start_commit'] = []
588
505
# install the default hooks into the MutableTree class.
630
547
# slower but does not need parent_ie
631
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
548
if inv.has_filename(path.raw_path):
633
550
# its really not there : add the parent
634
551
# note that the dirname use leads to some extra str copying etc but as
added
removed
bzrlib/mutabletree.py
