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