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