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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""MutableTree object.
42
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
44
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
79
85
@needs_tree_write_lock
80
86
def add(self, files, ids=None, kinds=None):
124
130
if self.is_control_filename(f):
125
131
raise errors.ForbiddenControlFileError(filename=f)
126
132
fp = splitpath(f)
127
# fill out file kinds for all files [not needed when we stop
133
# fill out file kinds for all files [not needed when we stop
128
134
# caring about the instantaneous file kind within a uncommmitted tree
130
136
self._gather_kinds(files, kinds)
181
187
from bzrlib import commit
182
188
if revprops is None:
190
possible_master_transports=[]
184
191
if not 'branch-nick' in revprops:
185
revprops['branch-nick'] = self.branch.nick
192
revprops['branch-nick'] = self.branch._get_nick(
193
kwargs.get('local', False),
194
possible_master_transports)
195
authors = kwargs.pop('authors', None)
186
196
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)
187
210
if author is not None:
188
if 'author' in revprops:
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:
189
215
# XXX: maybe we should just accept one of them?
190
216
raise AssertionError('author property given twice')
191
revprops['author'] = author
218
raise AssertionError('\\n is not a valid character '
219
'in an author identity')
220
revprops['authors'] = author
192
221
# args for wt.commit start at message from the Commit.commit method,
193
222
args = (message, ) + args
194
223
for hook in MutableTree.hooks['start_commit']:
196
225
committed_id = commit.Commit().commit(working_tree=self,
197
revprops=revprops, *args, **kwargs)
227
possible_master_transports=possible_master_transports,
198
229
return committed_id
200
231
def _gather_kinds(self, files, kinds):
202
233
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:
205
253
def last_revision(self):
206
254
"""Return the revision id of the last commit performed in this tree.
208
256
In early tree formats the result of last_revision is the same as the
209
257
branch last_revision, but that is no longer the case for modern tree
212
260
last_revision returns the left most parent id, or None if there are no
231
279
def lock_write(self):
232
280
"""Lock the tree and its branch. This allows mutating calls to be made.
234
Some mutating methods will take out implicit write locks, but in
282
Some mutating methods will take out implicit write locks, but in
235
283
general you should always obtain a write lock before calling mutating
236
284
methods on a tree.
248
296
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)
250
321
@needs_write_lock
251
322
def put_file_bytes_non_atomic(self, file_id, bytes):
252
323
"""Update the content of a file in the tree.
254
325
Note that the file is written in-place rather than being
255
326
written to a temporary location and renamed. As a consequence,
256
327
readers can potentially see the file half-written.
270
341
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
271
342
"""Set the parents of the working tree.
273
:param parents_list: A list of (revision_id, tree) tuples.
344
:param parents_list: A list of (revision_id, tree) tuples.
274
345
If tree is None, then that element is treated as an unreachable
275
346
parent tree - i.e. a ghost.
284
355
For the specific behaviour see the help for cmd_add().
286
357
:param action: A reporter to be called with the inventory, parent_ie,
287
path and kind of the path being added. It may return a file_id if
358
path and kind of the path being added. It may return a file_id if
288
359
a specific one should be used.
289
360
:param save: Save the inventory after completing the adds. If False
290
361
this provides dry-run functionality by doing the add and not saving
310
381
user_dirs = set()
312
# validate user file paths and convert all paths to tree
383
# validate user file paths and convert all paths to tree
313
384
# relative : it's cheaper to make a tree relative path an abspath
314
# than to convert an abspath to tree relative.
315
for filepath in file_list:
316
rf = _FastPath(self.relpath(filepath))
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)
317
389
# validate user parameters. Our recursive code avoids adding new files
318
# that need such validation
390
# that need such validation
319
391
if self.is_control_filename(rf.raw_path):
320
392
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
322
394
abspath = self.abspath(rf.raw_path)
323
395
kind = osutils.file_kind(abspath)
324
396
if kind == 'directory':
329
401
raise errors.BadFileKindError(filename=abspath, kind=kind)
330
402
# ensure the named path is added, so that ignore rules in the later directory
331
403
# walk dont skip it.
332
# we dont have a parent ie known yet.: use the relatively slower inventory
404
# we dont have a parent ie known yet.: use the relatively slower inventory
334
406
versioned = inv.has_filename(rf.raw_path)
372
444
if parent_ie is not None:
373
445
versioned = directory.base_path in parent_ie.children
375
# without the parent ie, use the relatively slower inventory
447
# without the parent ie, use the relatively slower inventory
377
versioned = inv.has_filename(directory.raw_path)
449
versioned = inv.has_filename(
450
self._fix_case_of_inventory_path(directory.raw_path))
379
452
if kind == 'directory':
395
468
# mutter("%r is already versioned", abspath)
397
470
# XXX: This is wrong; people *might* reasonably be trying to add
398
# subtrees as subtrees. This should probably only be done in formats
471
# subtrees as subtrees. This should probably only be done in formats
399
472
# which can represent subtrees, and even then perhaps only when
400
473
# the user asked to add subtrees. At the moment you can add them
401
474
# specially through 'join --reference', which is perhaps
411
484
# must be present:
412
485
this_ie = parent_ie.children[directory.base_path]
414
# without the parent ie, use the relatively slower inventory
487
# without the parent ie, use the relatively slower inventory
416
this_id = inv.path2id(directory.raw_path)
489
this_id = inv.path2id(
490
self._fix_case_of_inventory_path(directory.raw_path))
417
491
if this_id is None:
420
494
this_ie = inv[this_id]
422
496
for subf in sorted(os.listdir(abspath)):
423
# here we could use TreeDirectory rather than
497
# here we could use TreeDirectory rather than
424
498
# string concatenation.
425
499
subp = osutils.pathjoin(directory.raw_path, subf)
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
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
430
504
if self.is_control_filename(subp):
431
505
mutter("skip control directory %r", subp)
466
540
for commit which is not required to handle situations that do not arise
467
541
outside of commit.
543
See the inventory developers documentation for the theory behind
469
546
:param new_revid: The new revision id for the trees parent.
470
547
:param delta: An inventory delta (see apply_inventory_delta) describing
471
548
the changes from the current left most parent revision to new_revid.
481
558
# WorkingTree classes for optimised versions for specific format trees.
482
559
basis = self.basis_tree()
483
560
basis.lock_read()
484
inventory = basis.inventory
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()
486
566
inventory.apply_delta(delta)
487
567
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
500
580
hooks.Hooks.__init__(self)
501
# Invoked before a commit is done in a tree. New in 1.4
502
self['start_commit'] = []
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))
505
588
# install the default hooks into the MutableTree class.
547
630
# slower but does not need parent_ie
548
if inv.has_filename(path.raw_path):
631
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
550
633
# its really not there : add the parent
551
634
# note that the dirname use leads to some extra str copying etc but as
added
removed
bzrlib/mutabletree.py
