To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1457.1.14
- compare with another revision
- download diff
- download tarball
- view history from revision 1457.1.14
- Committer: Robert Collins
- Date: 2005-11-05 23:01:07 UTC
- mto: This revision was merged to the branch mainline in revision 1503.
- Revision ID: robertc@robertcollins.net-20051105230107-63b2bb28dd1f6199
Move pending_merges() to WorkingTree.
- files added:
- .bzrignore
- bzrlib
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- doc
- notes
- patches
- tools
- files removed:
- .bzrignore
- notes
- tests
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
18
import shutil
19
import sys
20
import os
21
import errno
22
from warnings import warn
23
from cStringIO import StringIO
24
25
26
import bzrlib
27
from bzrlib.inventory import InventoryEntry
28
import bzrlib.inventory as inventory
29
from bzrlib.trace import mutter, note
30
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
31
rename, splitpath, sha_file, appendpath,
32
file_kind, abspath)
33
import bzrlib.errors as errors
34
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
35
NoSuchRevision, HistoryMissing, NotBranchError,
36
DivergedBranches, LockError, UnlistableStore,
37
UnlistableBranch, NoSuchFile, NotVersionedError,
38
NoWorkingTree)
39
from bzrlib.textui import show_status
40
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
41
NULL_REVISION)
42
43
from bzrlib.delta import compare_trees
44
from bzrlib.tree import EmptyTree, RevisionTree
45
from bzrlib.inventory import Inventory
46
from bzrlib.store import copy_all
47
from bzrlib.store.compressed_text import CompressedTextStore
48
from bzrlib.store.text import TextStore
49
from bzrlib.store.weave import WeaveStore
50
from bzrlib.testament import Testament
51
import bzrlib.transactions as transactions
52
from bzrlib.transport import Transport, get_transport
53
import bzrlib.xml5
54
import bzrlib.ui
55
56
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
59
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
60
## TODO: Maybe include checks for common corruption of newlines, etc?
61
62
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations.
67
68
def find_branch(*ignored, **ignored_too):
69
# XXX: leave this here for about one release, then remove it
70
raise NotImplementedError('find_branch() is not supported anymore, '
71
'please use one of the new branch constructors')
72
73
74
def needs_read_lock(unbound):
75
"""Decorate unbound to take out and release a read lock."""
76
def decorated(self, *args, **kwargs):
77
self.lock_read()
78
try:
79
return unbound(self, *args, **kwargs)
80
finally:
81
self.unlock()
82
return decorated
83
84
85
def needs_write_lock(unbound):
86
"""Decorate unbound to take out and release a write lock."""
87
def decorated(self, *args, **kwargs):
88
self.lock_write()
89
try:
90
return unbound(self, *args, **kwargs)
91
finally:
92
self.unlock()
93
return decorated
94
95
######################################################################
96
# branch objects
97
98
class Branch(object):
99
"""Branch holding a history of revisions.
100
101
base
102
Base directory/url of the branch.
103
"""
104
base = None
105
106
def __init__(self, *ignored, **ignored_too):
107
raise NotImplementedError('The Branch class is abstract')
108
109
@staticmethod
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format.
112
113
Only local branches are supported."""
114
return _Branch(get_transport(base), relax_version_check=True)
115
116
@staticmethod
117
def open(base):
118
"""Open an existing branch, rooted at 'base' (url)"""
119
t = get_transport(base)
120
mutter("trying to open %r with transport %r", base, t)
121
return _Branch(t)
122
123
@staticmethod
124
def open_containing(url):
125
"""Open an existing branch which contains url.
126
127
This probes for a branch at url, and searches upwards from there.
128
129
Basically we keep looking up until we find the control directory or
130
run into the root. If there isn't one, raises NotBranchError.
131
If there is one, it is returned, along with the unused portion of url.
132
"""
133
t = get_transport(url)
134
while True:
135
try:
136
return _Branch(t), t.relpath(url)
137
except NotBranchError:
138
pass
139
new_t = t.clone('..')
140
if new_t.base == t.base:
141
# reached the root, whatever that may be
142
raise NotBranchError(path=url)
143
t = new_t
144
145
@staticmethod
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
t = get_transport(base)
149
return _Branch(t, init=True)
150
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
154
"""
155
self.cache_root = cache_root
156
157
158
class _Branch(Branch):
159
"""A branch stored in the actual filesystem.
160
161
Note that it's "local" in the context of the filesystem; it doesn't
162
really matter if it's on an nfs/smb/afs/coda/... share, as long as
163
it's writable, and can be accessed via the normal filesystem API.
164
165
_lock_mode
166
None, or 'r' or 'w'
167
168
_lock_count
169
If _lock_mode is true, a positive count of the number of times the
170
lock has been taken.
171
172
_lock
173
Lock object from bzrlib.lock.
174
"""
175
# We actually expect this class to be somewhat short-lived; part of its
176
# purpose is to try to isolate what bits of the branch logic are tied to
177
# filesystem access, so that in a later step, we can extricate them to
178
# a separarte ("storage") class.
179
_lock_mode = None
180
_lock_count = None
181
_lock = None
182
_inventory_weave = None
183
184
# Map some sort of prefix into a namespace
185
# stuff like "revno:10", "revid:", etc.
186
# This should match a prefix with a function which accepts
187
REVISION_NAMESPACES = {}
188
189
def push_stores(self, branch_to):
190
"""Copy the content of this branches store to branch_to."""
191
if (self._branch_format != branch_to._branch_format
192
or self._branch_format != 4):
193
from bzrlib.fetch import greedy_fetch
194
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
195
self, self._branch_format, branch_to, branch_to._branch_format)
196
greedy_fetch(to_branch=branch_to, from_branch=self,
197
revision=self.last_revision())
198
return
199
200
store_pairs = ((self.text_store, branch_to.text_store),
201
(self.inventory_store, branch_to.inventory_store),
202
(self.revision_store, branch_to.revision_store))
203
try:
204
for from_store, to_store in store_pairs:
205
copy_all(from_store, to_store)
206
except UnlistableStore:
207
raise UnlistableBranch(from_store)
208
209
def __init__(self, transport, init=False,
210
relax_version_check=False):
211
"""Create new branch object at a particular location.
212
213
transport -- A Transport object, defining how to access files.
214
215
init -- If True, create new control files in a previously
216
unversioned directory. If False, the branch must already
217
be versioned.
218
219
relax_version_check -- If true, the usual check for the branch
220
version is not applied. This is intended only for
221
upgrade/recovery type use; it's not guaranteed that
222
all operations will work on old format branches.
223
224
In the test suite, creation of new trees is tested using the
225
`ScratchBranch` class.
226
"""
227
assert isinstance(transport, Transport), \
228
"%r is not a Transport" % transport
229
self._transport = transport
230
if init:
231
self._make_control()
232
self._check_format(relax_version_check)
233
234
def get_store(name, compressed=True, prefixed=False):
235
# FIXME: This approach of assuming stores are all entirely compressed
236
# or entirely uncompressed is tidy, but breaks upgrade from
237
# some existing branches where there's a mixture; we probably
238
# still want the option to look for both.
239
relpath = self._rel_controlfilename(name)
240
if compressed:
241
store = CompressedTextStore(self._transport.clone(relpath),
242
prefixed=prefixed)
243
else:
244
store = TextStore(self._transport.clone(relpath),
245
prefixed=prefixed)
246
#if self._transport.should_cache():
247
# cache_path = os.path.join(self.cache_root, name)
248
# os.mkdir(cache_path)
249
# store = bzrlib.store.CachedStore(store, cache_path)
250
return store
251
def get_weave(name, prefixed=False):
252
relpath = self._rel_controlfilename(name)
253
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
254
if self._transport.should_cache():
255
ws.enable_cache = True
256
return ws
257
258
if self._branch_format == 4:
259
self.inventory_store = get_store('inventory-store')
260
self.text_store = get_store('text-store')
261
self.revision_store = get_store('revision-store')
262
elif self._branch_format == 5:
263
self.control_weaves = get_weave('')
264
self.weave_store = get_weave('weaves')
265
self.revision_store = get_store('revision-store', compressed=False)
266
elif self._branch_format == 6:
267
self.control_weaves = get_weave('')
268
self.weave_store = get_weave('weaves', prefixed=True)
269
self.revision_store = get_store('revision-store', compressed=False,
270
prefixed=True)
271
self.revision_store.register_suffix('sig')
272
self._transaction = None
273
274
def __str__(self):
275
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
276
277
__repr__ = __str__
278
279
def __del__(self):
280
if self._lock_mode or self._lock:
281
# XXX: This should show something every time, and be suitable for
282
# headless operation and embedding
283
warn("branch %r was not explicitly unlocked" % self)
284
self._lock.unlock()
285
286
# TODO: It might be best to do this somewhere else,
287
# but it is nice for a Branch object to automatically
288
# cache it's information.
289
# Alternatively, we could have the Transport objects cache requests
290
# See the earlier discussion about how major objects (like Branch)
291
# should never expect their __del__ function to run.
292
if hasattr(self, 'cache_root') and self.cache_root is not None:
293
try:
294
shutil.rmtree(self.cache_root)
295
except:
296
pass
297
self.cache_root = None
298
299
def _get_base(self):
300
if self._transport:
301
return self._transport.base
302
return None
303
304
base = property(_get_base, doc="The URL for the root of this branch.")
305
306
def _finish_transaction(self):
307
"""Exit the current transaction."""
308
if self._transaction is None:
309
raise errors.LockError('Branch %s is not in a transaction' %
310
self)
311
transaction = self._transaction
312
self._transaction = None
313
transaction.finish()
314
315
def get_transaction(self):
316
"""Return the current active transaction.
317
318
If no transaction is active, this returns a passthrough object
319
for which all data is immediately flushed and no caching happens.
320
"""
321
if self._transaction is None:
322
return transactions.PassThroughTransaction()
323
else:
324
return self._transaction
325
326
def _set_transaction(self, new_transaction):
327
"""Set a new active transaction."""
328
if self._transaction is not None:
329
raise errors.LockError('Branch %s is in a transaction already.' %
330
self)
331
self._transaction = new_transaction
332
333
def lock_write(self):
334
mutter("lock write: %s (%s)", self, self._lock_count)
335
# TODO: Upgrade locking to support using a Transport,
336
# and potentially a remote locking protocol
337
if self._lock_mode:
338
if self._lock_mode != 'w':
339
raise LockError("can't upgrade to a write lock from %r" %
340
self._lock_mode)
341
self._lock_count += 1
342
else:
343
self._lock = self._transport.lock_write(
344
self._rel_controlfilename('branch-lock'))
345
self._lock_mode = 'w'
346
self._lock_count = 1
347
self._set_transaction(transactions.PassThroughTransaction())
348
349
def lock_read(self):
350
mutter("lock read: %s (%s)", self, self._lock_count)
351
if self._lock_mode:
352
assert self._lock_mode in ('r', 'w'), \
353
"invalid lock mode %r" % self._lock_mode
354
self._lock_count += 1
355
else:
356
self._lock = self._transport.lock_read(
357
self._rel_controlfilename('branch-lock'))
358
self._lock_mode = 'r'
359
self._lock_count = 1
360
self._set_transaction(transactions.ReadOnlyTransaction())
361
# 5K may be excessive, but hey, its a knob.
362
self.get_transaction().set_cache_size(5000)
363
364
def unlock(self):
365
mutter("unlock: %s (%s)", self, self._lock_count)
366
if not self._lock_mode:
367
raise LockError('branch %r is not locked' % (self))
368
369
if self._lock_count > 1:
370
self._lock_count -= 1
371
else:
372
self._finish_transaction()
373
self._lock.unlock()
374
self._lock = None
375
self._lock_mode = self._lock_count = None
376
377
def abspath(self, name):
378
"""Return absolute filename for something in the branch
379
380
XXX: Robert Collins 20051017 what is this used for? why is it a branch
381
method and not a tree method.
382
"""
383
return self._transport.abspath(name)
384
385
def _rel_controlfilename(self, file_or_path):
386
if not isinstance(file_or_path, basestring):
387
file_or_path = '/'.join(file_or_path)
388
if file_or_path == '':
389
return bzrlib.BZRDIR
390
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
391
392
def controlfilename(self, file_or_path):
393
"""Return location relative to branch."""
394
return self._transport.abspath(self._rel_controlfilename(file_or_path))
395
396
def controlfile(self, file_or_path, mode='r'):
397
"""Open a control file for this branch.
398
399
There are two classes of file in the control directory: text
400
and binary. binary files are untranslated byte streams. Text
401
control files are stored with Unix newlines and in UTF-8, even
402
if the platform or locale defaults are different.
403
404
Controlfiles should almost never be opened in write mode but
405
rather should be atomically copied and replaced using atomicfile.
406
"""
407
import codecs
408
409
relpath = self._rel_controlfilename(file_or_path)
410
#TODO: codecs.open() buffers linewise, so it was overloaded with
411
# a much larger buffer, do we need to do the same for getreader/getwriter?
412
if mode == 'rb':
413
return self._transport.get(relpath)
414
elif mode == 'wb':
415
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
416
elif mode == 'r':
417
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
418
elif mode == 'w':
419
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
420
else:
421
raise BzrError("invalid controlfile mode %r" % mode)
422
423
def put_controlfile(self, path, f, encode=True):
424
"""Write an entry as a controlfile.
425
426
:param path: The path to put the file, relative to the .bzr control
427
directory
428
:param f: A file-like or string object whose contents should be copied.
429
:param encode: If true, encode the contents as utf-8
430
"""
431
self.put_controlfiles([(path, f)], encode=encode)
432
433
def put_controlfiles(self, files, encode=True):
434
"""Write several entries as controlfiles.
435
436
:param files: A list of [(path, file)] pairs, where the path is the directory
437
underneath the bzr control directory
438
:param encode: If true, encode the contents as utf-8
439
"""
440
import codecs
441
ctrl_files = []
442
for path, f in files:
443
if encode:
444
if isinstance(f, basestring):
445
f = f.encode('utf-8', 'replace')
446
else:
447
f = codecs.getwriter('utf-8')(f, errors='replace')
448
path = self._rel_controlfilename(path)
449
ctrl_files.append((path, f))
450
self._transport.put_multi(ctrl_files)
451
452
def _make_control(self):
453
from bzrlib.inventory import Inventory
454
from bzrlib.weavefile import write_weave_v5
455
from bzrlib.weave import Weave
456
457
# Create an empty inventory
458
sio = StringIO()
459
# if we want per-tree root ids then this is the place to set
460
# them; they're not needed for now and so ommitted for
461
# simplicity.
462
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
463
empty_inv = sio.getvalue()
464
sio = StringIO()
465
bzrlib.weavefile.write_weave_v5(Weave(), sio)
466
empty_weave = sio.getvalue()
467
468
dirs = [[], 'revision-store', 'weaves']
469
files = [('README',
470
"This is a Bazaar-NG control directory.\n"
471
"Do not change any files in this directory.\n"),
472
('branch-format', BZR_BRANCH_FORMAT_6),
473
('revision-history', ''),
474
('branch-name', ''),
475
('branch-lock', ''),
476
('pending-merges', ''),
477
('inventory', empty_inv),
478
('inventory.weave', empty_weave),
479
('ancestry.weave', empty_weave)
480
]
481
cfn = self._rel_controlfilename
482
self._transport.mkdir_multi([cfn(d) for d in dirs])
483
self.put_controlfiles(files)
484
mutter('created control directory in ' + self._transport.base)
485
486
def _check_format(self, relax_version_check):
487
"""Check this branch format is supported.
488
489
The format level is stored, as an integer, in
490
self._branch_format for code that needs to check it later.
491
492
In the future, we might need different in-memory Branch
493
classes to support downlevel branches. But not yet.
494
"""
495
try:
496
fmt = self.controlfile('branch-format', 'r').read()
497
except NoSuchFile:
498
raise NotBranchError(path=self.base)
499
mutter("got branch format %r", fmt)
500
if fmt == BZR_BRANCH_FORMAT_6:
501
self._branch_format = 6
502
elif fmt == BZR_BRANCH_FORMAT_5:
503
self._branch_format = 5
504
elif fmt == BZR_BRANCH_FORMAT_4:
505
self._branch_format = 4
506
507
if (not relax_version_check
508
and self._branch_format not in (5, 6)):
509
raise errors.UnsupportedFormatError(
510
'sorry, branch format %r not supported' % fmt,
511
['use a different bzr version',
512
'or remove the .bzr directory'
513
' and "bzr init" again'])
514
515
def get_root_id(self):
516
"""Return the id of this branches root"""
517
inv = self.get_inventory(self.last_revision())
518
return inv.root.file_id
519
520
@needs_write_lock
521
def add(self, files, ids=None):
522
"""Make files versioned.
523
524
Note that the command line normally calls smart_add instead,
525
which can automatically recurse.
526
527
This puts the files in the Added state, so that they will be
528
recorded by the next commit.
529
530
files
531
List of paths to add, relative to the base of the tree.
532
533
ids
534
If set, use these instead of automatically generated ids.
535
Must be the same length as the list of files, but may
536
contain None for ids that are to be autogenerated.
537
538
TODO: Perhaps have an option to add the ids even if the files do
539
not (yet) exist.
540
541
TODO: Perhaps yield the ids and paths as they're added.
542
"""
543
# TODO: Re-adding a file that is removed in the working copy
544
# should probably put it back with the previous ID.
545
if isinstance(files, basestring):
546
assert(ids is None or isinstance(ids, basestring))
547
files = [files]
548
if ids is not None:
549
ids = [ids]
550
551
if ids is None:
552
ids = [None] * len(files)
553
else:
554
assert(len(ids) == len(files))
555
556
inv = self.working_tree().read_working_inventory()
557
for f,file_id in zip(files, ids):
558
if is_control_file(f):
559
raise BzrError("cannot add control file %s" % quotefn(f))
560
561
fp = splitpath(f)
562
563
if len(fp) == 0:
564
raise BzrError("cannot add top-level %r" % f)
565
566
fullpath = os.path.normpath(self.abspath(f))
567
568
try:
569
kind = file_kind(fullpath)
570
except OSError:
571
# maybe something better?
572
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
573
574
if not InventoryEntry.versionable_kind(kind):
575
raise BzrError('cannot add: not a versionable file ('
576
'i.e. regular file, symlink or directory): %s' % quotefn(f))
577
578
if file_id is None:
579
file_id = gen_file_id(f)
580
inv.add_path(f, kind=kind, file_id=file_id)
581
582
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
583
584
self.working_tree()._write_inventory(inv)
585
586
@needs_read_lock
587
def print_file(self, file, revno):
588
"""Print `file` to stdout."""
589
tree = self.revision_tree(self.get_rev_id(revno))
590
# use inventory as it was in that revision
591
file_id = tree.inventory.path2id(file)
592
if not file_id:
593
raise BzrError("%r is not present in revision %s" % (file, revno))
594
tree.print_file(file_id)
595
596
def unknowns(self):
597
"""Return all unknown files.
598
599
These are files in the working directory that are not versioned or
600
control files or ignored.
601
602
>>> from bzrlib.workingtree import WorkingTree
603
>>> b = ScratchBranch(files=['foo', 'foo~'])
604
>>> map(str, b.unknowns())
605
['foo']
606
>>> b.add('foo')
607
>>> list(b.unknowns())
608
[]
609
>>> WorkingTree(b.base, b).remove('foo')
610
>>> list(b.unknowns())
611
[u'foo']
612
"""
613
return self.working_tree().unknowns()
614
615
@needs_write_lock
616
def append_revision(self, *revision_ids):
617
for revision_id in revision_ids:
618
mutter("add {%s} to revision-history" % revision_id)
619
rev_history = self.revision_history()
620
rev_history.extend(revision_ids)
621
self.set_revision_history(rev_history)
622
623
@needs_write_lock
624
def set_revision_history(self, rev_history):
625
self.put_controlfile('revision-history', '\n'.join(rev_history))
626
627
def has_revision(self, revision_id):
628
"""True if this branch has a copy of the revision.
629
630
This does not necessarily imply the revision is merge
631
or on the mainline."""
632
return (revision_id is None
633
or self.revision_store.has_id(revision_id))
634
635
@needs_read_lock
636
def get_revision_xml_file(self, revision_id):
637
"""Return XML file object for revision object."""
638
if not revision_id or not isinstance(revision_id, basestring):
639
raise InvalidRevisionId(revision_id=revision_id, branch=self)
640
try:
641
return self.revision_store.get(revision_id)
642
except (IndexError, KeyError):
643
raise bzrlib.errors.NoSuchRevision(self, revision_id)
644
645
#deprecated
646
get_revision_xml = get_revision_xml_file
647
648
def get_revision_xml(self, revision_id):
649
return self.get_revision_xml_file(revision_id).read()
650
651
652
def get_revision(self, revision_id):
653
"""Return the Revision object for a named revision"""
654
xml_file = self.get_revision_xml_file(revision_id)
655
656
try:
657
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
658
except SyntaxError, e:
659
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
660
[revision_id,
661
str(e)])
662
663
assert r.revision_id == revision_id
664
return r
665
666
def get_revision_delta(self, revno):
667
"""Return the delta for one revision.
668
669
The delta is relative to its mainline predecessor, or the
670
empty tree for revision 1.
671
"""
672
assert isinstance(revno, int)
673
rh = self.revision_history()
674
if not (1 <= revno <= len(rh)):
675
raise InvalidRevisionNumber(revno)
676
677
# revno is 1-based; list is 0-based
678
679
new_tree = self.revision_tree(rh[revno-1])
680
if revno == 1:
681
old_tree = EmptyTree()
682
else:
683
old_tree = self.revision_tree(rh[revno-2])
684
685
return compare_trees(old_tree, new_tree)
686
687
def get_revision_sha1(self, revision_id):
688
"""Hash the stored value of a revision, and return it."""
689
# In the future, revision entries will be signed. At that
690
# point, it is probably best *not* to include the signature
691
# in the revision hash. Because that lets you re-sign
692
# the revision, (add signatures/remove signatures) and still
693
# have all hash pointers stay consistent.
694
# But for now, just hash the contents.
695
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
696
697
def get_ancestry(self, revision_id):
698
"""Return a list of revision-ids integrated by a revision.
699
700
This currently returns a list, but the ordering is not guaranteed:
701
treat it as a set.
702
"""
703
if revision_id is None:
704
return [None]
705
w = self.get_inventory_weave()
706
return [None] + map(w.idx_to_name,
707
w.inclusions([w.lookup(revision_id)]))
708
709
def get_inventory_weave(self):
710
return self.control_weaves.get_weave('inventory',
711
self.get_transaction())
712
713
def get_inventory(self, revision_id):
714
"""Get Inventory object by hash."""
715
xml = self.get_inventory_xml(revision_id)
716
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
717
718
def get_inventory_xml(self, revision_id):
719
"""Get inventory XML as a file object."""
720
try:
721
assert isinstance(revision_id, basestring), type(revision_id)
722
iw = self.get_inventory_weave()
723
return iw.get_text(iw.lookup(revision_id))
724
except IndexError:
725
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
726
727
def get_inventory_sha1(self, revision_id):
728
"""Return the sha1 hash of the inventory entry
729
"""
730
return self.get_revision(revision_id).inventory_sha1
731
732
def get_revision_inventory(self, revision_id):
733
"""Return inventory of a past revision."""
734
# TODO: Unify this with get_inventory()
735
# bzr 0.0.6 and later imposes the constraint that the inventory_id
736
# must be the same as its revision, so this is trivial.
737
if revision_id == None:
738
# This does not make sense: if there is no revision,
739
# then it is the current tree inventory surely ?!
740
# and thus get_root_id() is something that looks at the last
741
# commit on the branch, and the get_root_id is an inventory check.
742
raise NotImplementedError
743
# return Inventory(self.get_root_id())
744
else:
745
return self.get_inventory(revision_id)
746
747
@needs_read_lock
748
def revision_history(self):
749
"""Return sequence of revision hashes on to this branch."""
750
transaction = self.get_transaction()
751
history = transaction.map.find_revision_history()
752
if history is not None:
753
mutter("cache hit for revision-history in %s", self)
754
return list(history)
755
history = [l.rstrip('\r\n') for l in
756
self.controlfile('revision-history', 'r').readlines()]
757
transaction.map.add_revision_history(history)
758
# this call is disabled because revision_history is
759
# not really an object yet, and the transaction is for objects.
760
# transaction.register_clean(history, precious=True)
761
return list(history)
762
763
def revno(self):
764
"""Return current revision number for this branch.
765
766
That is equivalent to the number of revisions committed to
767
this branch.
768
"""
769
return len(self.revision_history())
770
771
def last_revision(self):
772
"""Return last patch hash, or None if no history.
773
"""
774
ph = self.revision_history()
775
if ph:
776
return ph[-1]
777
else:
778
return None
779
780
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
781
"""Return a list of new revisions that would perfectly fit.
782
783
If self and other have not diverged, return a list of the revisions
784
present in other, but missing from self.
785
786
>>> from bzrlib.commit import commit
787
>>> bzrlib.trace.silent = True
788
>>> br1 = ScratchBranch()
789
>>> br2 = ScratchBranch()
790
>>> br1.missing_revisions(br2)
791
[]
792
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
793
>>> br1.missing_revisions(br2)
794
[u'REVISION-ID-1']
795
>>> br2.missing_revisions(br1)
796
[]
797
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
798
>>> br1.missing_revisions(br2)
799
[]
800
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
801
>>> br1.missing_revisions(br2)
802
[u'REVISION-ID-2A']
803
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
804
>>> br1.missing_revisions(br2)
805
Traceback (most recent call last):
806
DivergedBranches: These branches have diverged.
807
"""
808
self_history = self.revision_history()
809
self_len = len(self_history)
810
other_history = other.revision_history()
811
other_len = len(other_history)
812
common_index = min(self_len, other_len) -1
813
if common_index >= 0 and \
814
self_history[common_index] != other_history[common_index]:
815
raise DivergedBranches(self, other)
816
817
if stop_revision is None:
818
stop_revision = other_len
819
else:
820
assert isinstance(stop_revision, int)
821
if stop_revision > other_len:
822
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
823
return other_history[self_len:stop_revision]
824
825
def update_revisions(self, other, stop_revision=None):
826
"""Pull in new perfect-fit revisions."""
827
from bzrlib.fetch import greedy_fetch
828
if stop_revision is None:
829
stop_revision = other.last_revision()
830
### Should this be checking is_ancestor instead of revision_history?
831
if (stop_revision is not None and
832
stop_revision in self.revision_history()):
833
return
834
greedy_fetch(to_branch=self, from_branch=other,
835
revision=stop_revision)
836
pullable_revs = self.pullable_revisions(other, stop_revision)
837
if len(pullable_revs) > 0:
838
self.append_revision(*pullable_revs)
839
840
def pullable_revisions(self, other, stop_revision):
841
other_revno = other.revision_id_to_revno(stop_revision)
842
try:
843
return self.missing_revisions(other, other_revno)
844
except DivergedBranches, e:
845
try:
846
pullable_revs = get_intervening_revisions(self.last_revision(),
847
stop_revision, self)
848
assert self.last_revision() not in pullable_revs
849
return pullable_revs
850
except bzrlib.errors.NotAncestor:
851
if is_ancestor(self.last_revision(), stop_revision, self):
852
return []
853
else:
854
raise e
855
856
def commit(self, *args, **kw):
857
from bzrlib.commit import Commit
858
Commit().commit(self, *args, **kw)
859
860
def revision_id_to_revno(self, revision_id):
861
"""Given a revision id, return its revno"""
862
if revision_id is None:
863
return 0
864
history = self.revision_history()
865
try:
866
return history.index(revision_id) + 1
867
except ValueError:
868
raise bzrlib.errors.NoSuchRevision(self, revision_id)
869
870
def get_rev_id(self, revno, history=None):
871
"""Find the revision id of the specified revno."""
872
if revno == 0:
873
return None
874
if history is None:
875
history = self.revision_history()
876
elif revno <= 0 or revno > len(history):
877
raise bzrlib.errors.NoSuchRevision(self, revno)
878
return history[revno - 1]
879
880
def revision_tree(self, revision_id):
881
"""Return Tree for a revision on this branch.
882
883
`revision_id` may be None for the null revision, in which case
884
an `EmptyTree` is returned."""
885
# TODO: refactor this to use an existing revision object
886
# so we don't need to read it in twice.
887
if revision_id == None or revision_id == NULL_REVISION:
888
return EmptyTree()
889
else:
890
inv = self.get_revision_inventory(revision_id)
891
return RevisionTree(self.weave_store, inv, revision_id)
892
893
def working_tree(self):
894
"""Return a `Tree` for the working copy."""
895
from bzrlib.workingtree import WorkingTree
896
# TODO: In the future, perhaps WorkingTree should utilize Transport
897
# RobertCollins 20051003 - I don't think it should - working trees are
898
# much more complex to keep consistent than our careful .bzr subset.
899
# instead, we should say that working trees are local only, and optimise
900
# for that.
901
if self._transport.base.find('://') != -1:
902
raise NoWorkingTree(self.base)
903
return WorkingTree(self.base, branch=self)
904
905
@needs_write_lock
906
def pull(self, source, overwrite=False):
907
source.lock_read()
908
try:
909
try:
910
self.update_revisions(source)
911
except DivergedBranches:
912
if not overwrite:
913
raise
914
self.set_revision_history(source.revision_history())
915
finally:
916
source.unlock()
917
918
def basis_tree(self):
919
"""Return `Tree` object for last revision.
920
921
If there are no revisions yet, return an `EmptyTree`.
922
"""
923
return self.revision_tree(self.last_revision())
924
925
@needs_write_lock
926
def rename_one(self, from_rel, to_rel):
927
"""Rename one file.
928
929
This can change the directory or the filename or both.
930
"""
931
tree = self.working_tree()
932
inv = tree.inventory
933
if not tree.has_filename(from_rel):
934
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
935
if tree.has_filename(to_rel):
936
raise BzrError("can't rename: new working file %r already exists" % to_rel)
937
938
file_id = inv.path2id(from_rel)
939
if file_id == None:
940
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
941
942
if inv.path2id(to_rel):
943
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
944
945
to_dir, to_tail = os.path.split(to_rel)
946
to_dir_id = inv.path2id(to_dir)
947
if to_dir_id == None and to_dir != '':
948
raise BzrError("can't determine destination directory id for %r" % to_dir)
949
950
mutter("rename_one:")
951
mutter(" file_id {%s}" % file_id)
952
mutter(" from_rel %r" % from_rel)
953
mutter(" to_rel %r" % to_rel)
954
mutter(" to_dir %r" % to_dir)
955
mutter(" to_dir_id {%s}" % to_dir_id)
956
957
inv.rename(file_id, to_dir_id, to_tail)
958
959
from_abs = self.abspath(from_rel)
960
to_abs = self.abspath(to_rel)
961
try:
962
rename(from_abs, to_abs)
963
except OSError, e:
964
raise BzrError("failed to rename %r to %r: %s"
965
% (from_abs, to_abs, e[1]),
966
["rename rolled back"])
967
968
self.working_tree()._write_inventory(inv)
969
970
@needs_write_lock
971
def move(self, from_paths, to_name):
972
"""Rename files.
973
974
to_name must exist as a versioned directory.
975
976
If to_name exists and is a directory, the files are moved into
977
it, keeping their old names. If it is a directory,
978
979
Note that to_name is only the last component of the new name;
980
this doesn't change the directory.
981
982
This returns a list of (from_path, to_path) pairs for each
983
entry that is moved.
984
"""
985
result = []
986
## TODO: Option to move IDs only
987
assert not isinstance(from_paths, basestring)
988
tree = self.working_tree()
989
inv = tree.inventory
990
to_abs = self.abspath(to_name)
991
if not isdir(to_abs):
992
raise BzrError("destination %r is not a directory" % to_abs)
993
if not tree.has_filename(to_name):
994
raise BzrError("destination %r not in working directory" % to_abs)
995
to_dir_id = inv.path2id(to_name)
996
if to_dir_id == None and to_name != '':
997
raise BzrError("destination %r is not a versioned directory" % to_name)
998
to_dir_ie = inv[to_dir_id]
999
if to_dir_ie.kind not in ('directory', 'root_directory'):
1000
raise BzrError("destination %r is not a directory" % to_abs)
1001
1002
to_idpath = inv.get_idpath(to_dir_id)
1003
1004
for f in from_paths:
1005
if not tree.has_filename(f):
1006
raise BzrError("%r does not exist in working tree" % f)
1007
f_id = inv.path2id(f)
1008
if f_id == None:
1009
raise BzrError("%r is not versioned" % f)
1010
name_tail = splitpath(f)[-1]
1011
dest_path = appendpath(to_name, name_tail)
1012
if tree.has_filename(dest_path):
1013
raise BzrError("destination %r already exists" % dest_path)
1014
if f_id in to_idpath:
1015
raise BzrError("can't move %r to a subdirectory of itself" % f)
1016
1017
# OK, so there's a race here, it's possible that someone will
1018
# create a file in this interval and then the rename might be
1019
# left half-done. But we should have caught most problems.
1020
1021
for f in from_paths:
1022
name_tail = splitpath(f)[-1]
1023
dest_path = appendpath(to_name, name_tail)
1024
result.append((f, dest_path))
1025
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1026
try:
1027
rename(self.abspath(f), self.abspath(dest_path))
1028
except OSError, e:
1029
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1030
["rename rolled back"])
1031
1032
self.working_tree()._write_inventory(inv)
1033
return result
1034
1035
def add_pending_merge(self, *revision_ids):
1036
# TODO: Perhaps should check at this point that the
1037
# history of the revision is actually present?
1038
p = self.working_tree().pending_merges()
1039
updated = False
1040
for rev_id in revision_ids:
1041
if rev_id in p:
1042
continue
1043
p.append(rev_id)
1044
updated = True
1045
if updated:
1046
self.set_pending_merges(p)
1047
1048
@needs_write_lock
1049
def set_pending_merges(self, rev_list):
1050
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1051
1052
def get_parent(self):
1053
"""Return the parent location of the branch.
1054
1055
This is the default location for push/pull/missing. The usual
1056
pattern is that the user can override it by specifying a
1057
location.
1058
"""
1059
import errno
1060
_locs = ['parent', 'pull', 'x-pull']
1061
for l in _locs:
1062
try:
1063
return self.controlfile(l, 'r').read().strip('\n')
1064
except IOError, e:
1065
if e.errno != errno.ENOENT:
1066
raise
1067
return None
1068
1069
def get_push_location(self):
1070
"""Return the None or the location to push this branch to."""
1071
config = bzrlib.config.BranchConfig(self)
1072
push_loc = config.get_user_option('push_location')
1073
return push_loc
1074
1075
def set_push_location(self, location):
1076
"""Set a new push location for this branch."""
1077
config = bzrlib.config.LocationConfig(self.base)
1078
config.set_user_option('push_location', location)
1079
1080
@needs_write_lock
1081
def set_parent(self, url):
1082
# TODO: Maybe delete old location files?
1083
from bzrlib.atomicfile import AtomicFile
1084
f = AtomicFile(self.controlfilename('parent'))
1085
try:
1086
f.write(url + '\n')
1087
f.commit()
1088
finally:
1089
f.close()
1090
1091
def check_revno(self, revno):
1092
"""\
1093
Check whether a revno corresponds to any revision.
1094
Zero (the NULL revision) is considered valid.
1095
"""
1096
if revno != 0:
1097
self.check_real_revno(revno)
1098
1099
def check_real_revno(self, revno):
1100
"""\
1101
Check whether a revno corresponds to a real revision.
1102
Zero (the NULL revision) is considered invalid
1103
"""
1104
if revno < 1 or revno > self.revno():
1105
raise InvalidRevisionNumber(revno)
1106
1107
def sign_revision(self, revision_id, gpg_strategy):
1108
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1109
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1110
1111
@needs_write_lock
1112
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1113
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1114
revision_id, "sig")
1115
1116
1117
class ScratchBranch(_Branch):
1118
"""Special test class: a branch that cleans up after itself.
1119
1120
>>> b = ScratchBranch()
1121
>>> isdir(b.base)
1122
True
1123
>>> bd = b.base
1124
>>> b._transport.__del__()
1125
>>> isdir(bd)
1126
False
1127
"""
1128
1129
def __init__(self, files=[], dirs=[], transport=None):
1130
"""Make a test branch.
1131
1132
This creates a temporary directory and runs init-tree in it.
1133
1134
If any files are listed, they are created in the working copy.
1135
"""
1136
if transport is None:
1137
transport = bzrlib.transport.local.ScratchTransport()
1138
super(ScratchBranch, self).__init__(transport, init=True)
1139
else:
1140
super(ScratchBranch, self).__init__(transport)
1141
1142
for d in dirs:
1143
self._transport.mkdir(d)
1144
1145
for f in files:
1146
self._transport.put(f, 'content of %s' % f)
1147
1148
1149
def clone(self):
1150
"""
1151
>>> orig = ScratchBranch(files=["file1", "file2"])
1152
>>> clone = orig.clone()
1153
>>> if os.name != 'nt':
1154
... os.path.samefile(orig.base, clone.base)
1155
... else:
1156
... orig.base == clone.base
1157
...
1158
False
1159
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1160
True
1161
"""
1162
from shutil import copytree
1163
from tempfile import mkdtemp
1164
base = mkdtemp()
1165
os.rmdir(base)
1166
copytree(self.base, base, symlinks=True)
1167
return ScratchBranch(
1168
transport=bzrlib.transport.local.ScratchTransport(base))
1169
1170
1171
######################################################################
1172
# predicates
1173
1174
1175
def is_control_file(filename):
1176
## FIXME: better check
1177
filename = os.path.normpath(filename)
1178
while filename != '':
1179
head, tail = os.path.split(filename)
1180
## mutter('check %r for control file' % ((head, tail), ))
1181
if tail == bzrlib.BZRDIR:
1182
return True
1183
if filename == head:
1184
break
1185
filename = head
1186
return False
1187
1188
1189
1190
def gen_file_id(name):
1191
"""Return new file id.
1192
1193
This should probably generate proper UUIDs, but for the moment we
1194
cope with just randomness because running uuidgen every time is
1195
slow."""
1196
import re
1197
from binascii import hexlify
1198
from time import time
1199
1200
# get last component
1201
idx = name.rfind('/')
1202
if idx != -1:
1203
name = name[idx+1 : ]
1204
idx = name.rfind('\\')
1205
if idx != -1:
1206
name = name[idx+1 : ]
1207
1208
# make it not a hidden file
1209
name = name.lstrip('.')
1210
1211
# remove any wierd characters; we don't escape them but rather
1212
# just pull them out
1213
name = re.sub(r'[^\w.]', '', name)
1214
1215
s = hexlify(rand_bytes(8))
1216
return '-'.join((name, compact_date(time()), s))
1217
1218
1219
def gen_root_id():
1220
"""Return a new tree-root file id."""
1221
return gen_file_id('TREE_ROOT')
1222
1223
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0