« back to all changes in this revision
Viewing changes to bzrlib/workingtree.py
- browse files at revision 2018.5.149
- compare with another revision
- download diff
- download tarball
- view history from revision 2018.5.149
- Committer: Andrew Bennetts
- Date: 2007-04-13 06:23:59 UTC
- mfrom: (2414 +trunk)
- mto: (2018.18.11 hpss-faster-copy)
- mto: This revision was merged to the branch mainline in revision 2435.
- Revision ID: andrew.bennetts@canonical.com-20070413062359-kiqjbhb06b3j2fj1
Merge from bzr.dev
- files added:
- COPYING.txt
- bzrlib/benchmarks/tree_creator
- bzrlib/repofmt
- bzrlib/smart
- bzrlib/tests/intertree_implementations
- bzrlib/tests/per_lock
- bzrlib/tests/tree_implementations
- bzrlib/version_info_formats
- tools/win32
- files removed:
- NEWS.developers
- bzrlib/util/urlgrabber
- files renamed:
- bzrlib/bundle/read_bundle.py => bzrlib/bundle/bundle_data.py
- bzrlib/bundle/serializer/v07.py => bzrlib/bundle/serializer/v08.py
- bzrlib/tests/test_revprops.py => bzrlib/tests/repository_implementations/test_revision.py
- bzrlib/tests/test_command.py => bzrlib/tests/test_commands.py
- bzrlib/win32console.py => bzrlib/win32utils.py
- files modified:
- .bzrignore
- setup.py *
added
removed
bzrlib/workingtree.py
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
12
12
#
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29
29
WorkingTree.open(dir).
30
30
"""
31
31
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
34
35
32
# TODO: Give the workingtree sole responsibility for the working inventory;
36
33
# remove the variable and references to it from the branch. This may require
37
34
# updating the commit code so as to update the inventory within the working
39
36
# At the moment they may alias the inventory and have old copies of it in
40
37
# memory. (Now done? -- mbp 20060309)
41
38
42
from binascii import hexlify
39
from cStringIO import StringIO
40
import os
41
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
44
from bisect import bisect_left
43
45
import collections
44
46
from copy import deepcopy
45
from cStringIO import StringIO
46
47
import errno
47
import fnmatch
48
import os
49
import re
48
import itertools
49
import operator
50
50
import stat
51
51
from time import time
52
53
from bzrlib.atomicfile import AtomicFile
54
from bzrlib.branch import (Branch,
55
quotefn)
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
import bzrlib.bzrdir as bzrdir
52
import warnings
53
import re
54
55
import bzrlib
56
from bzrlib import (
57
branch,
58
bzrdir,
59
conflicts as _mod_conflicts,
60
dirstate,
61
errors,
62
generate_ids,
63
globbing,
64
hashcache,
65
ignores,
66
merge,
67
osutils,
68
revisiontree,
69
repository,
70
textui,
71
trace,
72
transform,
73
ui,
74
urlutils,
75
xml5,
76
xml6,
77
xml7,
78
)
79
import bzrlib.branch
80
from bzrlib.transport import get_transport
81
import bzrlib.ui
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
83
""")
84
85
from bzrlib import symbol_versioning
58
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
59
import bzrlib.errors as errors
60
from bzrlib.errors import (BzrCheckError,
61
BzrError,
62
ConflictFormatError,
63
DivergedBranches,
64
WeaveRevisionNotPresent,
65
NotBranchError,
66
NoSuchFile,
67
NotVersionedError,
68
MergeModifiedFormatError,
69
UnsupportedOperation,
70
)
71
from bzrlib.inventory import InventoryEntry, Inventory
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
72
88
from bzrlib.lockable_files import LockableFiles, TransportLock
73
89
from bzrlib.lockdir import LockDir
74
from bzrlib.merge import merge_inner, transform_tree
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
75
92
from bzrlib.osutils import (
76
abspath,
77
compact_date,
78
file_kind,
79
isdir,
80
getcwd,
81
pathjoin,
82
pumpfile,
83
safe_unicode,
84
splitpath,
85
rand_chars,
86
normpath,
87
realpath,
88
relpath,
89
rename,
90
supports_executable,
91
)
93
compact_date,
94
file_kind,
95
isdir,
96
normpath,
97
pathjoin,
98
rand_chars,
99
realpath,
100
safe_unicode,
101
splitpath,
102
supports_executable,
103
)
104
from bzrlib.trace import mutter, note
105
from bzrlib.transport.local import LocalTransport
92
106
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
107
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
94
108
from bzrlib.rio import RioReader, rio_file, Stanza
95
from bzrlib.symbol_versioning import *
96
from bzrlib.textui import show_status
97
import bzrlib.tree
98
from bzrlib.transform import build_tree
99
from bzrlib.trace import mutter, note
100
from bzrlib.transport import get_transport
101
from bzrlib.transport.local import LocalTransport
102
import bzrlib.urlutils as urlutils
103
import bzrlib.ui
104
import bzrlib.xml5
105
106
107
# the regex here does the following:
108
# 1) remove any weird characters; we don't escape them but rather
109
# just pull them out
110
# 2) match leading '.'s to make it not hidden
111
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
112
_gen_id_suffix = None
113
_gen_id_serial = 0
114
115
116
def _next_id_suffix():
117
"""Create a new file id suffix that is reasonably unique.
118
119
On the first call we combine the current time with 64 bits of randomness
120
to give a highly probably globally unique number. Then each call in the same
121
process adds 1 to a serial number we append to that unique value.
122
"""
123
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
124
# than having to move the id randomness out of the inner loop like this.
125
# XXX TODO: for the global randomness this uses we should add the thread-id
126
# before the serial #.
127
global _gen_id_suffix, _gen_id_serial
128
if _gen_id_suffix is None:
129
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
130
_gen_id_serial += 1
131
return _gen_id_suffix + str(_gen_id_serial)
132
133
109
from bzrlib.symbol_versioning import (deprecated_passed,
110
deprecated_method,
111
deprecated_function,
112
DEPRECATED_PARAMETER,
113
zero_eight,
114
zero_eleven,
115
zero_thirteen,
116
)
117
118
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
122
123
@deprecated_function(zero_thirteen)
134
124
def gen_file_id(name):
135
125
"""Return new file id for the basename 'name'.
136
126
137
The uniqueness is supplied from _next_id_suffix.
127
Use bzrlib.generate_ids.gen_file_id() instead
138
128
"""
139
# XXX TODO: squash the filename to lowercase.
140
# XXX TODO: truncate the filename to something like 20 or 30 chars.
141
# XXX TODO: consider what to do with ids that look like illegal filepaths
142
# on platforms we support.
143
return _gen_file_id_re.sub('', name) + _next_id_suffix()
144
145
129
return generate_ids.gen_file_id(name)
130
131
132
@deprecated_function(zero_thirteen)
146
133
def gen_root_id():
147
"""Return a new tree-root file id."""
148
return gen_file_id('TREE_ROOT')
134
"""Return a new tree-root file id.
135
136
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
137
"""
138
return generate_ids.gen_root_id()
149
139
150
140
151
141
class TreeEntry(object):
203
193
return ''
204
194
205
195
206
class WorkingTree(bzrlib.tree.Tree):
196
class WorkingTree(bzrlib.mutabletree.MutableTree):
207
197
"""Working copy tree.
208
198
209
199
The inventory is held in the `Branch` working-inventory, and the
220
210
_internal=False,
221
211
_format=None,
222
212
_bzrdir=None):
223
"""Construct a WorkingTree for basedir.
213
"""Construct a WorkingTree instance. This is not a public API.
224
214
225
If the branch is not supplied, it is opened automatically.
226
If the branch is supplied, it must be the branch for this basedir.
227
(branch.base is not cross checked, because for remote branches that
228
would be meaningless).
215
:param branch: A branch to override probing for the branch.
229
216
"""
230
217
self._format = _format
231
218
self.bzrdir = _bzrdir
232
219
if not _internal:
233
# not created via open etc.
234
warn("WorkingTree() is deprecated as of bzr version 0.8. "
235
"Please use bzrdir.open_workingtree or WorkingTree.open().",
236
DeprecationWarning,
237
stacklevel=2)
238
wt = WorkingTree.open(basedir)
239
self._branch = wt.branch
240
self.basedir = wt.basedir
241
self._control_files = wt._control_files
242
self._hashcache = wt._hashcache
243
self._set_inventory(wt._inventory)
244
self._format = wt._format
245
self.bzrdir = wt.bzrdir
246
from bzrlib.hashcache import HashCache
247
from bzrlib.trace import note, mutter
220
raise errors.BzrError("Please use bzrdir.open_workingtree or "
221
"WorkingTree.open() to obtain a WorkingTree.")
248
222
assert isinstance(basedir, basestring), \
249
223
"base directory %r is not a string" % basedir
250
224
basedir = safe_unicode(basedir)
251
225
mutter("opening working tree %r", basedir)
252
226
if deprecated_passed(branch):
253
if not _internal:
254
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
255
" Please use bzrdir.open_workingtree() or"
256
" WorkingTree.open().",
257
DeprecationWarning,
258
stacklevel=2
259
)
260
227
self._branch = branch
261
228
else:
262
229
self._branch = self.bzrdir.open_branch()
263
assert isinstance(self.branch, Branch), \
264
"branch %r is not a Branch" % self.branch
265
230
self.basedir = realpath(basedir)
266
231
# if branch is at our basedir and is a format 6 or less
267
232
if isinstance(self._format, WorkingTreeFormat2):
268
233
# share control object
269
234
self._control_files = self.branch.control_files
270
235
else:
271
# only ready for format 3
272
assert isinstance(self._format, WorkingTreeFormat3)
236
# assume all other formats have their own control files.
273
237
assert isinstance(_control_files, LockableFiles), \
274
238
"_control_files must be a LockableFiles, not %r" \
275
239
% _control_files
280
244
# if needed, or, when the cache sees a change, append it to the hash
281
245
# cache file, and have the parser take the most recent entry for a
282
246
# given path only.
283
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
284
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
247
wt_trans = self.bzrdir.get_workingtree_transport(None)
248
cache_filename = wt_trans.local_abspath('stat-cache')
249
self._hashcache = hashcache.HashCache(basedir, cache_filename,
250
self._control_files._file_mode)
251
hc = self._hashcache
285
252
hc.read()
286
253
# is this scan needed ? it makes things kinda slow.
287
254
#hc.scan()
291
258
hc.write()
292
259
293
260
if _inventory is None:
294
self._set_inventory(self.read_working_inventory())
261
# This will be acquired on lock_read() or lock_write()
262
self._inventory_is_modified = False
263
self._inventory = None
295
264
else:
296
self._set_inventory(_inventory)
265
# the caller of __init__ has provided an inventory,
266
# we assume they know what they are doing - as its only
267
# the Format factory and creation methods that are
268
# permitted to do this.
269
self._set_inventory(_inventory, dirty=False)
297
270
298
271
branch = property(
299
272
fget=lambda self: self._branch,
314
287
self._control_files.break_lock()
315
288
self.branch.break_lock()
316
289
317
def _set_inventory(self, inv):
290
def requires_rich_root(self):
291
return self._format.requires_rich_root
292
293
def supports_tree_reference(self):
294
return False
295
296
def _set_inventory(self, inv, dirty):
297
"""Set the internal cached inventory.
298
299
:param inv: The inventory to set.
300
:param dirty: A boolean indicating whether the inventory is the same
301
logical inventory as whats on disk. If True the inventory is not
302
the same and should be written to disk or data will be lost, if
303
False then the inventory is the same as that on disk and any
304
serialisation would be unneeded overhead.
305
"""
306
assert inv.root is not None
318
307
self._inventory = inv
319
self.path2id = self._inventory.path2id
320
321
def is_control_filename(self, filename):
322
"""True if filename is the name of a control file in this tree.
323
324
:param filename: A filename within the tree. This is a relative path
325
from the root of this tree.
326
327
This is true IF and ONLY IF the filename is part of the meta data
328
that bzr controls in this tree. I.E. a random .bzr directory placed
329
on disk will not be a control file for this tree.
330
"""
331
return self.bzrdir.is_control_filename(filename)
308
self._inventory_is_modified = dirty
332
309
333
310
@staticmethod
334
311
def open(path=None, _unsupported=False):
354
331
:return: The WorkingTree that contains 'path', and the rest of path
355
332
"""
356
333
if path is None:
357
path = os.getcwdu()
334
path = osutils.getcwd()
358
335
control, relpath = bzrdir.BzrDir.open_containing(path)
359
336
360
337
return control.open_workingtree(), relpath
367
344
"""
368
345
return WorkingTree.open(path, _unsupported=True)
369
346
347
# should be deprecated - this is slow and in any case treating them as a
348
# container is (we now know) bad style -- mbp 20070302
349
## @deprecated_method(zero_fifteen)
370
350
def __iter__(self):
371
351
"""Iterate through file_ids for this tree.
372
352
375
355
"""
376
356
inv = self._inventory
377
357
for path, ie in inv.iter_entries():
378
if bzrlib.osutils.lexists(self.abspath(path)):
358
if osutils.lexists(self.abspath(path)):
379
359
yield ie.file_id
380
360
381
361
def __repr__(self):
386
366
return pathjoin(self.basedir, filename)
387
367
388
368
def basis_tree(self):
389
"""Return RevisionTree for the current last revision."""
390
revision_id = self.last_revision()
391
if revision_id is not None:
392
try:
393
xml = self.read_basis_inventory()
394
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
395
except NoSuchFile:
396
inv = None
397
if inv is not None and inv.revision_id == revision_id:
398
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
399
revision_id)
400
# FIXME? RBC 20060403 should we cache the inventory here ?
401
return self.branch.repository.revision_tree(revision_id)
369
"""Return RevisionTree for the current last revision.
370
371
If the left most parent is a ghost then the returned tree will be an
372
empty tree - one obtained by calling repository.revision_tree(None).
373
"""
374
try:
375
revision_id = self.get_parent_ids()[0]
376
except IndexError:
377
# no parents, return an empty revision tree.
378
# in the future this should return the tree for
379
# 'empty:' - the implicit root empty tree.
380
return self.branch.repository.revision_tree(None)
381
try:
382
return self.revision_tree(revision_id)
383
except errors.NoSuchRevision:
384
pass
385
# No cached copy available, retrieve from the repository.
386
# FIXME? RBC 20060403 should we cache the inventory locally
387
# at this point ?
388
try:
389
return self.branch.repository.revision_tree(revision_id)
390
except errors.RevisionNotPresent:
391
# the basis tree *may* be a ghost or a low level error may have
392
# occured. If the revision is present, its a problem, if its not
393
# its a ghost.
394
if self.branch.repository.has_revision(revision_id):
395
raise
396
# the basis tree is a ghost so return an empty tree.
397
return self.branch.repository.revision_tree(None)
402
398
403
399
@staticmethod
404
400
@deprecated_method(zero_eight)
417
413
XXX: When BzrDir is present, these should be created through that
418
414
interface instead.
419
415
"""
420
warn('delete WorkingTree.create', stacklevel=3)
416
warnings.warn('delete WorkingTree.create', stacklevel=3)
421
417
transport = get_transport(directory)
422
418
if branch.bzrdir.root_transport.base == transport.base:
423
419
# same dir
444
440
The path may be absolute or relative. If its a relative path it is
445
441
interpreted relative to the python current working directory.
446
442
"""
447
return relpath(self.basedir, path)
443
return osutils.relpath(self.basedir, path)
448
444
449
445
def has_filename(self, filename):
450
return bzrlib.osutils.lexists(self.abspath(filename))
446
return osutils.lexists(self.abspath(filename))
451
447
452
448
def get_file(self, file_id):
449
file_id = osutils.safe_file_id(file_id)
453
450
return self.get_file_byname(self.id2path(file_id))
454
451
452
def get_file_text(self, file_id):
453
file_id = osutils.safe_file_id(file_id)
454
return self.get_file(file_id).read()
455
455
456
def get_file_byname(self, filename):
456
457
return file(self.abspath(filename), 'rb')
457
458
459
@needs_read_lock
460
def annotate_iter(self, file_id):
461
"""See Tree.annotate_iter
462
463
This implementation will use the basis tree implementation if possible.
464
Lines not in the basis are attributed to CURRENT_REVISION
465
466
If there are pending merges, lines added by those merges will be
467
incorrectly attributed to CURRENT_REVISION (but after committing, the
468
attribution will be correct).
469
"""
470
file_id = osutils.safe_file_id(file_id)
471
basis = self.basis_tree()
472
basis.lock_read()
473
try:
474
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
475
require_versioned=True).next()
476
changed_content, kind = changes[2], changes[6]
477
if not changed_content:
478
return basis.annotate_iter(file_id)
479
if kind[1] is None:
480
return None
481
import annotate
482
if kind[0] != 'file':
483
old_lines = []
484
else:
485
old_lines = list(basis.annotate_iter(file_id))
486
old = [old_lines]
487
for tree in self.branch.repository.revision_trees(
488
self.get_parent_ids()[1:]):
489
if file_id not in tree:
490
continue
491
old.append(list(tree.annotate_iter(file_id)))
492
return annotate.reannotate(old, self.get_file(file_id).readlines(),
493
CURRENT_REVISION)
494
finally:
495
basis.unlock()
496
497
def get_parent_ids(self):
498
"""See Tree.get_parent_ids.
499
500
This implementation reads the pending merges list and last_revision
501
value and uses that to decide what the parents list should be.
502
"""
503
last_rev = self._last_revision()
504
if last_rev is None:
505
parents = []
506
else:
507
parents = [last_rev]
508
try:
509
merges_file = self._control_files.get('pending-merges')
510
except errors.NoSuchFile:
511
pass
512
else:
513
for l in merges_file.readlines():
514
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
515
parents.append(revision_id)
516
return parents
517
518
@needs_read_lock
458
519
def get_root_id(self):
459
520
"""Return the id of this trees root"""
460
inv = self.read_working_inventory()
461
return inv.root.file_id
521
return self._inventory.root.file_id
462
522
463
523
def _get_store_filename(self, file_id):
464
524
## XXX: badly named; this is not in the store at all
525
file_id = osutils.safe_file_id(file_id)
465
526
return self.abspath(self.id2path(file_id))
466
527
467
528
@needs_read_lock
468
def clone(self, to_bzrdir, revision_id=None, basis=None):
529
def clone(self, to_bzrdir, revision_id=None):
469
530
"""Duplicate this working tree into to_bzr, including all state.
470
531
471
532
Specifically modified files are kept as modified, but
477
538
If not None, the cloned tree will have its last revision set to
478
539
revision, and and difference between the source trees last revision
479
540
and this one merged in.
480
481
basis
482
If not None, a closer copy of a tree which may have some files in
483
common, and which file content should be preferentially copied from.
484
541
"""
485
542
# assumes the target bzr dir format is compatible.
486
543
result = self._format.initialize(to_bzrdir)
490
547
@needs_read_lock
491
548
def copy_content_into(self, tree, revision_id=None):
492
549
"""Copy the current content and user files of this tree into tree."""
550
tree.set_root_id(self.get_root_id())
493
551
if revision_id is None:
494
transform_tree(tree, self)
552
merge.transform_tree(tree, self)
495
553
else:
496
# TODO now merge from tree.last_revision to revision
497
transform_tree(tree, self)
498
tree.set_last_revision(revision_id)
499
500
@needs_write_lock
501
def commit(self, message=None, revprops=None, *args, **kwargs):
502
# avoid circular imports
503
from bzrlib.commit import Commit
504
if revprops is None:
505
revprops = {}
506
if not 'branch-nick' in revprops:
507
revprops['branch-nick'] = self.branch.nick
508
# args for wt.commit start at message from the Commit.commit method,
509
# but with branch a kwarg now, passing in args as is results in the
510
#message being used for the branch
511
args = (DEPRECATED_PARAMETER, message, ) + args
512
committed_id = Commit().commit( working_tree=self, revprops=revprops,
513
*args, **kwargs)
514
self._set_inventory(self.read_working_inventory())
515
return committed_id
554
# TODO now merge from tree.last_revision to revision (to preserve
555
# user local changes)
556
merge.transform_tree(tree, self)
557
tree.set_parent_ids([revision_id])
516
558
517
559
def id2abspath(self, file_id):
560
file_id = osutils.safe_file_id(file_id)
518
561
return self.abspath(self.id2path(file_id))
519
562
520
563
def has_id(self, file_id):
521
564
# files that have been deleted are excluded
522
inv = self._inventory
565
file_id = osutils.safe_file_id(file_id)
566
inv = self.inventory
523
567
if not inv.has_id(file_id):
524
568
return False
525
569
path = inv.id2path(file_id)
526
return bzrlib.osutils.lexists(self.abspath(path))
570
return osutils.lexists(self.abspath(path))
527
571
528
572
def has_or_had_id(self, file_id):
573
file_id = osutils.safe_file_id(file_id)
529
574
if file_id == self.inventory.root.file_id:
530
575
return True
531
576
return self.inventory.has_id(file_id)
533
578
__contains__ = has_id
534
579
535
580
def get_file_size(self, file_id):
581
file_id = osutils.safe_file_id(file_id)
536
582
return os.path.getsize(self.id2abspath(file_id))
537
583
538
584
@needs_read_lock
539
def get_file_sha1(self, file_id, path=None):
585
def get_file_sha1(self, file_id, path=None, stat_value=None):
586
file_id = osutils.safe_file_id(file_id)
540
587
if not path:
541
588
path = self._inventory.id2path(file_id)
542
return self._hashcache.get_sha1(path)
589
return self._hashcache.get_sha1(path, stat_value)
543
590
544
591
def get_file_mtime(self, file_id, path=None):
592
file_id = osutils.safe_file_id(file_id)
545
593
if not path:
546
path = self._inventory.id2path(file_id)
594
path = self.inventory.id2path(file_id)
547
595
return os.lstat(self.abspath(path)).st_mtime
548
596
549
597
if not supports_executable():
550
598
def is_executable(self, file_id, path=None):
599
file_id = osutils.safe_file_id(file_id)
551
600
return self._inventory[file_id].executable
552
601
else:
553
602
def is_executable(self, file_id, path=None):
554
603
if not path:
555
path = self._inventory.id2path(file_id)
604
file_id = osutils.safe_file_id(file_id)
605
path = self.id2path(file_id)
556
606
mode = os.lstat(self.abspath(path)).st_mode
557
607
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
558
608
559
@needs_write_lock
560
def add(self, files, ids=None):
561
"""Make files versioned.
562
563
Note that the command line normally calls smart_add instead,
564
which can automatically recurse.
565
566
This adds the files to the inventory, so that they will be
567
recorded by the next commit.
568
569
files
570
List of paths to add, relative to the base of the tree.
571
572
ids
573
If set, use these instead of automatically generated ids.
574
Must be the same length as the list of files, but may
575
contain None for ids that are to be autogenerated.
576
577
TODO: Perhaps have an option to add the ids even if the files do
578
not (yet) exist.
579
580
TODO: Perhaps callback with the ids and paths as they're added.
581
"""
609
@needs_tree_write_lock
610
def _add(self, files, ids, kinds):
611
"""See MutableTree._add."""
582
612
# TODO: Re-adding a file that is removed in the working copy
583
613
# should probably put it back with the previous ID.
584
if isinstance(files, basestring):
585
assert(ids is None or isinstance(ids, basestring))
586
files = [files]
587
if ids is not None:
588
ids = [ids]
589
590
if ids is None:
591
ids = [None] * len(files)
592
else:
593
assert(len(ids) == len(files))
594
614
# the read and write working inventory should not occur in this
615
# function - they should be part of lock_write and unlock.
595
616
inv = self.read_working_inventory()
596
for f,file_id in zip(files, ids):
597
if self.is_control_filename(f):
598
raise BzrError("cannot add control file %s" % quotefn(f))
599
600
fp = splitpath(f)
601
602
if len(fp) == 0:
603
raise BzrError("cannot add top-level %r" % f)
604
605
fullpath = normpath(self.abspath(f))
606
607
try:
608
kind = file_kind(fullpath)
609
except OSError, e:
610
if e.errno == errno.ENOENT:
611
raise NoSuchFile(fullpath)
612
# maybe something better?
613
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
614
615
if not InventoryEntry.versionable_kind(kind):
616
raise BzrError('cannot add: not a versionable file ('
617
'i.e. regular file, symlink or directory): %s' % quotefn(f))
618
617
for f, file_id, kind in zip(files, ids, kinds):
618
assert kind is not None
619
619
if file_id is None:
620
620
inv.add_path(f, kind=kind)
621
621
else:
622
file_id = osutils.safe_file_id(file_id)
622
623
inv.add_path(f, kind=kind, file_id=file_id)
623
624
624
self._write_inventory(inv)
625
625
626
@needs_tree_write_lock
627
def _gather_kinds(self, files, kinds):
628
"""See MutableTree._gather_kinds."""
629
for pos, f in enumerate(files):
630
if kinds[pos] is None:
631
fullpath = normpath(self.abspath(f))
632
try:
633
kinds[pos] = file_kind(fullpath)
634
except OSError, e:
635
if e.errno == errno.ENOENT:
636
raise errors.NoSuchFile(fullpath)
637
626
638
@needs_write_lock
639
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
640
"""Add revision_id as a parent.
641
642
This is equivalent to retrieving the current list of parent ids
643
and setting the list to its value plus revision_id.
644
645
:param revision_id: The revision id to add to the parent list. It may
646
be a ghost revision as long as its not the first parent to be added,
647
or the allow_leftmost_as_ghost parameter is set True.
648
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
649
"""
650
parents = self.get_parent_ids() + [revision_id]
651
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
652
or allow_leftmost_as_ghost)
653
654
@needs_tree_write_lock
655
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
656
"""Add revision_id, tree tuple as a parent.
657
658
This is equivalent to retrieving the current list of parent trees
659
and setting the list to its value plus parent_tuple. See also
660
add_parent_tree_id - if you only have a parent id available it will be
661
simpler to use that api. If you have the parent already available, using
662
this api is preferred.
663
664
:param parent_tuple: The (revision id, tree) to add to the parent list.
665
If the revision_id is a ghost, pass None for the tree.
666
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
667
"""
668
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
669
if len(parent_ids) > 1:
670
# the leftmost may have already been a ghost, preserve that if it
671
# was.
672
allow_leftmost_as_ghost = True
673
self.set_parent_ids(parent_ids,
674
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
675
676
@needs_tree_write_lock
627
677
def add_pending_merge(self, *revision_ids):
628
678
# TODO: Perhaps should check at this point that the
629
679
# history of the revision is actually present?
630
p = self.pending_merges()
680
parents = self.get_parent_ids()
631
681
updated = False
632
682
for rev_id in revision_ids:
633
if rev_id in p:
683
if rev_id in parents:
634
684
continue
635
p.append(rev_id)
685
parents.append(rev_id)
636
686
updated = True
637
687
if updated:
638
self.set_pending_merges(p)
688
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
639
689
690
@deprecated_method(zero_eleven)
640
691
@needs_read_lock
641
692
def pending_merges(self):
642
693
"""Return a list of pending merges.
643
694
644
695
These are revisions that have been merged into the working
645
696
directory but not yet committed.
646
"""
647
try:
648
merges_file = self._control_files.get_utf8('pending-merges')
649
except OSError, e:
650
if e.errno != errno.ENOENT:
651
raise
652
return []
653
p = []
654
for l in merges_file.readlines():
655
p.append(l.rstrip('\n'))
656
return p
657
658
@needs_write_lock
697
698
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
699
instead - which is available on all tree objects.
700
"""
701
return self.get_parent_ids()[1:]
702
703
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
704
"""Common ghost checking functionality from set_parent_*.
705
706
This checks that the left hand-parent exists if there are any
707
revisions present.
708
"""
709
if len(revision_ids) > 0:
710
leftmost_id = revision_ids[0]
711
if (not allow_leftmost_as_ghost and not
712
self.branch.repository.has_revision(leftmost_id)):
713
raise errors.GhostRevisionUnusableHere(leftmost_id)
714
715
def _set_merges_from_parent_ids(self, parent_ids):
716
merges = parent_ids[1:]
717
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
718
719
@needs_tree_write_lock
720
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
721
"""Set the parent ids to revision_ids.
722
723
See also set_parent_trees. This api will try to retrieve the tree data
724
for each element of revision_ids from the trees repository. If you have
725
tree data already available, it is more efficient to use
726
set_parent_trees rather than set_parent_ids. set_parent_ids is however
727
an easier API to use.
728
729
:param revision_ids: The revision_ids to set as the parent ids of this
730
working tree. Any of these may be ghosts.
731
"""
732
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
733
self._check_parents_for_ghosts(revision_ids,
734
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
735
736
if len(revision_ids) > 0:
737
self.set_last_revision(revision_ids[0])
738
else:
739
self.set_last_revision(None)
740
741
self._set_merges_from_parent_ids(revision_ids)
742
743
@needs_tree_write_lock
744
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
745
"""See MutableTree.set_parent_trees."""
746
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
747
748
self._check_parents_for_ghosts(parent_ids,
749
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
750
751
if len(parent_ids) == 0:
752
leftmost_parent_id = None
753
leftmost_parent_tree = None
754
else:
755
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
756
757
if self._change_last_revision(leftmost_parent_id):
758
if leftmost_parent_tree is None:
759
# If we don't have a tree, fall back to reading the
760
# parent tree from the repository.
761
self._cache_basis_inventory(leftmost_parent_id)
762
else:
763
inv = leftmost_parent_tree.inventory
764
xml = self._create_basis_xml_from_inventory(
765
leftmost_parent_id, inv)
766
self._write_basis_inventory(xml)
767
self._set_merges_from_parent_ids(parent_ids)
768
769
@needs_tree_write_lock
659
770
def set_pending_merges(self, rev_list):
660
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
771
parents = self.get_parent_ids()
772
leftmost = parents[:1]
773
new_parents = leftmost + rev_list
774
self.set_parent_ids(new_parents)
661
775
662
@needs_write_lock
776
@needs_tree_write_lock
663
777
def set_merge_modified(self, modified_hashes):
664
778
def iter_stanzas():
665
779
for file_id, hash in modified_hashes.iteritems():
666
yield Stanza(file_id=file_id, hash=hash)
780
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
667
781
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
668
782
669
@needs_write_lock
670
783
def _put_rio(self, filename, stanzas, header):
784
self._must_be_locked()
671
785
my_file = rio_file(stanzas, header)
672
786
self._control_files.put(filename, my_file)
673
787
788
@needs_write_lock # because merge pulls data into the branch.
789
def merge_from_branch(self, branch, to_revision=None):
790
"""Merge from a branch into this working tree.
791
792
:param branch: The branch to merge from.
793
:param to_revision: If non-None, the merge will merge to to_revision,
794
but not beyond it. to_revision does not need to be in the history
795
of the branch when it is supplied. If None, to_revision defaults to
796
branch.last_revision().
797
"""
798
from bzrlib.merge import Merger, Merge3Merger
799
pb = bzrlib.ui.ui_factory.nested_progress_bar()
800
try:
801
merger = Merger(self.branch, this_tree=self, pb=pb)
802
merger.pp = ProgressPhase("Merge phase", 5, pb)
803
merger.pp.next_phase()
804
# check that there are no
805
# local alterations
806
merger.check_basis(check_clean=True, require_commits=False)
807
if to_revision is None:
808
to_revision = branch.last_revision()
809
else:
810
to_revision = osutils.safe_revision_id(to_revision)
811
merger.other_rev_id = to_revision
812
if merger.other_rev_id is None:
813
raise error.NoCommits(branch)
814
self.branch.fetch(branch, last_revision=merger.other_rev_id)
815
merger.other_basis = merger.other_rev_id
816
merger.other_tree = self.branch.repository.revision_tree(
817
merger.other_rev_id)
818
merger.other_branch = branch
819
merger.pp.next_phase()
820
merger.find_base()
821
if merger.base_rev_id == merger.other_rev_id:
822
raise errors.PointlessMerge
823
merger.backup_files = False
824
merger.merge_type = Merge3Merger
825
merger.set_interesting_files(None)
826
merger.show_base = False
827
merger.reprocess = False
828
conflicts = merger.do_merge()
829
merger.set_pending()
830
finally:
831
pb.finished()
832
return conflicts
833
674
834
@needs_read_lock
675
835
def merge_modified(self):
836
"""Return a dictionary of files modified by a merge.
837
838
The list is initialized by WorkingTree.set_merge_modified, which is
839
typically called after we make some automatic updates to the tree
840
because of a merge.
841
842
This returns a map of file_id->sha1, containing only files which are
843
still in the working inventory and have that text hash.
844
"""
676
845
try:
677
846
hashfile = self._control_files.get('merge-hashes')
678
except NoSuchFile:
847
except errors.NoSuchFile:
679
848
return {}
680
849
merge_hashes = {}
681
850
try:
682
851
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
683
raise MergeModifiedFormatError()
852
raise errors.MergeModifiedFormatError()
684
853
except StopIteration:
685
raise MergeModifiedFormatError()
854
raise errors.MergeModifiedFormatError()
686
855
for s in RioReader(hashfile):
687
file_id = s.get("file_id")
856
# RioReader reads in Unicode, so convert file_ids back to utf8
857
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
688
858
if file_id not in self.inventory:
689
859
continue
690
hash = s.get("hash")
691
if hash == self.get_file_sha1(file_id):
692
merge_hashes[file_id] = hash
860
text_hash = s.get("hash")
861
if text_hash == self.get_file_sha1(file_id):
862
merge_hashes[file_id] = text_hash
693
863
return merge_hashes
694
864
865
@needs_write_lock
866
def mkdir(self, path, file_id=None):
867
"""See MutableTree.mkdir()."""
868
if file_id is None:
869
file_id = generate_ids.gen_file_id(os.path.basename(path))
870
os.mkdir(self.abspath(path))
871
self.add(path, file_id, 'directory')
872
return file_id
873
695
874
def get_symlink_target(self, file_id):
875
file_id = osutils.safe_file_id(file_id)
696
876
return os.readlink(self.id2abspath(file_id))
697
877
698
def file_class(self, filename):
699
if self.path2id(filename):
700
return 'V'
701
elif self.is_ignored(filename):
702
return 'I'
703
else:
704
return '?'
705
706
def list_files(self):
878
@needs_write_lock
879
def subsume(self, other_tree):
880
def add_children(inventory, entry):
881
for child_entry in entry.children.values():
882
inventory._byid[child_entry.file_id] = child_entry
883
if child_entry.kind == 'directory':
884
add_children(inventory, child_entry)
885
if other_tree.get_root_id() == self.get_root_id():
886
raise errors.BadSubsumeSource(self, other_tree,
887
'Trees have the same root')
888
try:
889
other_tree_path = self.relpath(other_tree.basedir)
890
except errors.PathNotChild:
891
raise errors.BadSubsumeSource(self, other_tree,
892
'Tree is not contained by the other')
893
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
894
if new_root_parent is None:
895
raise errors.BadSubsumeSource(self, other_tree,
896
'Parent directory is not versioned.')
897
# We need to ensure that the result of a fetch will have a
898
# versionedfile for the other_tree root, and only fetching into
899
# RepositoryKnit2 guarantees that.
900
if not self.branch.repository.supports_rich_root():
901
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
902
other_tree.lock_tree_write()
903
try:
904
new_parents = other_tree.get_parent_ids()
905
other_root = other_tree.inventory.root
906
other_root.parent_id = new_root_parent
907
other_root.name = osutils.basename(other_tree_path)
908
self.inventory.add(other_root)
909
add_children(self.inventory, other_root)
910
self._write_inventory(self.inventory)
911
# normally we don't want to fetch whole repositories, but i think
912
# here we really do want to consolidate the whole thing.
913
for parent_id in other_tree.get_parent_ids():
914
self.branch.fetch(other_tree.branch, parent_id)
915
self.add_parent_tree_id(parent_id)
916
finally:
917
other_tree.unlock()
918
other_tree.bzrdir.retire_bzrdir()
919
920
@needs_tree_write_lock
921
def extract(self, file_id, format=None):
922
"""Extract a subtree from this tree.
923
924
A new branch will be created, relative to the path for this tree.
925
"""
926
self.flush()
927
def mkdirs(path):
928
segments = osutils.splitpath(path)
929
transport = self.branch.bzrdir.root_transport
930
for name in segments:
931
transport = transport.clone(name)
932
try:
933
transport.mkdir('.')
934
except errors.FileExists:
935
pass
936
return transport
937
938
sub_path = self.id2path(file_id)
939
branch_transport = mkdirs(sub_path)
940
if format is None:
941
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
942
try:
943
branch_transport.mkdir('.')
944
except errors.FileExists:
945
pass
946
branch_bzrdir = format.initialize_on_transport(branch_transport)
947
try:
948
repo = branch_bzrdir.find_repository()
949
except errors.NoRepositoryPresent:
950
repo = branch_bzrdir.create_repository()
951
assert repo.supports_rich_root()
952
else:
953
if not repo.supports_rich_root():
954
raise errors.RootNotRich()
955
new_branch = branch_bzrdir.create_branch()
956
new_branch.pull(self.branch)
957
for parent_id in self.get_parent_ids():
958
new_branch.fetch(self.branch, parent_id)
959
tree_transport = self.bzrdir.root_transport.clone(sub_path)
960
if tree_transport.base != branch_transport.base:
961
tree_bzrdir = format.initialize_on_transport(tree_transport)
962
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
963
else:
964
tree_bzrdir = branch_bzrdir
965
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
966
wt.set_parent_ids(self.get_parent_ids())
967
my_inv = self.inventory
968
child_inv = Inventory(root_id=None)
969
new_root = my_inv[file_id]
970
my_inv.remove_recursive_id(file_id)
971
new_root.parent_id = None
972
child_inv.add(new_root)
973
self._write_inventory(my_inv)
974
wt._write_inventory(child_inv)
975
return wt
976
977
def _serialize(self, inventory, out_file):
978
xml5.serializer_v5.write_inventory(self._inventory, out_file)
979
980
def _deserialize(selt, in_file):
981
return xml5.serializer_v5.read_inventory(in_file)
982
983
def flush(self):
984
"""Write the in memory inventory to disk."""
985
# TODO: Maybe this should only write on dirty ?
986
if self._control_files._lock_mode != 'w':
987
raise errors.NotWriteLocked(self)
988
sio = StringIO()
989
self._serialize(self._inventory, sio)
990
sio.seek(0)
991
self._control_files.put('inventory', sio)
992
self._inventory_is_modified = False
993
994
def _kind(self, relpath):
995
return osutils.file_kind(self.abspath(relpath))
996
997
def list_files(self, include_root=False):
707
998
"""Recursively list all files as (path, class, kind, id, entry).
708
999
709
1000
Lists, but does not descend into unversioned directories.
713
1004
714
1005
Skips the control directory.
715
1006
"""
716
inv = self._inventory
1007
# list_files is an iterator, so @needs_read_lock doesn't work properly
1008
# with it. So callers should be careful to always read_lock the tree.
1009
if not self.is_locked():
1010
raise errors.ObjectNotLocked(self)
1011
1012
inv = self.inventory
1013
if include_root is True:
1014
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
717
1015
# Convert these into local objects to save lookup times
718
pathjoin = bzrlib.osutils.pathjoin
719
file_kind = bzrlib.osutils.file_kind
1016
pathjoin = osutils.pathjoin
1017
file_kind = self._kind
720
1018
721
1019
# transport.base ends in a slash, we want the piece
722
1020
# between the last two slashes
760
1058
elif self.is_ignored(fp[1:]):
761
1059
c = 'I'
762
1060
else:
763
c = '?'
1061
# we may not have found this file, because of a unicode issue
1062
f_norm, can_access = osutils.normalized_filename(f)
1063
if f == f_norm or not can_access:
1064
# No change, so treat this file normally
1065
c = '?'
1066
else:
1067
# this file can be accessed by a normalized path
1068
# check again if it is versioned
1069
# these lines are repeated here for performance
1070
f = f_norm
1071
fp = from_dir_relpath + '/' + f
1072
fap = from_dir_abspath + '/' + f
1073
f_ie = inv.get_child(from_dir_id, f)
1074
if f_ie:
1075
c = 'V'
1076
elif self.is_ignored(fp[1:]):
1077
c = 'I'
1078
else:
1079
c = '?'
764
1080
765
1081
fk = file_kind(fap)
766
1082
767
if f_ie:
768
if f_ie.kind != fk:
769
raise BzrCheckError("file %r entered as kind %r id %r, "
770
"now of kind %r"
771
% (fap, f_ie.kind, f_ie.file_id, fk))
772
773
1083
# make a last minute entry
774
1084
if f_ie:
775
1085
yield fp[1:], c, fk, f_ie.file_id, f_ie
788
1098
new_children.sort()
789
1099
new_children = collections.deque(new_children)
790
1100
stack.append((f_ie.file_id, fp, fap, new_children))
791
# Break out of inner loop, so that we start outer loop with child
1101
# Break out of inner loop,
1102
# so that we start outer loop with child
792
1103
break
793
1104
else:
794
1105
# if we finished all children, pop it off the stack
795
1106
stack.pop()
796
1107
797
798
@needs_write_lock
799
def move(self, from_paths, to_name):
1108
@needs_tree_write_lock
1109
def move(self, from_paths, to_dir=None, after=False, **kwargs):
800
1110
"""Rename files.
801
1111
802
to_name must exist in the inventory.
1112
to_dir must exist in the inventory.
803
1113
804
If to_name exists and is a directory, the files are moved into
1114
If to_dir exists and is a directory, the files are moved into
805
1115
it, keeping their old names.
806
1116
807
Note that to_name is only the last component of the new name;
1117
Note that to_dir is only the last component of the new name;
808
1118
this doesn't change the directory.
809
1119
1120
For each entry in from_paths the move mode will be determined
1121
independently.
1122
1123
The first mode moves the file in the filesystem and updates the
1124
inventory. The second mode only updates the inventory without
1125
touching the file on the filesystem. This is the new mode introduced
1126
in version 0.15.
1127
1128
move uses the second mode if 'after == True' and the target is not
1129
versioned but present in the working tree.
1130
1131
move uses the second mode if 'after == False' and the source is
1132
versioned but no longer in the working tree, and the target is not
1133
versioned but present in the working tree.
1134
1135
move uses the first mode if 'after == False' and the source is
1136
versioned and present in the working tree, and the target is not
1137
versioned and not present in the working tree.
1138
1139
Everything else results in an error.
1140
810
1141
This returns a list of (from_path, to_path) pairs for each
811
1142
entry that is moved.
812
1143
"""
813
result = []
814
## TODO: Option to move IDs only
1144
rename_entries = []
1145
rename_tuples = []
1146
1147
# check for deprecated use of signature
1148
if to_dir is None:
1149
to_dir = kwargs.get('to_name', None)
1150
if to_dir is None:
1151
raise TypeError('You must supply a target directory')
1152
else:
1153
symbol_versioning.warn('The parameter to_name was deprecated'
1154
' in version 0.13. Use to_dir instead',
1155
DeprecationWarning)
1156
1157
# check destination directory
815
1158
assert not isinstance(from_paths, basestring)
816
1159
inv = self.inventory
817
to_abs = self.abspath(to_name)
1160
to_abs = self.abspath(to_dir)
818
1161
if not isdir(to_abs):
819
raise BzrError("destination %r is not a directory" % to_abs)
820
if not self.has_filename(to_name):
821
raise BzrError("destination %r not in working directory" % to_abs)
822
to_dir_id = inv.path2id(to_name)
823
if to_dir_id == None and to_name != '':
824
raise BzrError("destination %r is not a versioned directory" % to_name)
1162
raise errors.BzrMoveFailedError('',to_dir,
1163
errors.NotADirectory(to_abs))
1164
if not self.has_filename(to_dir):
1165
raise errors.BzrMoveFailedError('',to_dir,
1166
errors.NotInWorkingDirectory(to_dir))
1167
to_dir_id = inv.path2id(to_dir)
1168
if to_dir_id is None:
1169
raise errors.BzrMoveFailedError('',to_dir,
1170
errors.NotVersionedError(path=str(to_dir)))
1171
825
1172
to_dir_ie = inv[to_dir_id]
826
if to_dir_ie.kind not in ('directory', 'root_directory'):
827
raise BzrError("destination %r is not a directory" % to_abs)
828
829
to_idpath = inv.get_idpath(to_dir_id)
830
831
for f in from_paths:
832
if not self.has_filename(f):
833
raise BzrError("%r does not exist in working tree" % f)
834
f_id = inv.path2id(f)
835
if f_id == None:
836
raise BzrError("%r is not versioned" % f)
837
name_tail = splitpath(f)[-1]
838
dest_path = pathjoin(to_name, name_tail)
839
if self.has_filename(dest_path):
840
raise BzrError("destination %r already exists" % dest_path)
841
if f_id in to_idpath:
842
raise BzrError("can't move %r to a subdirectory of itself" % f)
843
844
# OK, so there's a race here, it's possible that someone will
845
# create a file in this interval and then the rename might be
846
# left half-done. But we should have caught most problems.
847
orig_inv = deepcopy(self.inventory)
1173
if to_dir_ie.kind != 'directory':
1174
raise errors.BzrMoveFailedError('',to_dir,
1175
errors.NotADirectory(to_abs))
1176
1177
# create rename entries and tuples
1178
for from_rel in from_paths:
1179
from_tail = splitpath(from_rel)[-1]
1180
from_id = inv.path2id(from_rel)
1181
if from_id is None:
1182
raise errors.BzrMoveFailedError(from_rel,to_dir,
1183
errors.NotVersionedError(path=str(from_rel)))
1184
1185
from_entry = inv[from_id]
1186
from_parent_id = from_entry.parent_id
1187
to_rel = pathjoin(to_dir, from_tail)
1188
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1189
from_id=from_id,
1190
from_tail=from_tail,
1191
from_parent_id=from_parent_id,
1192
to_rel=to_rel, to_tail=from_tail,
1193
to_parent_id=to_dir_id)
1194
rename_entries.append(rename_entry)
1195
rename_tuples.append((from_rel, to_rel))
1196
1197
# determine which move mode to use. checks also for movability
1198
rename_entries = self._determine_mv_mode(rename_entries, after)
1199
1200
original_modified = self._inventory_is_modified
848
1201
try:
849
for f in from_paths:
850
name_tail = splitpath(f)[-1]
851
dest_path = pathjoin(to_name, name_tail)
852
result.append((f, dest_path))
853
inv.rename(inv.path2id(f), to_dir_id, name_tail)
854
try:
855
rename(self.abspath(f), self.abspath(dest_path))
856
except OSError, e:
857
raise BzrError("failed to rename %r to %r: %s" %
858
(f, dest_path, e[1]),
859
["rename rolled back"])
1202
if len(from_paths):
1203
self._inventory_is_modified = True
1204
self._move(rename_entries)
860
1205
except:
861
1206
# restore the inventory on error
862
self._set_inventory(orig_inv)
1207
self._inventory_is_modified = original_modified
863
1208
raise
864
1209
self._write_inventory(inv)
865
return result
866
867
@needs_write_lock
868
def rename_one(self, from_rel, to_rel):
1210
return rename_tuples
1211
1212
def _determine_mv_mode(self, rename_entries, after=False):
1213
"""Determines for each from-to pair if both inventory and working tree
1214
or only the inventory has to be changed.
1215
1216
Also does basic plausability tests.
1217
"""
1218
inv = self.inventory
1219
1220
for rename_entry in rename_entries:
1221
# store to local variables for easier reference
1222
from_rel = rename_entry.from_rel
1223
from_id = rename_entry.from_id
1224
to_rel = rename_entry.to_rel
1225
to_id = inv.path2id(to_rel)
1226
only_change_inv = False
1227
1228
# check the inventory for source and destination
1229
if from_id is None:
1230
raise errors.BzrMoveFailedError(from_rel,to_rel,
1231
errors.NotVersionedError(path=str(from_rel)))
1232
if to_id is not None:
1233
raise errors.BzrMoveFailedError(from_rel,to_rel,
1234
errors.AlreadyVersionedError(path=str(to_rel)))
1235
1236
# try to determine the mode for rename (only change inv or change
1237
# inv and file system)
1238
if after:
1239
if not self.has_filename(to_rel):
1240
raise errors.BzrMoveFailedError(from_id,to_rel,
1241
errors.NoSuchFile(path=str(to_rel),
1242
extra="New file has not been created yet"))
1243
only_change_inv = True
1244
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1245
only_change_inv = True
1246
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1247
only_change_inv = False
1248
else:
1249
# something is wrong, so lets determine what exactly
1250
if not self.has_filename(from_rel) and \
1251
not self.has_filename(to_rel):
1252
raise errors.BzrRenameFailedError(from_rel,to_rel,
1253
errors.PathsDoNotExist(paths=(str(from_rel),
1254
str(to_rel))))
1255
else:
1256
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1257
extra="(Use --after to update the Bazaar id)")
1258
rename_entry.only_change_inv = only_change_inv
1259
return rename_entries
1260
1261
def _move(self, rename_entries):
1262
"""Moves a list of files.
1263
1264
Depending on the value of the flag 'only_change_inv', the
1265
file will be moved on the file system or not.
1266
"""
1267
inv = self.inventory
1268
moved = []
1269
1270
for entry in rename_entries:
1271
try:
1272
self._move_entry(entry)
1273
except:
1274
self._rollback_move(moved)
1275
raise
1276
moved.append(entry)
1277
1278
def _rollback_move(self, moved):
1279
"""Try to rollback a previous move in case of an filesystem error."""
1280
inv = self.inventory
1281
for entry in moved:
1282
try:
1283
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1284
entry.to_tail, entry.to_parent_id, entry.from_rel,
1285
entry.from_tail, entry.from_parent_id,
1286
entry.only_change_inv))
1287
except errors.BzrMoveFailedError, e:
1288
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1289
" The working tree is in an inconsistent state."
1290
" Please consider doing a 'bzr revert'."
1291
" Error message is: %s" % e)
1292
1293
def _move_entry(self, entry):
1294
inv = self.inventory
1295
from_rel_abs = self.abspath(entry.from_rel)
1296
to_rel_abs = self.abspath(entry.to_rel)
1297
if from_rel_abs == to_rel_abs:
1298
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1299
"Source and target are identical.")
1300
1301
if not entry.only_change_inv:
1302
try:
1303
osutils.rename(from_rel_abs, to_rel_abs)
1304
except OSError, e:
1305
raise errors.BzrMoveFailedError(entry.from_rel,
1306
entry.to_rel, e[1])
1307
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1308
1309
@needs_tree_write_lock
1310
def rename_one(self, from_rel, to_rel, after=False):
869
1311
"""Rename one file.
870
1312
871
1313
This can change the directory or the filename or both.
1314
1315
rename_one has several 'modes' to work. First, it can rename a physical
1316
file and change the file_id. That is the normal mode. Second, it can
1317
only change the file_id without touching any physical file. This is
1318
the new mode introduced in version 0.15.
1319
1320
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1321
versioned but present in the working tree.
1322
1323
rename_one uses the second mode if 'after == False' and 'from_rel' is
1324
versioned but no longer in the working tree, and 'to_rel' is not
1325
versioned but present in the working tree.
1326
1327
rename_one uses the first mode if 'after == False' and 'from_rel' is
1328
versioned and present in the working tree, and 'to_rel' is not
1329
versioned and not present in the working tree.
1330
1331
Everything else results in an error.
872
1332
"""
873
1333
inv = self.inventory
874
if not self.has_filename(from_rel):
875
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
876
if self.has_filename(to_rel):
877
raise BzrError("can't rename: new working file %r already exists" % to_rel)
878
879
file_id = inv.path2id(from_rel)
880
if file_id == None:
881
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
882
883
entry = inv[file_id]
884
from_parent = entry.parent_id
885
from_name = entry.name
886
887
if inv.path2id(to_rel):
888
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
889
1334
rename_entries = []
1335
1336
# create rename entries and tuples
1337
from_tail = splitpath(from_rel)[-1]
1338
from_id = inv.path2id(from_rel)
1339
if from_id is None:
1340
raise errors.BzrRenameFailedError(from_rel,to_rel,
1341
errors.NotVersionedError(path=str(from_rel)))
1342
from_entry = inv[from_id]
1343
from_parent_id = from_entry.parent_id
890
1344
to_dir, to_tail = os.path.split(to_rel)
891
1345
to_dir_id = inv.path2id(to_dir)
892
if to_dir_id == None and to_dir != '':
893
raise BzrError("can't determine destination directory id for %r" % to_dir)
894
895
mutter("rename_one:")
896
mutter(" file_id {%s}" % file_id)
897
mutter(" from_rel %r" % from_rel)
898
mutter(" to_rel %r" % to_rel)
899
mutter(" to_dir %r" % to_dir)
900
mutter(" to_dir_id {%s}" % to_dir_id)
901
902
inv.rename(file_id, to_dir_id, to_tail)
903
904
from_abs = self.abspath(from_rel)
905
to_abs = self.abspath(to_rel)
906
try:
907
rename(from_abs, to_abs)
908
except OSError, e:
909
inv.rename(file_id, from_parent, from_name)
910
raise BzrError("failed to rename %r to %r: %s"
911
% (from_abs, to_abs, e[1]),
912
["rename rolled back"])
1346
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1347
from_id=from_id,
1348
from_tail=from_tail,
1349
from_parent_id=from_parent_id,
1350
to_rel=to_rel, to_tail=to_tail,
1351
to_parent_id=to_dir_id)
1352
rename_entries.append(rename_entry)
1353
1354
# determine which move mode to use. checks also for movability
1355
rename_entries = self._determine_mv_mode(rename_entries, after)
1356
1357
# check if the target changed directory and if the target directory is
1358
# versioned
1359
if to_dir_id is None:
1360
raise errors.BzrMoveFailedError(from_rel,to_rel,
1361
errors.NotVersionedError(path=str(to_dir)))
1362
1363
# all checks done. now we can continue with our actual work
1364
mutter('rename_one:\n'
1365
' from_id {%s}\n'
1366
' from_rel: %r\n'
1367
' to_rel: %r\n'
1368
' to_dir %r\n'
1369
' to_dir_id {%s}\n',
1370
from_id, from_rel, to_rel, to_dir, to_dir_id)
1371
1372
self._move(rename_entries)
913
1373
self._write_inventory(inv)
914
1374
1375
class _RenameEntry(object):
1376
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1377
to_rel, to_tail, to_parent_id, only_change_inv=False):
1378
self.from_rel = from_rel
1379
self.from_id = from_id
1380
self.from_tail = from_tail
1381
self.from_parent_id = from_parent_id
1382
self.to_rel = to_rel
1383
self.to_tail = to_tail
1384
self.to_parent_id = to_parent_id
1385
self.only_change_inv = only_change_inv
1386
915
1387
@needs_read_lock
916
1388
def unknowns(self):
917
1389
"""Return all unknown files.
918
1390
919
1391
These are files in the working directory that are not versioned or
920
1392
control files or ignored.
921
922
>>> from bzrlib.bzrdir import ScratchDir
923
>>> d = ScratchDir(files=['foo', 'foo~'])
924
>>> b = d.open_branch()
925
>>> tree = d.open_workingtree()
926
>>> map(str, tree.unknowns())
927
['foo']
928
>>> tree.add('foo')
929
>>> list(b.unknowns())
930
[]
931
>>> tree.remove('foo')
932
>>> list(b.unknowns())
933
[u'foo']
934
"""
935
for subp in self.extras():
936
if not self.is_ignored(subp):
937
yield subp
938
1393
"""
1394
# force the extras method to be fully executed before returning, to
1395
# prevent race conditions with the lock
1396
return iter(
1397
[subp for subp in self.extras() if not self.is_ignored(subp)])
1398
1399
@needs_tree_write_lock
1400
def unversion(self, file_ids):
1401
"""Remove the file ids in file_ids from the current versioned set.
1402
1403
When a file_id is unversioned, all of its children are automatically
1404
unversioned.
1405
1406
:param file_ids: The file ids to stop versioning.
1407
:raises: NoSuchId if any fileid is not currently versioned.
1408
"""
1409
for file_id in file_ids:
1410
file_id = osutils.safe_file_id(file_id)
1411
if self._inventory.has_id(file_id):
1412
self._inventory.remove_recursive_id(file_id)
1413
else:
1414
raise errors.NoSuchId(self, file_id)
1415
if len(file_ids):
1416
# in the future this should just set a dirty bit to wait for the
1417
# final unlock. However, until all methods of workingtree start
1418
# with the current in -memory inventory rather than triggering
1419
# a read, it is more complex - we need to teach read_inventory
1420
# to know when to read, and when to not read first... and possibly
1421
# to save first when the in memory one may be corrupted.
1422
# so for now, we just only write it if it is indeed dirty.
1423
# - RBC 20060907
1424
self._write_inventory(self._inventory)
1425
939
1426
@deprecated_method(zero_eight)
940
1427
def iter_conflicts(self):
941
1428
"""List all files in the tree that have text or content conflicts.
954
1441
yield stem
955
1442
956
1443
@needs_write_lock
957
def pull(self, source, overwrite=False, stop_revision=None):
1444
def pull(self, source, overwrite=False, stop_revision=None,
1445
change_reporter=None):
958
1446
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
959
1447
source.lock_read()
960
1448
try:
961
1449
pp = ProgressPhase("Pull phase", 2, top_pb)
962
1450
pp.next_phase()
963
old_revision_history = self.branch.revision_history()
1451
old_revision_info = self.branch.last_revision_info()
964
1452
basis_tree = self.basis_tree()
965
1453
count = self.branch.pull(source, overwrite, stop_revision)
966
new_revision_history = self.branch.revision_history()
967
if new_revision_history != old_revision_history:
1454
new_revision_info = self.branch.last_revision_info()
1455
if new_revision_info != old_revision_info:
968
1456
pp.next_phase()
969
if len(old_revision_history):
970
other_revision = old_revision_history[-1]
971
else:
972
other_revision = None
973
1457
repository = self.branch.repository
974
1458
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1459
basis_tree.lock_read()
975
1460
try:
976
merge_inner(self.branch,
977
self.branch.basis_tree(),
978
basis_tree,
979
this_tree=self,
980
pb=pb)
1461
new_basis_tree = self.branch.basis_tree()
1462
merge.merge_inner(
1463
self.branch,
1464
new_basis_tree,
1465
basis_tree,
1466
this_tree=self,
1467
pb=pb,
1468
change_reporter=change_reporter)
1469
if (basis_tree.inventory.root is None and
1470
new_basis_tree.inventory.root is not None):
1471
self.set_root_id(new_basis_tree.inventory.root.file_id)
981
1472
finally:
982
1473
pb.finished()
983
self.set_last_revision(self.branch.last_revision())
1474
basis_tree.unlock()
1475
# TODO - dedup parents list with things merged by pull ?
1476
# reuse the revisiontree we merged against to set the new
1477
# tree data.
1478
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1479
# we have to pull the merge trees out again, because
1480
# merge_inner has set the ids. - this corner is not yet
1481
# layered well enough to prevent double handling.
1482
# XXX TODO: Fix the double handling: telling the tree about
1483
# the already known parent data is wasteful.
1484
merges = self.get_parent_ids()[1:]
1485
parent_trees.extend([
1486
(parent, repository.revision_tree(parent)) for
1487
parent in merges])
1488
self.set_parent_trees(parent_trees)
984
1489
return count
985
1490
finally:
986
1491
source.unlock()
987
1492
top_pb.finished()
988
1493
1494
@needs_write_lock
1495
def put_file_bytes_non_atomic(self, file_id, bytes):
1496
"""See MutableTree.put_file_bytes_non_atomic."""
1497
file_id = osutils.safe_file_id(file_id)
1498
stream = file(self.id2abspath(file_id), 'wb')
1499
try:
1500
stream.write(bytes)
1501
finally:
1502
stream.close()
1503
# TODO: update the hashcache here ?
1504
989
1505
def extras(self):
990
"""Yield all unknown files in this WorkingTree.
1506
"""Yield all unversioned files in this WorkingTree.
991
1507
992
If there are any unknown directories then only the directory is
993
returned, not all its children. But if there are unknown files
1508
If there are any unversioned directories then only the directory is
1509
returned, not all its children. But if there are unversioned files
994
1510
under a versioned subdirectory, they are returned.
995
1511
996
1512
Currently returned depth-first, sorted by name within directories.
1513
This is the same order used by 'osutils.walkdirs'.
997
1514
"""
998
1515
## TODO: Work from given directory downwards
999
1516
for path, dir_entry in self.inventory.directories():
1000
mutter("search for unknowns in %r", path)
1517
# mutter("search for unknowns in %r", path)
1001
1518
dirabs = self.abspath(path)
1002
1519
if not isdir(dirabs):
1003
1520
# e.g. directory deleted
1005
1522
1006
1523
fl = []
1007
1524
for subf in os.listdir(dirabs):
1008
if (subf != '.bzr'
1009
and (subf not in dir_entry.children)):
1010
fl.append(subf)
1525
if subf == '.bzr':
1526
continue
1527
if subf not in dir_entry.children:
1528
subf_norm, can_access = osutils.normalized_filename(subf)
1529
if subf_norm != subf and can_access:
1530
if subf_norm not in dir_entry.children:
1531
fl.append(subf_norm)
1532
else:
1533
fl.append(subf)
1011
1534
1012
1535
fl.sort()
1013
1536
for subf in fl:
1014
1537
subp = pathjoin(path, subf)
1015
1538
yield subp
1016
1539
1017
def _translate_ignore_rule(self, rule):
1018
"""Translate a single ignore rule to a regex.
1019
1020
There are two types of ignore rules. Those that do not contain a / are
1021
matched against the tail of the filename (that is, they do not care
1022
what directory the file is in.) Rules which do contain a slash must
1023
match the entire path. As a special case, './' at the start of the
1024
string counts as a slash in the string but is removed before matching
1025
(e.g. ./foo.c, ./src/foo.c)
1026
1027
:return: The translated regex.
1028
"""
1029
if rule[:2] in ('./', '.\\'):
1030
# rootdir rule
1031
result = fnmatch.translate(rule[2:])
1032
elif '/' in rule or '\\' in rule:
1033
# path prefix
1034
result = fnmatch.translate(rule)
1035
else:
1036
# default rule style.
1037
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1038
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1039
return "(" + result + ")"
1040
1041
def _combine_ignore_rules(self, rules):
1042
"""Combine a list of ignore rules into a single regex object.
1043
1044
Each individual rule is combined with | to form a big regex, which then
1045
has $ added to it to form something like ()|()|()$. The group index for
1046
each subregex's outermost group is placed in a dictionary mapping back
1047
to the rule. This allows quick identification of the matching rule that
1048
triggered a match.
1049
:return: a list of the compiled regex and the matching-group index
1050
dictionaries. We return a list because python complains if you try to
1051
combine more than 100 regexes.
1052
"""
1053
result = []
1054
groups = {}
1055
next_group = 0
1056
translated_rules = []
1057
for rule in rules:
1058
translated_rule = self._translate_ignore_rule(rule)
1059
compiled_rule = re.compile(translated_rule)
1060
groups[next_group] = rule
1061
next_group += compiled_rule.groups
1062
translated_rules.append(translated_rule)
1063
if next_group == 99:
1064
result.append((re.compile("|".join(translated_rules)), groups))
1065
groups = {}
1066
next_group = 0
1067
translated_rules = []
1068
if len(translated_rules):
1069
result.append((re.compile("|".join(translated_rules)), groups))
1070
return result
1071
1072
1540
def ignored_files(self):
1073
1541
"""Yield list of PATH, IGNORE_PATTERN"""
1074
1542
for subp in self.extras():
1075
1543
pat = self.is_ignored(subp)
1076
if pat != None:
1544
if pat is not None:
1077
1545
yield subp, pat
1078
1546
1079
1547
def get_ignore_list(self):
1081
1549
1082
1550
Cached in the Tree object after the first call.
1083
1551
"""
1084
if hasattr(self, '_ignorelist'):
1085
return self._ignorelist
1552
ignoreset = getattr(self, '_ignoreset', None)
1553
if ignoreset is not None:
1554
return ignoreset
1086
1555
1087
l = bzrlib.DEFAULT_IGNORE[:]
1556
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1557
ignore_globs.update(ignores.get_runtime_ignores())
1558
ignore_globs.update(ignores.get_user_ignores())
1088
1559
if self.has_filename(bzrlib.IGNORE_FILENAME):
1089
1560
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1090
l.extend([line.rstrip("\n\r").decode('utf-8')
1091
for line in f.readlines()])
1092
self._ignorelist = l
1093
self._ignore_regex = self._combine_ignore_rules(l)
1094
return l
1095
1096
def _get_ignore_rules_as_regex(self):
1097
"""Return a regex of the ignore rules and a mapping dict.
1098
1099
:return: (ignore rules compiled regex, dictionary mapping rule group
1100
indices to original rule.)
1101
"""
1102
if getattr(self, '_ignorelist', None) is None:
1103
self.get_ignore_list()
1104
return self._ignore_regex
1561
try:
1562
ignore_globs.update(ignores.parse_ignore_file(f))
1563
finally:
1564
f.close()
1565
self._ignoreset = ignore_globs
1566
return ignore_globs
1567
1568
def _flush_ignore_list_cache(self):
1569
"""Resets the cached ignore list to force a cache rebuild."""
1570
self._ignoreset = None
1571
self._ignoreglobster = None
1105
1572
1106
1573
def is_ignored(self, filename):
1107
1574
r"""Check whether the filename matches an ignore pattern.
1112
1579
If the file is ignored, returns the pattern which caused it to
1113
1580
be ignored, otherwise None. So this can simply be used as a
1114
1581
boolean if desired."""
1115
1116
# TODO: Use '**' to match directories, and other extended
1117
# globbing stuff from cvs/rsync.
1118
1119
# XXX: fnmatch is actually not quite what we want: it's only
1120
# approximately the same as real Unix fnmatch, and doesn't
1121
# treat dotfiles correctly and allows * to match /.
1122
# Eventually it should be replaced with something more
1123
# accurate.
1124
1125
rules = self._get_ignore_rules_as_regex()
1126
for regex, mapping in rules:
1127
match = regex.match(filename)
1128
if match is not None:
1129
# one or more of the groups in mapping will have a non-None group
1130
# match.
1131
groups = match.groups()
1132
rules = [mapping[group] for group in
1133
mapping if groups[group] is not None]
1134
return rules[0]
1135
return None
1582
if getattr(self, '_ignoreglobster', None) is None:
1583
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1584
return self._ignoreglobster.match(filename)
1136
1585
1137
1586
def kind(self, file_id):
1138
1587
return file_kind(self.id2abspath(file_id))
1139
1588
1140
@needs_read_lock
1589
def _comparison_data(self, entry, path):
1590
abspath = self.abspath(path)
1591
try:
1592
stat_value = os.lstat(abspath)
1593
except OSError, e:
1594
if getattr(e, 'errno', None) == errno.ENOENT:
1595
stat_value = None
1596
kind = None
1597
executable = False
1598
else:
1599
raise
1600
else:
1601
mode = stat_value.st_mode
1602
kind = osutils.file_kind_from_stat_mode(mode)
1603
if not supports_executable():
1604
executable = entry.executable
1605
else:
1606
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1607
return kind, executable, stat_value
1608
1609
def _file_size(self, entry, stat_value):
1610
return stat_value.st_size
1611
1141
1612
def last_revision(self):
1142
"""Return the last revision id of this working tree.
1143
1144
In early branch formats this was == the branch last_revision,
1145
but that cannot be relied upon - for working tree operations,
1146
always use tree.last_revision().
1613
"""Return the last revision of the branch for this tree.
1614
1615
This format tree does not support a separate marker for last-revision
1616
compared to the branch.
1617
1618
See MutableTree.last_revision
1147
1619
"""
1620
return self._last_revision()
1621
1622
@needs_read_lock
1623
def _last_revision(self):
1624
"""helper for get_parent_ids."""
1148
1625
return self.branch.last_revision()
1149
1626
1150
1627
def is_locked(self):
1151
1628
return self._control_files.is_locked()
1152
1629
1630
def _must_be_locked(self):
1631
if not self.is_locked():
1632
raise errors.ObjectNotLocked(self)
1633
1153
1634
def lock_read(self):
1154
1635
"""See Branch.lock_read, and WorkingTree.unlock."""
1636
if not self.is_locked():
1637
self._reset_data()
1155
1638
self.branch.lock_read()
1156
1639
try:
1157
1640
return self._control_files.lock_read()
1159
1642
self.branch.unlock()
1160
1643
raise
1161
1644
1645
def lock_tree_write(self):
1646
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1647
if not self.is_locked():
1648
self._reset_data()
1649
self.branch.lock_read()
1650
try:
1651
return self._control_files.lock_write()
1652
except:
1653
self.branch.unlock()
1654
raise
1655
1162
1656
def lock_write(self):
1163
"""See Branch.lock_write, and WorkingTree.unlock."""
1657
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1658
if not self.is_locked():
1659
self._reset_data()
1164
1660
self.branch.lock_write()
1165
1661
try:
1166
1662
return self._control_files.lock_write()
1172
1668
return self._control_files.get_physical_lock_status()
1173
1669
1174
1670
def _basis_inventory_name(self):
1175
return 'basis-inventory'
1176
1177
@needs_write_lock
1671
return 'basis-inventory-cache'
1672
1673
def _reset_data(self):
1674
"""Reset transient data that cannot be revalidated."""
1675
self._inventory_is_modified = False
1676
result = self._deserialize(self._control_files.get('inventory'))
1677
self._set_inventory(result, dirty=False)
1678
1679
@needs_tree_write_lock
1178
1680
def set_last_revision(self, new_revision):
1179
1681
"""Change the last revision in the working tree."""
1682
new_revision = osutils.safe_revision_id(new_revision)
1180
1683
if self._change_last_revision(new_revision):
1181
1684
self._cache_basis_inventory(new_revision)
1182
1685
1189
1692
if new_revision is None:
1190
1693
self.branch.set_revision_history([])
1191
1694
return False
1192
# current format is locked in with the branch
1193
revision_history = self.branch.revision_history()
1194
1695
try:
1195
position = revision_history.index(new_revision)
1196
except ValueError:
1197
raise errors.NoSuchRevision(self.branch, new_revision)
1198
self.branch.set_revision_history(revision_history[:position + 1])
1696
self.branch.generate_revision_history(new_revision)
1697
except errors.NoSuchRevision:
1698
# not present in the repo - dont try to set it deeper than the tip
1699
self.branch.set_revision_history([new_revision])
1199
1700
return True
1200
1701
1702
def _write_basis_inventory(self, xml):
1703
"""Write the basis inventory XML to the basis-inventory file"""
1704
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1705
path = self._basis_inventory_name()
1706
sio = StringIO(xml)
1707
self._control_files.put(path, sio)
1708
1709
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1710
"""Create the text that will be saved in basis-inventory"""
1711
# TODO: jam 20070209 This should be redundant, as the revision_id
1712
# as all callers should have already converted the revision_id to
1713
# utf8
1714
inventory.revision_id = osutils.safe_revision_id(revision_id)
1715
return xml7.serializer_v7.write_inventory_to_string(inventory)
1716
1201
1717
def _cache_basis_inventory(self, new_revision):
1202
1718
"""Cache new_revision as the basis inventory."""
1203
1719
# TODO: this should allow the ready-to-use inventory to be passed in,
1215
1731
# root node id can legitimately look like 'revision_id' but cannot
1216
1732
# contain a '"'.
1217
1733
xml = self.branch.repository.get_inventory_xml(new_revision)
1218
if not 'revision_id="' in xml.split('\n', 1)[0]:
1734
firstline = xml.split('\n', 1)[0]
1735
if (not 'revision_id="' in firstline or
1736
'format="7"' not in firstline):
1219
1737
inv = self.branch.repository.deserialise_inventory(
1220
1738
new_revision, xml)
1221
inv.revision_id = new_revision
1222
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1223
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1224
path = self._basis_inventory_name()
1225
sio = StringIO(xml)
1226
self._control_files.put(path, sio)
1227
except WeaveRevisionNotPresent:
1739
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1740
self._write_basis_inventory(xml)
1741
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1228
1742
pass
1229
1743
1230
1744
def read_basis_inventory(self):
1234
1748
1235
1749
@needs_read_lock
1236
1750
def read_working_inventory(self):
1237
"""Read the working inventory."""
1751
"""Read the working inventory.
1752
1753
:raises errors.InventoryModified: read_working_inventory will fail
1754
when the current in memory inventory has been modified.
1755
"""
1756
# conceptually this should be an implementation detail of the tree.
1757
# XXX: Deprecate this.
1238
1758
# ElementTree does its own conversion from UTF-8, so open in
1239
1759
# binary.
1240
result = bzrlib.xml5.serializer_v5.read_inventory(
1241
self._control_files.get('inventory'))
1242
self._set_inventory(result)
1760
if self._inventory_is_modified:
1761
raise errors.InventoryModified(self)
1762
result = self._deserialize(self._control_files.get('inventory'))
1763
self._set_inventory(result, dirty=False)
1243
1764
return result
1244
1765
1245
@needs_write_lock
1766
@needs_tree_write_lock
1246
1767
def remove(self, files, verbose=False, to_file=None):
1247
1768
"""Remove nominated files from the working inventory..
1248
1769
1268
1789
for f in files:
1269
1790
fid = inv.path2id(f)
1270
1791
if not fid:
1271
# TODO: Perhaps make this just a warning, and continue?
1272
# This tends to happen when
1273
raise NotVersionedError(path=f)
1274
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1275
if verbose:
1276
# having remove it, it must be either ignored or unknown
1277
if self.is_ignored(f):
1278
new_status = 'I'
1279
else:
1280
new_status = '?'
1281
show_status(new_status, inv[fid].kind, quotefn(f), to_file=to_file)
1282
del inv[fid]
1792
note("%s is not versioned."%f)
1793
else:
1794
if verbose:
1795
# having remove it, it must be either ignored or unknown
1796
if self.is_ignored(f):
1797
new_status = 'I'
1798
else:
1799
new_status = '?'
1800
textui.show_status(new_status, inv[fid].kind, f,
1801
to_file=to_file)
1802
del inv[fid]
1283
1803
1284
1804
self._write_inventory(inv)
1285
1805
1286
@needs_write_lock
1806
@needs_tree_write_lock
1287
1807
def revert(self, filenames, old_tree=None, backups=True,
1288
pb=DummyProgress()):
1289
from transform import revert
1290
from conflicts import resolve
1808
pb=DummyProgress(), report_changes=False):
1809
from bzrlib.conflicts import resolve
1291
1810
if old_tree is None:
1292
1811
old_tree = self.basis_tree()
1293
conflicts = revert(self, old_tree, filenames, backups, pb)
1812
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1813
report_changes)
1294
1814
if not len(filenames):
1295
self.set_pending_merges([])
1815
self.set_parent_ids(self.get_parent_ids()[:1])
1296
1816
resolve(self)
1297
1817
else:
1298
1818
resolve(self, filenames, ignore_misses=True)
1299
1819
return conflicts
1300
1820
1821
def revision_tree(self, revision_id):
1822
"""See Tree.revision_tree.
1823
1824
WorkingTree can supply revision_trees for the basis revision only
1825
because there is only one cached inventory in the bzr directory.
1826
"""
1827
if revision_id == self.last_revision():
1828
try:
1829
xml = self.read_basis_inventory()
1830
except errors.NoSuchFile:
1831
pass
1832
else:
1833
try:
1834
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1835
# dont use the repository revision_tree api because we want
1836
# to supply the inventory.
1837
if inv.revision_id == revision_id:
1838
return revisiontree.RevisionTree(self.branch.repository,
1839
inv, revision_id)
1840
except errors.BadInventoryFormat:
1841
pass
1842
# raise if there was no inventory, or if we read the wrong inventory.
1843
raise errors.NoSuchRevisionInTree(self, revision_id)
1844
1301
1845
# XXX: This method should be deprecated in favour of taking in a proper
1302
1846
# new Inventory object.
1303
@needs_write_lock
1847
@needs_tree_write_lock
1304
1848
def set_inventory(self, new_inventory_list):
1305
1849
from bzrlib.inventory import (Inventory,
1306
1850
InventoryDirectory,
1320
1864
elif kind == 'symlink':
1321
1865
inv.add(InventoryLink(file_id, name, parent))
1322
1866
else:
1323
raise BzrError("unknown kind %r" % kind)
1867
raise errors.BzrError("unknown kind %r" % kind)
1324
1868
self._write_inventory(inv)
1325
1869
1326
@needs_write_lock
1870
@needs_tree_write_lock
1327
1871
def set_root_id(self, file_id):
1328
1872
"""Set the root id for this tree."""
1329
inv = self.read_working_inventory()
1873
# for compatability
1874
if file_id is None:
1875
symbol_versioning.warn(symbol_versioning.zero_twelve
1876
% 'WorkingTree.set_root_id with fileid=None',
1877
DeprecationWarning,
1878
stacklevel=3)
1879
file_id = ROOT_ID
1880
else:
1881
file_id = osutils.safe_file_id(file_id)
1882
self._set_root_id(file_id)
1883
1884
def _set_root_id(self, file_id):
1885
"""Set the root id for this tree, in a format specific manner.
1886
1887
:param file_id: The file id to assign to the root. It must not be
1888
present in the current inventory or an error will occur. It must
1889
not be None, but rather a valid file id.
1890
"""
1891
inv = self._inventory
1330
1892
orig_root_id = inv.root.file_id
1893
# TODO: it might be nice to exit early if there was nothing
1894
# to do, saving us from trigger a sync on unlock.
1895
self._inventory_is_modified = True
1896
# we preserve the root inventory entry object, but
1897
# unlinkit from the byid index
1331
1898
del inv._byid[inv.root.file_id]
1332
1899
inv.root.file_id = file_id
1900
# and link it into the index with the new changed id.
1333
1901
inv._byid[inv.root.file_id] = inv.root
1902
# and finally update all children to reference the new id.
1903
# XXX: this should be safe to just look at the root.children
1904
# list, not the WHOLE INVENTORY.
1334
1905
for fid in inv:
1335
1906
entry = inv[fid]
1336
1907
if entry.parent_id == orig_root_id:
1337
1908
entry.parent_id = inv.root.file_id
1338
self._write_inventory(inv)
1339
1909
1340
1910
def unlock(self):
1341
1911
"""See Branch.unlock.
1346
1916
between multiple working trees, i.e. via shared storage, then we
1347
1917
would probably want to lock both the local tree, and the branch.
1348
1918
"""
1349
# FIXME: We want to write out the hashcache only when the last lock on
1350
# this working copy is released. Peeking at the lock count is a bit
1351
# of a nasty hack; probably it's better to have a transaction object,
1352
# which can do some finalization when it's either successfully or
1353
# unsuccessfully completed. (Denys's original patch did that.)
1354
# RBC 20060206 hooking into transaction will couple lock and transaction
1355
# wrongly. Hooking into unlock on the control files object is fine though.
1356
1357
# TODO: split this per format so there is no ugly if block
1358
if self._hashcache.needs_write and (
1359
# dedicated lock files
1360
self._control_files._lock_count==1 or
1361
# shared lock files
1362
(self._control_files is self.branch.control_files and
1363
self._control_files._lock_count==3)):
1364
self._hashcache.write()
1365
# reverse order of locking.
1366
try:
1367
return self._control_files.unlock()
1368
finally:
1369
self.branch.unlock()
1919
raise NotImplementedError(self.unlock)
1370
1920
1371
@needs_write_lock
1372
1921
def update(self):
1373
1922
"""Update a working tree along its branch.
1374
1923
1375
This will update the branch if its bound too, which means we have multiple trees involved:
1376
The new basis tree of the master.
1377
The old basis tree of the branch.
1378
The old basis tree of the working tree.
1379
The current working tree state.
1380
pathologically all three may be different, and non ancestors of each other.
1381
Conceptually we want to:
1382
Preserve the wt.basis->wt.state changes
1383
Transform the wt.basis to the new master basis.
1384
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1385
Restore the wt.basis->wt.state changes.
1924
This will update the branch if its bound too, which means we have
1925
multiple trees involved:
1926
1927
- The new basis tree of the master.
1928
- The old basis tree of the branch.
1929
- The old basis tree of the working tree.
1930
- The current working tree state.
1931
1932
Pathologically, all three may be different, and non-ancestors of each
1933
other. Conceptually we want to:
1934
1935
- Preserve the wt.basis->wt.state changes
1936
- Transform the wt.basis to the new master basis.
1937
- Apply a merge of the old branch basis to get any 'local' changes from
1938
it into the tree.
1939
- Restore the wt.basis->wt.state changes.
1386
1940
1387
1941
There isn't a single operation at the moment to do that, so we:
1388
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1389
Do a 'normal' merge of the old branch basis if it is relevant.
1390
"""
1391
old_tip = self.branch.update()
1392
if old_tip is not None:
1393
self.add_pending_merge(old_tip)
1394
self.branch.lock_read()
1395
try:
1396
result = 0
1397
if self.last_revision() != self.branch.last_revision():
1398
# merge tree state up to new branch tip.
1399
basis = self.basis_tree()
1942
- Merge current state -> basis tree of the master w.r.t. the old tree
1943
basis.
1944
- Do a 'normal' merge of the old branch basis if it is relevant.
1945
"""
1946
if self.branch.get_master_branch() is not None:
1947
self.lock_write()
1948
update_branch = True
1949
else:
1950
self.lock_tree_write()
1951
update_branch = False
1952
try:
1953
if update_branch:
1954
old_tip = self.branch.update()
1955
else:
1956
old_tip = None
1957
return self._update_tree(old_tip)
1958
finally:
1959
self.unlock()
1960
1961
@needs_tree_write_lock
1962
def _update_tree(self, old_tip=None):
1963
"""Update a tree to the master branch.
1964
1965
:param old_tip: if supplied, the previous tip revision the branch,
1966
before it was changed to the master branch's tip.
1967
"""
1968
# here if old_tip is not None, it is the old tip of the branch before
1969
# it was updated from the master branch. This should become a pending
1970
# merge in the working tree to preserve the user existing work. we
1971
# cant set that until we update the working trees last revision to be
1972
# one from the new branch, because it will just get absorbed by the
1973
# parent de-duplication logic.
1974
#
1975
# We MUST save it even if an error occurs, because otherwise the users
1976
# local work is unreferenced and will appear to have been lost.
1977
#
1978
result = 0
1979
try:
1980
last_rev = self.get_parent_ids()[0]
1981
except IndexError:
1982
last_rev = None
1983
if last_rev != self.branch.last_revision():
1984
# merge tree state up to new branch tip.
1985
basis = self.basis_tree()
1986
basis.lock_read()
1987
try:
1400
1988
to_tree = self.branch.basis_tree()
1401
result += merge_inner(self.branch,
1989
if basis.inventory.root is None:
1990
self.set_root_id(to_tree.inventory.root.file_id)
1991
self.flush()
1992
result += merge.merge_inner(
1993
self.branch,
1402
1994
to_tree,
1403
1995
basis,
1404
1996
this_tree=self)
1405
self.set_last_revision(self.branch.last_revision())
1406
if old_tip and old_tip != self.last_revision():
1407
# our last revision was not the prior branch last revision
1408
# and we have converted that last revision to a pending merge.
1409
# base is somewhere between the branch tip now
1410
# and the now pending merge
1411
from bzrlib.revision import common_ancestor
1412
try:
1413
base_rev_id = common_ancestor(self.branch.last_revision(),
1414
old_tip,
1415
self.branch.repository)
1416
except errors.NoCommonAncestor:
1417
base_rev_id = None
1418
base_tree = self.branch.repository.revision_tree(base_rev_id)
1419
other_tree = self.branch.repository.revision_tree(old_tip)
1420
result += merge_inner(self.branch,
1421
other_tree,
1422
base_tree,
1423
this_tree=self)
1424
return result
1425
finally:
1426
self.branch.unlock()
1427
1428
@needs_write_lock
1997
finally:
1998
basis.unlock()
1999
# TODO - dedup parents list with things merged by pull ?
2000
# reuse the tree we've updated to to set the basis:
2001
parent_trees = [(self.branch.last_revision(), to_tree)]
2002
merges = self.get_parent_ids()[1:]
2003
# Ideally we ask the tree for the trees here, that way the working
2004
# tree can decide whether to give us teh entire tree or give us a
2005
# lazy initialised tree. dirstate for instance will have the trees
2006
# in ram already, whereas a last-revision + basis-inventory tree
2007
# will not, but also does not need them when setting parents.
2008
for parent in merges:
2009
parent_trees.append(
2010
(parent, self.branch.repository.revision_tree(parent)))
2011
if old_tip is not None:
2012
parent_trees.append(
2013
(old_tip, self.branch.repository.revision_tree(old_tip)))
2014
self.set_parent_trees(parent_trees)
2015
last_rev = parent_trees[0][0]
2016
else:
2017
# the working tree had the same last-revision as the master
2018
# branch did. We may still have pivot local work from the local
2019
# branch into old_tip:
2020
if old_tip is not None:
2021
self.add_parent_tree_id(old_tip)
2022
if old_tip and old_tip != last_rev:
2023
# our last revision was not the prior branch last revision
2024
# and we have converted that last revision to a pending merge.
2025
# base is somewhere between the branch tip now
2026
# and the now pending merge
2027
2028
# Since we just modified the working tree and inventory, flush out
2029
# the current state, before we modify it again.
2030
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2031
# requires it only because TreeTransform directly munges the
2032
# inventory and calls tree._write_inventory(). Ultimately we
2033
# should be able to remove this extra flush.
2034
self.flush()
2035
from bzrlib.revision import common_ancestor
2036
try:
2037
base_rev_id = common_ancestor(self.branch.last_revision(),
2038
old_tip,
2039
self.branch.repository)
2040
except errors.NoCommonAncestor:
2041
base_rev_id = None
2042
base_tree = self.branch.repository.revision_tree(base_rev_id)
2043
other_tree = self.branch.repository.revision_tree(old_tip)
2044
result += merge.merge_inner(
2045
self.branch,
2046
other_tree,
2047
base_tree,
2048
this_tree=self)
2049
return result
2050
2051
def _write_hashcache_if_dirty(self):
2052
"""Write out the hashcache if it is dirty."""
2053
if self._hashcache.needs_write:
2054
try:
2055
self._hashcache.write()
2056
except OSError, e:
2057
if e.errno not in (errno.EPERM, errno.EACCES):
2058
raise
2059
# TODO: jam 20061219 Should this be a warning? A single line
2060
# warning might be sufficient to let the user know what
2061
# is going on.
2062
mutter('Could not write hashcache for %s\nError: %s',
2063
self._hashcache.cache_file_name(), e)
2064
2065
@needs_tree_write_lock
1429
2066
def _write_inventory(self, inv):
1430
2067
"""Write inventory as the current inventory."""
1431
sio = StringIO()
1432
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1433
sio.seek(0)
1434
self._control_files.put('inventory', sio)
1435
self._set_inventory(inv)
1436
mutter('wrote working inventory')
2068
self._set_inventory(inv, dirty=True)
2069
self.flush()
1437
2070
1438
2071
def set_conflicts(self, arg):
1439
raise UnsupportedOperation(self.set_conflicts, self)
2072
raise errors.UnsupportedOperation(self.set_conflicts, self)
2073
2074
def add_conflicts(self, arg):
2075
raise errors.UnsupportedOperation(self.add_conflicts, self)
1440
2076
1441
2077
@needs_read_lock
1442
2078
def conflicts(self):
1443
conflicts = ConflictList()
2079
conflicts = _mod_conflicts.ConflictList()
1444
2080
for conflicted in self._iter_conflicts():
1445
2081
text = True
1446
2082
try:
1459
2095
if text == False:
1460
2096
break
1461
2097
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1462
conflicts.append(Conflict.factory(ctype, path=conflicted,
2098
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2099
path=conflicted,
1463
2100
file_id=self.path2id(conflicted)))
1464
2101
return conflicts
1465
2102
2103
def walkdirs(self, prefix=""):
2104
"""Walk the directories of this tree.
2105
2106
This API returns a generator, which is only valid during the current
2107
tree transaction - within a single lock_read or lock_write duration.
2108
2109
If the tree is not locked, it may cause an error to be raised, depending
2110
on the tree implementation.
2111
"""
2112
disk_top = self.abspath(prefix)
2113
if disk_top.endswith('/'):
2114
disk_top = disk_top[:-1]
2115
top_strip_len = len(disk_top) + 1
2116
inventory_iterator = self._walkdirs(prefix)
2117
disk_iterator = osutils.walkdirs(disk_top, prefix)
2118
try:
2119
current_disk = disk_iterator.next()
2120
disk_finished = False
2121
except OSError, e:
2122
if e.errno != errno.ENOENT:
2123
raise
2124
current_disk = None
2125
disk_finished = True
2126
try:
2127
current_inv = inventory_iterator.next()
2128
inv_finished = False
2129
except StopIteration:
2130
current_inv = None
2131
inv_finished = True
2132
while not inv_finished or not disk_finished:
2133
if not disk_finished:
2134
# strip out .bzr dirs
2135
if current_disk[0][1][top_strip_len:] == '':
2136
# osutils.walkdirs can be made nicer -
2137
# yield the path-from-prefix rather than the pathjoined
2138
# value.
2139
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2140
if current_disk[1][bzrdir_loc][0] == '.bzr':
2141
# we dont yield the contents of, or, .bzr itself.
2142
del current_disk[1][bzrdir_loc]
2143
if inv_finished:
2144
# everything is unknown
2145
direction = 1
2146
elif disk_finished:
2147
# everything is missing
2148
direction = -1
2149
else:
2150
direction = cmp(current_inv[0][0], current_disk[0][0])
2151
if direction > 0:
2152
# disk is before inventory - unknown
2153
dirblock = [(relpath, basename, kind, stat, None, None) for
2154
relpath, basename, kind, stat, top_path in current_disk[1]]
2155
yield (current_disk[0][0], None), dirblock
2156
try:
2157
current_disk = disk_iterator.next()
2158
except StopIteration:
2159
disk_finished = True
2160
elif direction < 0:
2161
# inventory is before disk - missing.
2162
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2163
for relpath, basename, dkind, stat, fileid, kind in
2164
current_inv[1]]
2165
yield (current_inv[0][0], current_inv[0][1]), dirblock
2166
try:
2167
current_inv = inventory_iterator.next()
2168
except StopIteration:
2169
inv_finished = True
2170
else:
2171
# versioned present directory
2172
# merge the inventory and disk data together
2173
dirblock = []
2174
for relpath, subiterator in itertools.groupby(sorted(
2175
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2176
path_elements = list(subiterator)
2177
if len(path_elements) == 2:
2178
inv_row, disk_row = path_elements
2179
# versioned, present file
2180
dirblock.append((inv_row[0],
2181
inv_row[1], disk_row[2],
2182
disk_row[3], inv_row[4],
2183
inv_row[5]))
2184
elif len(path_elements[0]) == 5:
2185
# unknown disk file
2186
dirblock.append((path_elements[0][0],
2187
path_elements[0][1], path_elements[0][2],
2188
path_elements[0][3], None, None))
2189
elif len(path_elements[0]) == 6:
2190
# versioned, absent file.
2191
dirblock.append((path_elements[0][0],
2192
path_elements[0][1], 'unknown', None,
2193
path_elements[0][4], path_elements[0][5]))
2194
else:
2195
raise NotImplementedError('unreachable code')
2196
yield current_inv[0], dirblock
2197
try:
2198
current_inv = inventory_iterator.next()
2199
except StopIteration:
2200
inv_finished = True
2201
try:
2202
current_disk = disk_iterator.next()
2203
except StopIteration:
2204
disk_finished = True
2205
2206
def _walkdirs(self, prefix=""):
2207
_directory = 'directory'
2208
# get the root in the inventory
2209
inv = self.inventory
2210
top_id = inv.path2id(prefix)
2211
if top_id is None:
2212
pending = []
2213
else:
2214
pending = [(prefix, '', _directory, None, top_id, None)]
2215
while pending:
2216
dirblock = []
2217
currentdir = pending.pop()
2218
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2219
top_id = currentdir[4]
2220
if currentdir[0]:
2221
relroot = currentdir[0] + '/'
2222
else:
2223
relroot = ""
2224
# FIXME: stash the node in pending
2225
entry = inv[top_id]
2226
for name, child in entry.sorted_children():
2227
dirblock.append((relroot + name, name, child.kind, None,
2228
child.file_id, child.kind
2229
))
2230
yield (currentdir[0], entry.file_id), dirblock
2231
# push the user specified dirs from dirblock
2232
for dir in reversed(dirblock):
2233
if dir[2] == _directory:
2234
pending.append(dir)
2235
2236
@needs_tree_write_lock
2237
def auto_resolve(self):
2238
"""Automatically resolve text conflicts according to contents.
2239
2240
Only text conflicts are auto_resolvable. Files with no conflict markers
2241
are considered 'resolved', because bzr always puts conflict markers
2242
into files that have text conflicts. The corresponding .THIS .BASE and
2243
.OTHER files are deleted, as per 'resolve'.
2244
:return: a tuple of ConflictLists: (un_resolved, resolved).
2245
"""
2246
un_resolved = _mod_conflicts.ConflictList()
2247
resolved = _mod_conflicts.ConflictList()
2248
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2249
for conflict in self.conflicts():
2250
if (conflict.typestring != 'text conflict' or
2251
self.kind(conflict.file_id) != 'file'):
2252
un_resolved.append(conflict)
2253
continue
2254
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2255
try:
2256
for line in my_file:
2257
if conflict_re.search(line):
2258
un_resolved.append(conflict)
2259
break
2260
else:
2261
resolved.append(conflict)
2262
finally:
2263
my_file.close()
2264
resolved.remove_files(self)
2265
self.set_conflicts(un_resolved)
2266
return un_resolved, resolved
2267
2268
def _validate(self):
2269
"""Validate internal structures.
2270
2271
This is meant mostly for the test suite. To give it a chance to detect
2272
corruption after actions have occurred. The default implementation is a
2273
just a no-op.
2274
2275
:return: None. An exception should be raised if there is an error.
2276
"""
2277
return
2278
2279
2280
class WorkingTree2(WorkingTree):
2281
"""This is the Format 2 working tree.
2282
2283
This was the first weave based working tree.
2284
- uses os locks for locking.
2285
- uses the branch last-revision.
2286
"""
2287
2288
def __init__(self, *args, **kwargs):
2289
super(WorkingTree2, self).__init__(*args, **kwargs)
2290
# WorkingTree2 has more of a constraint that self._inventory must
2291
# exist. Because this is an older format, we don't mind the overhead
2292
# caused by the extra computation here.
2293
2294
# Newer WorkingTree's should only have self._inventory set when they
2295
# have a read lock.
2296
if self._inventory is None:
2297
self.read_working_inventory()
2298
2299
def lock_tree_write(self):
2300
"""See WorkingTree.lock_tree_write().
2301
2302
In Format2 WorkingTrees we have a single lock for the branch and tree
2303
so lock_tree_write() degrades to lock_write().
2304
"""
2305
self.branch.lock_write()
2306
try:
2307
return self._control_files.lock_write()
2308
except:
2309
self.branch.unlock()
2310
raise
2311
2312
def unlock(self):
2313
# we share control files:
2314
if self._control_files._lock_count == 3:
2315
# _inventory_is_modified is always False during a read lock.
2316
if self._inventory_is_modified:
2317
self.flush()
2318
self._write_hashcache_if_dirty()
2319
2320
# reverse order of locking.
2321
try:
2322
return self._control_files.unlock()
2323
finally:
2324
self.branch.unlock()
2325
1466
2326
1467
2327
class WorkingTree3(WorkingTree):
1468
2328
"""This is the Format 3 working tree.
1475
2335
"""
1476
2336
1477
2337
@needs_read_lock
1478
def last_revision(self):
1479
"""See WorkingTree.last_revision."""
2338
def _last_revision(self):
2339
"""See Mutable.last_revision."""
1480
2340
try:
1481
return self._control_files.get_utf8('last-revision').read()
1482
except NoSuchFile:
2341
return osutils.safe_revision_id(
2342
self._control_files.get('last-revision').read())
2343
except errors.NoSuchFile:
1483
2344
return None
1484
2345
1485
2346
def _change_last_revision(self, revision_id):
1491
2352
pass
1492
2353
return False
1493
2354
else:
1494
try:
1495
self.branch.revision_history().index(revision_id)
1496
except ValueError:
1497
raise errors.NoSuchRevision(self.branch, revision_id)
1498
self._control_files.put_utf8('last-revision', revision_id)
2355
self._control_files.put_bytes('last-revision', revision_id)
1499
2356
return True
1500
2357
1501
@needs_write_lock
2358
@needs_tree_write_lock
1502
2359
def set_conflicts(self, conflicts):
1503
2360
self._put_rio('conflicts', conflicts.to_stanzas(),
1504
2361
CONFLICT_HEADER_1)
1505
2362
2363
@needs_tree_write_lock
2364
def add_conflicts(self, new_conflicts):
2365
conflict_set = set(self.conflicts())
2366
conflict_set.update(set(list(new_conflicts)))
2367
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2368
key=_mod_conflicts.Conflict.sort_key)))
2369
1506
2370
@needs_read_lock
1507
2371
def conflicts(self):
1508
2372
try:
1509
2373
confile = self._control_files.get('conflicts')
1510
except NoSuchFile:
1511
return ConflictList()
2374
except errors.NoSuchFile:
2375
return _mod_conflicts.ConflictList()
1512
2376
try:
1513
2377
if confile.next() != CONFLICT_HEADER_1 + '\n':
1514
raise ConflictFormatError()
2378
raise errors.ConflictFormatError()
1515
2379
except StopIteration:
1516
raise ConflictFormatError()
1517
return ConflictList.from_stanzas(RioReader(confile))
2380
raise errors.ConflictFormatError()
2381
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2382
2383
def unlock(self):
2384
if self._control_files._lock_count == 1:
2385
# _inventory_is_modified is always False during a read lock.
2386
if self._inventory_is_modified:
2387
self.flush()
2388
self._write_hashcache_if_dirty()
2389
# reverse order of locking.
2390
try:
2391
return self._control_files.unlock()
2392
finally:
2393
self.branch.unlock()
1518
2394
1519
2395
1520
2396
def get_conflicted_stem(path):
1521
for suffix in CONFLICT_SUFFIXES:
2397
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1522
2398
if path.endswith(suffix):
1523
2399
return path[:-len(suffix)]
1524
2400
2401
1525
2402
@deprecated_function(zero_eight)
1526
2403
def is_control_file(filename):
1527
2404
"""See WorkingTree.is_control_filename(filename)."""
1562
2439
_formats = {}
1563
2440
"""The known formats."""
1564
2441
2442
requires_rich_root = False
2443
2444
upgrade_recommended = False
2445
1565
2446
@classmethod
1566
2447
def find_format(klass, a_bzrdir):
1567
2448
"""Return the format for the working tree object in a_bzrdir."""
1569
2450
transport = a_bzrdir.get_workingtree_transport(None)
1570
2451
format_string = transport.get("format").read()
1571
2452
return klass._formats[format_string]
1572
except NoSuchFile:
2453
except errors.NoSuchFile:
1573
2454
raise errors.NoWorkingTree(base=transport.base)
1574
2455
except KeyError:
1575
raise errors.UnknownFormatError(format_string)
2456
raise errors.UnknownFormatError(format=format_string)
2457
2458
def __eq__(self, other):
2459
return self.__class__ is other.__class__
2460
2461
def __ne__(self, other):
2462
return not (self == other)
1576
2463
1577
2464
@classmethod
1578
2465
def get_default_format(klass):
1610
2497
del klass._formats[format.get_format_string()]
1611
2498
1612
2499
1613
1614
2500
class WorkingTreeFormat2(WorkingTreeFormat):
1615
2501
"""The second working tree format.
1616
2502
1617
2503
This format modified the hash cache from the format 1 hash cache.
1618
2504
"""
1619
2505
2506
upgrade_recommended = True
2507
1620
2508
def get_format_description(self):
1621
2509
"""See WorkingTreeFormat.get_format_description()."""
1622
2510
return "Working tree format 2"
1630
2518
"""
1631
2519
sio = StringIO()
1632
2520
inv = Inventory()
1633
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
2521
xml5.serializer_v5.write_inventory(inv, sio)
1634
2522
sio.seek(0)
1635
2523
control_files.put('inventory', sio)
1636
2524
1637
control_files.put_utf8('pending-merges', '')
2525
control_files.put_bytes('pending-merges', '')
1638
2526
1639
2527
1640
2528
def initialize(self, a_bzrdir, revision_id=None):
1643
2531
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1644
2532
branch = a_bzrdir.open_branch()
1645
2533
if revision_id is not None:
2534
revision_id = osutils.safe_revision_id(revision_id)
1646
2535
branch.lock_write()
1647
2536
try:
1648
2537
revision_history = branch.revision_history()
1654
2543
finally:
1655
2544
branch.unlock()
1656
2545
revision = branch.last_revision()
1657
inv = Inventory()
1658
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
2546
inv = Inventory()
2547
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1659
2548
branch,
1660
2549
inv,
1661
2550
_internal=True,
1662
2551
_format=self,
1663
2552
_bzrdir=a_bzrdir)
1664
wt._write_inventory(inv)
1665
wt.set_root_id(inv.root.file_id)
1666
wt.set_last_revision(revision)
1667
wt.set_pending_merges([])
1668
build_tree(wt.basis_tree(), wt)
2553
basis_tree = branch.repository.revision_tree(revision)
2554
if basis_tree.inventory.root is not None:
2555
wt.set_root_id(basis_tree.inventory.root.file_id)
2556
# set the parent list and cache the basis tree.
2557
wt.set_parent_trees([(revision, basis_tree)])
2558
transform.build_tree(basis_tree, wt)
1669
2559
return wt
1670
2560
1671
2561
def __init__(self):
1683
2573
raise NotImplementedError
1684
2574
if not isinstance(a_bzrdir.transport, LocalTransport):
1685
2575
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1686
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
2576
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1687
2577
_internal=True,
1688
2578
_format=self,
1689
2579
_bzrdir=a_bzrdir)
1690
2580
return wt
1691
2581
1692
2582
class WorkingTreeFormat3(WorkingTreeFormat):
1693
2583
"""The second working tree format updated to record a format marker.
1698
2588
files, separate from the BzrDir format
1699
2589
- modifies the hash cache format
1700
2590
- is new in bzr 0.8
1701
- uses a LockDir to guard access to the repository
2591
- uses a LockDir to guard access for writes.
1702
2592
"""
2593
2594
upgrade_recommended = True
1703
2595
1704
2596
def get_format_string(self):
1705
2597
"""See WorkingTreeFormat.get_format_string()."""
1712
2604
_lock_file_name = 'lock'
1713
2605
_lock_class = LockDir
1714
2606
2607
_tree_class = WorkingTree3
2608
2609
def __get_matchingbzrdir(self):
2610
return bzrdir.BzrDirMetaFormat1()
2611
2612
_matchingbzrdir = property(__get_matchingbzrdir)
2613
1715
2614
def _open_control_files(self, a_bzrdir):
1716
2615
transport = a_bzrdir.get_workingtree_transport(None)
1717
2616
return LockableFiles(transport, self._lock_file_name,
1733
2632
branch = a_bzrdir.open_branch()
1734
2633
if revision_id is None:
1735
2634
revision_id = branch.last_revision()
1736
inv = Inventory()
1737
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2635
else:
2636
revision_id = osutils.safe_revision_id(revision_id)
2637
# WorkingTree3 can handle an inventory which has a unique root id.
2638
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2639
# those trees. And because there isn't a format bump inbetween, we
2640
# are maintaining compatibility with older clients.
2641
# inv = Inventory(root_id=gen_root_id())
2642
inv = self._initial_inventory()
2643
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1738
2644
branch,
1739
2645
inv,
1740
2646
_internal=True,
1741
2647
_format=self,
1742
2648
_bzrdir=a_bzrdir,
1743
2649
_control_files=control_files)
1744
wt.lock_write()
2650
wt.lock_tree_write()
1745
2651
try:
1746
wt._write_inventory(inv)
1747
wt.set_root_id(inv.root.file_id)
1748
wt.set_last_revision(revision_id)
1749
wt.set_pending_merges([])
1750
build_tree(wt.basis_tree(), wt)
2652
basis_tree = branch.repository.revision_tree(revision_id)
2653
# only set an explicit root id if there is one to set.
2654
if basis_tree.inventory.root is not None:
2655
wt.set_root_id(basis_tree.inventory.root.file_id)
2656
if revision_id == NULL_REVISION:
2657
wt.set_parent_trees([])
2658
else:
2659
wt.set_parent_trees([(revision_id, basis_tree)])
2660
transform.build_tree(basis_tree, wt)
1751
2661
finally:
2662
# Unlock in this order so that the unlock-triggers-flush in
2663
# WorkingTree is given a chance to fire.
2664
control_files.unlock()
1752
2665
wt.unlock()
1753
control_files.unlock()
1754
2666
return wt
1755
2667
2668
def _initial_inventory(self):
2669
return Inventory()
2670
1756
2671
def __init__(self):
1757
2672
super(WorkingTreeFormat3, self).__init__()
1758
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1759
2673
1760
2674
def open(self, a_bzrdir, _found=False):
1761
2675
"""Return the WorkingTree object for a_bzrdir
1768
2682
raise NotImplementedError
1769
2683
if not isinstance(a_bzrdir.transport, LocalTransport):
1770
2684
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1771
control_files = self._open_control_files(a_bzrdir)
1772
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1773
_internal=True,
1774
_format=self,
1775
_bzrdir=a_bzrdir,
1776
_control_files=control_files)
2685
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2686
return wt
2687
2688
def _open(self, a_bzrdir, control_files):
2689
"""Open the tree itself.
2690
2691
:param a_bzrdir: the dir for the tree.
2692
:param control_files: the control files for the tree.
2693
"""
2694
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2695
_internal=True,
2696
_format=self,
2697
_bzrdir=a_bzrdir,
2698
_control_files=control_files)
1777
2699
1778
2700
def __str__(self):
1779
2701
return self.get_format_string()
1780
2702
1781
2703
2704
__default_format = WorkingTreeFormat4()
2705
WorkingTreeFormat.register_format(__default_format)
2706
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2707
WorkingTreeFormat.set_default_format(__default_format)
1782
2708
# formats which have no format string are not discoverable
1783
2709
# and not independently creatable, so are not registered.
1784
__default_format = WorkingTreeFormat3()
1785
WorkingTreeFormat.register_format(__default_format)
1786
WorkingTreeFormat.set_default_format(__default_format)
1787
2710
_legacy_formats = [WorkingTreeFormat2(),
1788
2711
]
1789
2712
1802
2725
self._transport_readonly_server = transport_readonly_server
1803
2726
self._formats = formats
1804
2727
2728
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2729
"""Clone test for adaption."""
2730
new_test = deepcopy(test)
2731
new_test.transport_server = self._transport_server
2732
new_test.transport_readonly_server = self._transport_readonly_server
2733
new_test.bzrdir_format = bzrdir_format
2734
new_test.workingtree_format = workingtree_format
2735
def make_new_test_id():
2736
new_id = "%s(%s)" % (test.id(), variation)
2737
return lambda: new_id
2738
new_test.id = make_new_test_id()
2739
return new_test
2740
1805
2741
def adapt(self, test):
1806
2742
from bzrlib.tests import TestSuite
1807
2743
result = TestSuite()
1808
2744
for workingtree_format, bzrdir_format in self._formats:
1809
new_test = deepcopy(test)
1810
new_test.transport_server = self._transport_server
1811
new_test.transport_readonly_server = self._transport_readonly_server
1812
new_test.bzrdir_format = bzrdir_format
1813
new_test.workingtree_format = workingtree_format
1814
def make_new_test_id():
1815
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1816
return lambda: new_id
1817
new_test.id = make_new_test_id()
2745
new_test = self._clone_test(
2746
test,
2747
bzrdir_format,
2748
workingtree_format, workingtree_format.__class__.__name__)
1818
2749
result.addTest(new_test)
1819
2750
return result
Loggerhead is a web-based interface for Breezy
Version: 2.0.1