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):
96
102
TODO: Perhaps callback with the ids and paths as they're added.
98
104
if isinstance(files, basestring):
99
assert(ids is None or isinstance(ids, basestring))
100
assert(kinds is None or isinstance(kinds, 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()
102
112
if ids is not None:
110
120
ids = [None] * len(files)
112
assert(len(ids) == len(files))
122
if not (len(ids) == len(files)):
123
raise AssertionError()
113
124
if kinds is None:
114
125
kinds = [None] * len(files)
116
assert(len(kinds) == len(files))
126
elif not len(kinds) == len(files):
127
raise AssertionError()
118
129
# generic constraint checks:
119
130
if self.is_control_filename(f):
120
131
raise errors.ForbiddenControlFileError(filename=f)
121
132
fp = splitpath(f)
122
# 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
123
134
# caring about the instantaneous file kind within a uncommmitted tree
125
136
self._gather_kinds(files, kinds)
176
187
from bzrlib import commit
177
188
if revprops is None:
190
possible_master_transports=[]
179
191
if not 'branch-nick' in revprops:
180
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)
181
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)
182
210
if author is not None:
183
assert 'author' not in revprops
184
revprops['author'] = author
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:
215
# XXX: maybe we should just accept one of them?
216
raise AssertionError('author property given twice')
218
raise AssertionError('\\n is not a valid character '
219
'in an author identity')
220
revprops['authors'] = author
185
221
# args for wt.commit start at message from the Commit.commit method,
186
222
args = (message, ) + args
187
223
for hook in MutableTree.hooks['start_commit']:
189
225
committed_id = commit.Commit().commit(working_tree=self,
190
revprops=revprops, *args, **kwargs)
227
possible_master_transports=possible_master_transports,
191
229
return committed_id
193
231
def _gather_kinds(self, files, kinds):
224
262
def lock_write(self):
225
263
"""Lock the tree and its branch. This allows mutating calls to be made.
227
Some mutating methods will take out implicit write locks, but in
265
Some mutating methods will take out implicit write locks, but in
228
266
general you should always obtain a write lock before calling mutating
229
267
methods on a tree.
241
279
raise NotImplementedError(self.mkdir)
281
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
282
"""Tell the tree we have observed a paths sha1.
284
The intent of this function is to allow trees that have a hashcache to
285
update the hashcache during commit. If the observed file is too new
286
(based on the stat_value) to be safely hash-cached the tree will ignore
289
The default implementation does nothing.
291
:param file_id: The file id
292
:param path: The file path
293
:param sha1: The sha 1 that was observed.
294
:param stat_value: A stat result for the file the sha1 was read from.
298
def _fix_case_of_inventory_path(self, path):
299
"""If our tree isn't case sensitive, return the canonical path"""
300
if not self.case_sensitive:
301
path = self.get_canonical_inventory_path(path)
305
def put_file_bytes_non_atomic(self, file_id, bytes):
306
"""Update the content of a file in the tree.
308
Note that the file is written in-place rather than being
309
written to a temporary location and renamed. As a consequence,
310
readers can potentially see the file half-written.
312
:param file_id: file-id of the file
313
:param bytes: the new file contents
315
raise NotImplementedError(self.put_file_bytes_non_atomic)
243
317
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
244
318
"""Set the parents ids of the working tree.
250
324
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
251
325
"""Set the parents of the working tree.
253
:param parents_list: A list of (revision_id, tree) tuples.
327
:param parents_list: A list of (revision_id, tree) tuples.
254
328
If tree is None, then that element is treated as an unreachable
255
329
parent tree - i.e. a ghost.
264
338
For the specific behaviour see the help for cmd_add().
266
340
:param action: A reporter to be called with the inventory, parent_ie,
267
path and kind of the path being added. It may return a file_id if
341
path and kind of the path being added. It may return a file_id if
268
342
a specific one should be used.
269
343
:param save: Save the inventory after completing the adds. If False
270
344
this provides dry-run functionality by doing the add and not saving
276
350
# not in an inner loop; and we want to remove direct use of this,
277
351
# so here as a reminder for now. RBC 20070703
278
352
from bzrlib.inventory import InventoryEntry
279
assert isinstance(recurse, bool)
280
353
if action is None:
281
354
action = add.AddAction()
283
356
if not file_list:
284
357
# no paths supplied: add the entire tree.
285
358
file_list = [u'.']
291
364
user_dirs = set()
293
# validate user file paths and convert all paths to tree
366
# validate user file paths and convert all paths to tree
294
367
# relative : it's cheaper to make a tree relative path an abspath
295
# than to convert an abspath to tree relative.
296
for filepath in file_list:
297
rf = _FastPath(self.relpath(filepath))
368
# than to convert an abspath to tree relative, and it's cheaper to
369
# perform the canonicalization in bulk.
370
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
371
rf = _FastPath(filepath)
298
372
# validate user parameters. Our recursive code avoids adding new files
299
# that need such validation
373
# that need such validation
300
374
if self.is_control_filename(rf.raw_path):
301
375
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
303
377
abspath = self.abspath(rf.raw_path)
304
378
kind = osutils.file_kind(abspath)
305
379
if kind == 'directory':
310
384
raise errors.BadFileKindError(filename=abspath, kind=kind)
311
385
# ensure the named path is added, so that ignore rules in the later directory
312
386
# walk dont skip it.
313
# we dont have a parent ie known yet.: use the relatively slower inventory
387
# we dont have a parent ie known yet.: use the relatively slower inventory
315
389
versioned = inv.has_filename(rf.raw_path)
353
427
if parent_ie is not None:
354
428
versioned = directory.base_path in parent_ie.children
356
# without the parent ie, use the relatively slower inventory
430
# without the parent ie, use the relatively slower inventory
358
versioned = inv.has_filename(directory.raw_path)
432
versioned = inv.has_filename(
433
self._fix_case_of_inventory_path(directory.raw_path))
360
435
if kind == 'directory':
376
451
# mutter("%r is already versioned", abspath)
378
453
# XXX: This is wrong; people *might* reasonably be trying to add
379
# subtrees as subtrees. This should probably only be done in formats
454
# subtrees as subtrees. This should probably only be done in formats
380
455
# which can represent subtrees, and even then perhaps only when
381
456
# the user asked to add subtrees. At the moment you can add them
382
457
# specially through 'join --reference', which is perhaps
392
467
# must be present:
393
468
this_ie = parent_ie.children[directory.base_path]
395
# without the parent ie, use the relatively slower inventory
470
# without the parent ie, use the relatively slower inventory
397
this_id = inv.path2id(directory.raw_path)
472
this_id = inv.path2id(
473
self._fix_case_of_inventory_path(directory.raw_path))
398
474
if this_id is None:
401
477
this_ie = inv[this_id]
403
479
for subf in sorted(os.listdir(abspath)):
404
# here we could use TreeDirectory rather than
480
# here we could use TreeDirectory rather than
405
481
# string concatenation.
406
482
subp = osutils.pathjoin(directory.raw_path, subf)
407
# TODO: is_control_filename is very slow. Make it faster.
408
# TreeDirectory.is_control_filename could also make this
409
# faster - its impossible for a non root dir to have a
483
# TODO: is_control_filename is very slow. Make it faster.
484
# TreeDirectory.is_control_filename could also make this
485
# faster - its impossible for a non root dir to have a
411
487
if self.is_control_filename(subp):
412
488
mutter("skip control directory %r", subp)
462
538
# WorkingTree classes for optimised versions for specific format trees.
463
539
basis = self.basis_tree()
464
540
basis.lock_read()
465
inventory = basis.inventory
541
# TODO: Consider re-evaluating the need for this with CHKInventory
542
# we don't strictly need to mutate an inventory for this
543
# it only makes sense when apply_delta is cheaper than get_inventory()
544
inventory = basis.inventory._get_mutable_inventory()
467
546
inventory.apply_delta(delta)
468
547
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
481
560
hooks.Hooks.__init__(self)
482
# Invoked before a commit is done in a tree. New in 1.4
483
self['start_commit'] = []
561
self.create_hook(hooks.HookPoint('start_commit',
562
"Called before a commit is performed on a tree. The start commit "
563
"hook is able to change the tree before the commit takes place. "
564
"start_commit is called with the bzrlib.tree.MutableTree that the "
565
"commit is being performed on.", (1, 4), None))
486
568
# install the default hooks into the MutableTree class.
528
610
# slower but does not need parent_ie
529
if inv.has_filename(path.raw_path):
611
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
531
613
# its really not there : add the parent
532
614
# note that the dirname use leads to some extra str copying etc but as
added
removed
bzrlib/mutabletree.py
