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