« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1185.12.21
- compare with another revision
- download diff
- download tarball
- view history from revision 1185.12.21
- Committer: aaron.bentley at utoronto
- Date: 2005-10-11 05:36:02 UTC
- mto: (1185.25.1)
- mto: This revision was merged to the branch mainline in revision 1460.
- Revision ID: aaron.bentley@utoronto.ca-20051011053602-aa069cc6a96764cf
Cleaned up Fetcher._find_last_revision
- files added:
- bzrlib/changeset.py
- patches
- files removed:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- tools/doc_generate
- files renamed:
- tools/doc_generate/autodoc_man.py => bzr-man.py
- bzrlib/conflicts.py => bzrlib/plugins/conflicts.py
- bzrlib/tests/ => bzrlib/selftest/
- bzrlib/tests/blackbox/test_too_much.py => bzrlib/selftest/blackbox.py
- bzrlib/tests/test_plugins.py => bzrlib/selftest/plugins.py
- bzrlib/tests/branch_implementations/test_parent.py => bzrlib/selftest/test_parent.py
- bzrlib/tests/blackbox/test_revision_info.py => bzrlib/selftest/test_revision_info.py
- bzrlib/tests/branch_implementations/test_branch.py => bzrlib/selftest/testbranch.py
- bzrlib/tests/test_diff.py => bzrlib/selftest/testdiff.py
- bzrlib/tests/test_fetch.py => bzrlib/selftest/testfetch.py
- bzrlib/tests/test_graph.py => bzrlib/selftest/testgraph.py
- bzrlib/tests/test_hashcache.py => bzrlib/selftest/testhashcache.py
- bzrlib/tests/test_identitymap.py => bzrlib/selftest/testidentitymap.py
- bzrlib/tests/test_inv.py => bzrlib/selftest/testinv.py
- bzrlib/tests/test_log.py => bzrlib/selftest/testlog.py
- bzrlib/tests/test_merge.py => bzrlib/selftest/testmerge.py
- bzrlib/tests/test_merge3.py => bzrlib/selftest/testmerge3.py
- bzrlib/tests/test_revision.py => bzrlib/selftest/testrevision.py
- bzrlib/tests/test_revisionnamespaces.py => bzrlib/selftest/testrevisionnamespaces.py
- bzrlib/tests/test_sampler.py => bzrlib/selftest/testsampler.py
- bzrlib/tests/blackbox/test_status.py => bzrlib/selftest/teststatus.py
- bzrlib/tests/test_store.py => bzrlib/selftest/teststore.py
- bzrlib/tests/test_transactions.py => bzrlib/selftest/testtransactions.py
- bzrlib/tests/test_transport.py => bzrlib/selftest/testtransport.py
- bzrlib/tests/test_workingtree.py => bzrlib/selftest/testworkingtree.py
- bzrlib/tests/blackbox/test_versioning.py => bzrlib/selftest/versioning.py
- bzrlib/tests/test_whitebox.py => bzrlib/selftest/whitebox.py
- bzrlib/store/versioned/__init__.py => bzrlib/store/weave.py
- bzrlib/transport/http/__init__.py => bzrlib/transport/http.py
- bzrlib/ui/__init__.py => bzrlib/ui.py
- bzrlib/xml_serializer.py => bzrlib/xml.py
- files modified:
- .bzrignore
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005, 2006 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
16
16
17
17
18
from copy import deepcopy
19
from cStringIO import StringIO
18
import sys
19
import os
20
20
import errno
21
import os
22
import shutil
23
import sys
24
from unittest import TestSuite
25
21
from warnings import warn
22
from cStringIO import StringIO
23
26
24
27
25
import bzrlib
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
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)
32
32
import bzrlib.errors as errors
33
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
37
UnlistableStore,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
39
NoWorkingTree)
40
import bzrlib.inventory as inventory
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision
39
from bzrlib.delta import compare_trees
40
from bzrlib.tree import EmptyTree, RevisionTree
41
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
47
safe_unicode,
48
)
49
from bzrlib.textui import show_status
50
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
55
is_ancestor,
56
NULL_REVISION,
57
Revision,
58
)
59
42
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
43
from bzrlib.store.compressed_text import CompressedTextStore
44
from bzrlib.store.text import TextStore
45
from bzrlib.store.weave import WeaveStore
61
46
import bzrlib.transactions as transactions
62
47
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
48
import bzrlib.xml5
64
49
import bzrlib.ui
65
import bzrlib.xml5
66
50
67
51
68
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
54
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
72
73
# TODO: Maybe include checks for common corruption of newlines, etc?
55
## TODO: Maybe include checks for common corruption of newlines, etc?
56
74
57
75
58
# TODO: Some operations like log might retrieve the same revisions
76
59
# repeatedly to calculate deltas. We could perhaps have a weakref
77
60
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
61
# cached in memory between lock and unlock operations.
62
63
def find_branch(*ignored, **ignored_too):
64
# XXX: leave this here for about one release, then remove it
65
raise NotImplementedError('find_branch() is not supported anymore, '
66
'please use one of the new branch constructors')
67
def _relpath(base, path):
68
"""Return path relative to base, or raise exception.
69
70
The path may be either an absolute path or a path relative to the
71
current working directory.
72
73
Lifted out of Branch.relpath for ease of testing.
74
75
os.path.commonprefix (python2.4) has a bad bug that it works just
76
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
77
avoids that problem."""
78
rp = os.path.abspath(path)
79
80
s = []
81
head = rp
82
while len(head) >= len(base):
83
if head == base:
84
break
85
head, tail = os.path.split(head)
86
if tail:
87
s.insert(0, tail)
88
else:
89
raise NotBranchError("path %r is not within branch %r" % (rp, base))
90
91
return os.sep.join(s)
92
93
94
def find_branch_root(t):
95
"""Find the branch root enclosing the transport's base.
96
97
t is a Transport object.
98
99
It is not necessary that the base of t exists.
100
101
Basically we keep looking up until we find the control directory or
102
run into the root. If there isn't one, raises NotBranchError.
103
"""
104
orig_base = t.base
105
while True:
106
if t.has(bzrlib.BZRDIR):
107
return t
108
new_t = t.clone('..')
109
if new_t.base == t.base:
110
# reached the root, whatever that may be
111
raise NotBranchError('%s is not in a branch' % orig_base)
112
t = new_t
80
113
81
114
82
115
######################################################################
88
121
base
89
122
Base directory/url of the branch.
90
123
"""
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
93
124
base = None
94
125
95
126
def __init__(self, *ignored, **ignored_too):
96
127
raise NotImplementedError('The Branch class is abstract')
97
128
98
129
@staticmethod
99
@deprecated_method(zero_eight)
100
130
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
131
"""Open a branch which may be of an old format.
132
133
Only local branches are supported."""
134
return _Branch(get_transport(base), relax_version_check=True)
103
135
104
136
@staticmethod
105
def open(base, _unsupported=False):
106
"""Open the repository rooted at base.
107
108
For instance, if the repository is at URL/.bzr/repository,
109
Repository.open(URL) -> a Repository instance.
110
"""
111
control = bzrdir.BzrDir.open(base, _unsupported)
112
return control.open_branch(_unsupported)
137
def open(base):
138
"""Open an existing branch, rooted at 'base' (url)"""
139
t = get_transport(base)
140
mutter("trying to open %r with transport %r", base, t)
141
return _Branch(t)
113
142
114
143
@staticmethod
115
144
def open_containing(url):
116
145
"""Open an existing branch which contains url.
117
146
118
147
This probes for a branch at url, and searches upwards from there.
119
120
Basically we keep looking up until we find the control directory or
121
run into the root. If there isn't one, raises NotBranchError.
122
If there is one and it is either an unrecognised format or an unsupported
123
format, UnknownFormatError or UnsupportedFormatError are raised.
124
If there is one, it is returned, along with the unused portion of url.
125
148
"""
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
149
t = get_transport(url)
150
t = find_branch_root(t)
151
return _Branch(t)
128
152
129
153
@staticmethod
130
@deprecated_function(zero_eight)
131
154
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
133
134
NOTE: This will soon be deprecated in favour of creation
135
through a BzrDir.
136
"""
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
155
"""Create a new branch, rooted at 'base' (url)"""
156
t = get_transport(base)
157
return _Branch(t, init=True)
138
158
139
159
def setup_caching(self, cache_root):
140
160
"""Subclasses that care about caching should override this, and set
141
161
up cached stores located under cache_root.
142
162
"""
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
163
self.cache_root = cache_root
146
164
147
def _get_nick(self):
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
150
151
def _set_nick(self, nick):
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
155
156
nick = property(_get_nick, _set_nick)
157
158
def is_locked(self):
159
raise NotImplementedError('is_locked is abstract')
165
166
class _Branch(Branch):
167
"""A branch stored in the actual filesystem.
168
169
Note that it's "local" in the context of the filesystem; it doesn't
170
really matter if it's on an nfs/smb/afs/coda/... share, as long as
171
it's writable, and can be accessed via the normal filesystem API.
172
173
_lock_mode
174
None, or 'r' or 'w'
175
176
_lock_count
177
If _lock_mode is true, a positive count of the number of times the
178
lock has been taken.
179
180
_lock
181
Lock object from bzrlib.lock.
182
"""
183
# We actually expect this class to be somewhat short-lived; part of its
184
# purpose is to try to isolate what bits of the branch logic are tied to
185
# filesystem access, so that in a later step, we can extricate them to
186
# a separarte ("storage") class.
187
_lock_mode = None
188
_lock_count = None
189
_lock = None
190
_inventory_weave = None
191
192
# Map some sort of prefix into a namespace
193
# stuff like "revno:10", "revid:", etc.
194
# This should match a prefix with a function which accepts
195
REVISION_NAMESPACES = {}
196
197
def push_stores(self, branch_to):
198
"""Copy the content of this branches store to branch_to."""
199
if (self._branch_format != branch_to._branch_format
200
or self._branch_format != 4):
201
from bzrlib.fetch import greedy_fetch
202
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
203
self, self._branch_format, branch_to, branch_to._branch_format)
204
greedy_fetch(to_branch=branch_to, from_branch=self,
205
revision=self.last_revision())
206
return
207
208
store_pairs = ((self.text_store, branch_to.text_store),
209
(self.inventory_store, branch_to.inventory_store),
210
(self.revision_store, branch_to.revision_store))
211
try:
212
for from_store, to_store in store_pairs:
213
copy_all(from_store, to_store)
214
except UnlistableStore:
215
raise UnlistableBranch(from_store)
216
217
def __init__(self, transport, init=False,
218
relax_version_check=False):
219
"""Create new branch object at a particular location.
220
221
transport -- A Transport object, defining how to access files.
222
(If a string, transport.transport() will be used to
223
create a Transport object)
224
225
init -- If True, create new control files in a previously
226
unversioned directory. If False, the branch must already
227
be versioned.
228
229
relax_version_check -- If true, the usual check for the branch
230
version is not applied. This is intended only for
231
upgrade/recovery type use; it's not guaranteed that
232
all operations will work on old format branches.
233
234
In the test suite, creation of new trees is tested using the
235
`ScratchBranch` class.
236
"""
237
assert isinstance(transport, Transport), \
238
"%r is not a Transport" % transport
239
self._transport = transport
240
if init:
241
self._make_control()
242
self._check_format(relax_version_check)
243
244
def get_store(name, compressed=True, prefixed=False):
245
# FIXME: This approach of assuming stores are all entirely compressed
246
# or entirely uncompressed is tidy, but breaks upgrade from
247
# some existing branches where there's a mixture; we probably
248
# still want the option to look for both.
249
relpath = self._rel_controlfilename(name)
250
if compressed:
251
store = CompressedTextStore(self._transport.clone(relpath),
252
prefixed=prefixed)
253
else:
254
store = TextStore(self._transport.clone(relpath),
255
prefixed=prefixed)
256
#if self._transport.should_cache():
257
# cache_path = os.path.join(self.cache_root, name)
258
# os.mkdir(cache_path)
259
# store = bzrlib.store.CachedStore(store, cache_path)
260
return store
261
def get_weave(name, prefixed=False):
262
relpath = self._rel_controlfilename(name)
263
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
264
if self._transport.should_cache():
265
ws.enable_cache = True
266
return ws
267
268
if self._branch_format == 4:
269
self.inventory_store = get_store('inventory-store')
270
self.text_store = get_store('text-store')
271
self.revision_store = get_store('revision-store')
272
elif self._branch_format == 5:
273
self.control_weaves = get_weave([])
274
self.weave_store = get_weave('weaves')
275
self.revision_store = get_store('revision-store', compressed=False)
276
elif self._branch_format == 6:
277
self.control_weaves = get_weave([])
278
self.weave_store = get_weave('weaves', prefixed=True)
279
self.revision_store = get_store('revision-store', compressed=False,
280
prefixed=True)
281
self._transaction = None
282
283
def __str__(self):
284
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
285
286
287
__repr__ = __str__
288
289
290
def __del__(self):
291
if self._lock_mode or self._lock:
292
# XXX: This should show something every time, and be suitable for
293
# headless operation and embedding
294
warn("branch %r was not explicitly unlocked" % self)
295
self._lock.unlock()
296
297
# TODO: It might be best to do this somewhere else,
298
# but it is nice for a Branch object to automatically
299
# cache it's information.
300
# Alternatively, we could have the Transport objects cache requests
301
# See the earlier discussion about how major objects (like Branch)
302
# should never expect their __del__ function to run.
303
if hasattr(self, 'cache_root') and self.cache_root is not None:
304
try:
305
import shutil
306
shutil.rmtree(self.cache_root)
307
except:
308
pass
309
self.cache_root = None
310
311
def _get_base(self):
312
if self._transport:
313
return self._transport.base
314
return None
315
316
base = property(_get_base)
317
318
def _finish_transaction(self):
319
"""Exit the current transaction."""
320
if self._transaction is None:
321
raise errors.LockError('Branch %s is not in a transaction' %
322
self)
323
transaction = self._transaction
324
self._transaction = None
325
transaction.finish()
326
327
def get_transaction(self):
328
"""Return the current active transaction.
329
330
If no transaction is active, this returns a passthrough object
331
for which all data is immedaitely flushed and no caching happens.
332
"""
333
if self._transaction is None:
334
return transactions.PassThroughTransaction()
335
else:
336
return self._transaction
337
338
def _set_transaction(self, new_transaction):
339
"""Set a new active transaction."""
340
if self._transaction is not None:
341
raise errors.LockError('Branch %s is in a transaction already.' %
342
self)
343
self._transaction = new_transaction
160
344
161
345
def lock_write(self):
162
raise NotImplementedError('lock_write is abstract')
346
mutter("lock write: %s (%s)", self, self._lock_count)
347
# TODO: Upgrade locking to support using a Transport,
348
# and potentially a remote locking protocol
349
if self._lock_mode:
350
if self._lock_mode != 'w':
351
raise LockError("can't upgrade to a write lock from %r" %
352
self._lock_mode)
353
self._lock_count += 1
354
else:
355
self._lock = self._transport.lock_write(
356
self._rel_controlfilename('branch-lock'))
357
self._lock_mode = 'w'
358
self._lock_count = 1
359
self._set_transaction(transactions.PassThroughTransaction())
163
360
164
361
def lock_read(self):
165
raise NotImplementedError('lock_read is abstract')
166
362
mutter("lock read: %s (%s)", self, self._lock_count)
363
if self._lock_mode:
364
assert self._lock_mode in ('r', 'w'), \
365
"invalid lock mode %r" % self._lock_mode
366
self._lock_count += 1
367
else:
368
self._lock = self._transport.lock_read(
369
self._rel_controlfilename('branch-lock'))
370
self._lock_mode = 'r'
371
self._lock_count = 1
372
self._set_transaction(transactions.ReadOnlyTransaction())
373
# 5K may be excessive, but hey, its a knob.
374
self.get_transaction().set_cache_size(5000)
375
167
376
def unlock(self):
168
raise NotImplementedError('unlock is abstract')
169
170
def peek_lock_mode(self):
171
"""Return lock mode for the Branch: 'r', 'w' or None"""
172
raise NotImplementedError(self.peek_lock_mode)
173
174
def get_physical_lock_status(self):
175
raise NotImplementedError('get_physical_lock_status is abstract')
377
mutter("unlock: %s (%s)", self, self._lock_count)
378
if not self._lock_mode:
379
raise LockError('branch %r is not locked' % (self))
380
381
if self._lock_count > 1:
382
self._lock_count -= 1
383
else:
384
self._finish_transaction()
385
self._lock.unlock()
386
self._lock = None
387
self._lock_mode = self._lock_count = None
176
388
177
389
def abspath(self, name):
178
"""Return absolute filename for something in the branch
179
180
XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
method and not a tree method.
182
"""
183
raise NotImplementedError('abspath is abstract')
184
185
def bind(self, other):
186
"""Bind the local branch the other branch.
187
188
:param other: The branch to bind to
189
:type other: Branch
190
"""
191
raise errors.UpgradeRequired(self.base)
192
193
@needs_write_lock
194
def fetch(self, from_branch, last_revision=None, pb=None):
195
"""Copy revisions from from_branch into this branch.
196
197
:param from_branch: Where to copy from.
198
:param last_revision: What revision to stop at (None for at the end
199
of the branch.
200
:param pb: An optional progress bar to use.
201
202
Returns the copied revision count and the failed revisions in a tuple:
203
(copied, failures).
204
"""
205
if self.base == from_branch.base:
206
return (0, [])
207
if pb is None:
208
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
209
pb = nested_pb
390
"""Return absolute filename for something in the branch"""
391
return self._transport.abspath(name)
392
393
def relpath(self, path):
394
"""Return path relative to this branch of something inside it.
395
396
Raises an error if path is not in this branch."""
397
return self._transport.relpath(path)
398
399
400
def _rel_controlfilename(self, file_or_path):
401
if isinstance(file_or_path, basestring):
402
file_or_path = [file_or_path]
403
return [bzrlib.BZRDIR] + file_or_path
404
405
def controlfilename(self, file_or_path):
406
"""Return location relative to branch."""
407
return self._transport.abspath(self._rel_controlfilename(file_or_path))
408
409
410
def controlfile(self, file_or_path, mode='r'):
411
"""Open a control file for this branch.
412
413
There are two classes of file in the control directory: text
414
and binary. binary files are untranslated byte streams. Text
415
control files are stored with Unix newlines and in UTF-8, even
416
if the platform or locale defaults are different.
417
418
Controlfiles should almost never be opened in write mode but
419
rather should be atomically copied and replaced using atomicfile.
420
"""
421
import codecs
422
423
relpath = self._rel_controlfilename(file_or_path)
424
#TODO: codecs.open() buffers linewise, so it was overloaded with
425
# a much larger buffer, do we need to do the same for getreader/getwriter?
426
if mode == 'rb':
427
return self._transport.get(relpath)
428
elif mode == 'wb':
429
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
430
elif mode == 'r':
431
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
432
elif mode == 'w':
433
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
210
434
else:
211
nested_pb = None
212
213
from_branch.lock_read()
214
try:
215
if last_revision is None:
216
pb.update('get source history')
217
from_history = from_branch.revision_history()
218
if from_history:
219
last_revision = from_history[-1]
435
raise BzrError("invalid controlfile mode %r" % mode)
436
437
def put_controlfile(self, path, f, encode=True):
438
"""Write an entry as a controlfile.
439
440
:param path: The path to put the file, relative to the .bzr control
441
directory
442
:param f: A file-like or string object whose contents should be copied.
443
:param encode: If true, encode the contents as utf-8
444
"""
445
self.put_controlfiles([(path, f)], encode=encode)
446
447
def put_controlfiles(self, files, encode=True):
448
"""Write several entries as controlfiles.
449
450
:param files: A list of [(path, file)] pairs, where the path is the directory
451
underneath the bzr control directory
452
:param encode: If true, encode the contents as utf-8
453
"""
454
import codecs
455
ctrl_files = []
456
for path, f in files:
457
if encode:
458
if isinstance(f, basestring):
459
f = f.encode('utf-8', 'replace')
220
460
else:
221
# no history in the source branch
222
last_revision = NULL_REVISION
223
return self.repository.fetch(from_branch.repository,
224
revision_id=last_revision,
225
pb=nested_pb)
226
finally:
227
if nested_pb is not None:
228
nested_pb.finished()
229
from_branch.unlock()
230
231
def get_bound_location(self):
232
"""Return the URL of the branch we are bound to.
233
234
Older format branches cannot bind, please be sure to use a metadir
235
branch.
236
"""
237
return None
238
239
def get_master_branch(self):
240
"""Return the branch we are bound to.
461
f = codecs.getwriter('utf-8')(f, errors='replace')
462
path = self._rel_controlfilename(path)
463
ctrl_files.append((path, f))
464
self._transport.put_multi(ctrl_files)
465
466
def _make_control(self):
467
from bzrlib.inventory import Inventory
468
from bzrlib.weavefile import write_weave_v5
469
from bzrlib.weave import Weave
241
470
242
:return: Either a Branch, or None
471
# Create an empty inventory
472
sio = StringIO()
473
# if we want per-tree root ids then this is the place to set
474
# them; they're not needed for now and so ommitted for
475
# simplicity.
476
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
477
empty_inv = sio.getvalue()
478
sio = StringIO()
479
bzrlib.weavefile.write_weave_v5(Weave(), sio)
480
empty_weave = sio.getvalue()
481
482
dirs = [[], 'revision-store', 'weaves']
483
files = [('README',
484
"This is a Bazaar-NG control directory.\n"
485
"Do not change any files in this directory.\n"),
486
('branch-format', BZR_BRANCH_FORMAT_6),
487
('revision-history', ''),
488
('branch-name', ''),
489
('branch-lock', ''),
490
('pending-merges', ''),
491
('inventory', empty_inv),
492
('inventory.weave', empty_weave),
493
('ancestry.weave', empty_weave)
494
]
495
cfn = self._rel_controlfilename
496
self._transport.mkdir_multi([cfn(d) for d in dirs])
497
self.put_controlfiles(files)
498
mutter('created control directory in ' + self._transport.base)
499
500
def _check_format(self, relax_version_check):
501
"""Check this branch format is supported.
502
503
The format level is stored, as an integer, in
504
self._branch_format for code that needs to check it later.
505
506
In the future, we might need different in-memory Branch
507
classes to support downlevel branches. But not yet.
243
508
"""
244
return None
509
try:
510
fmt = self.controlfile('branch-format', 'r').read()
511
except NoSuchFile:
512
raise NotBranchError(self.base)
513
mutter("got branch format %r", fmt)
514
if fmt == BZR_BRANCH_FORMAT_6:
515
self._branch_format = 6
516
elif fmt == BZR_BRANCH_FORMAT_5:
517
self._branch_format = 5
518
elif fmt == BZR_BRANCH_FORMAT_4:
519
self._branch_format = 4
520
521
if (not relax_version_check
522
and self._branch_format not in (5, 6)):
523
raise errors.UnsupportedFormatError(
524
'sorry, branch format %r not supported' % fmt,
525
['use a different bzr version',
526
'or remove the .bzr directory'
527
' and "bzr init" again'])
245
528
246
529
def get_root_id(self):
247
530
"""Return the id of this branches root"""
248
raise NotImplementedError('get_root_id is abstract')
249
250
def print_file(self, file, revision_id):
531
inv = self.read_working_inventory()
532
return inv.root.file_id
533
534
def set_root_id(self, file_id):
535
inv = self.read_working_inventory()
536
orig_root_id = inv.root.file_id
537
del inv._byid[inv.root.file_id]
538
inv.root.file_id = file_id
539
inv._byid[inv.root.file_id] = inv.root
540
for fid in inv:
541
entry = inv[fid]
542
if entry.parent_id in (None, orig_root_id):
543
entry.parent_id = inv.root.file_id
544
self._write_inventory(inv)
545
546
def read_working_inventory(self):
547
"""Read the working inventory."""
548
self.lock_read()
549
try:
550
# ElementTree does its own conversion from UTF-8, so open in
551
# binary.
552
f = self.controlfile('inventory', 'rb')
553
return bzrlib.xml5.serializer_v5.read_inventory(f)
554
finally:
555
self.unlock()
556
557
558
def _write_inventory(self, inv):
559
"""Update the working inventory.
560
561
That is to say, the inventory describing changes underway, that
562
will be committed to the next revision.
563
"""
564
from cStringIO import StringIO
565
self.lock_write()
566
try:
567
sio = StringIO()
568
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
569
sio.seek(0)
570
# Transport handles atomicity
571
self.put_controlfile('inventory', sio)
572
finally:
573
self.unlock()
574
575
mutter('wrote working inventory')
576
577
inventory = property(read_working_inventory, _write_inventory, None,
578
"""Inventory for the working copy.""")
579
580
def add(self, files, ids=None):
581
"""Make files versioned.
582
583
Note that the command line normally calls smart_add instead,
584
which can automatically recurse.
585
586
This puts the files in the Added state, so that they will be
587
recorded by the next commit.
588
589
files
590
List of paths to add, relative to the base of the tree.
591
592
ids
593
If set, use these instead of automatically generated ids.
594
Must be the same length as the list of files, but may
595
contain None for ids that are to be autogenerated.
596
597
TODO: Perhaps have an option to add the ids even if the files do
598
not (yet) exist.
599
600
TODO: Perhaps yield the ids and paths as they're added.
601
"""
602
# TODO: Re-adding a file that is removed in the working copy
603
# should probably put it back with the previous ID.
604
if isinstance(files, basestring):
605
assert(ids is None or isinstance(ids, basestring))
606
files = [files]
607
if ids is not None:
608
ids = [ids]
609
610
if ids is None:
611
ids = [None] * len(files)
612
else:
613
assert(len(ids) == len(files))
614
615
self.lock_write()
616
try:
617
inv = self.read_working_inventory()
618
for f,file_id in zip(files, ids):
619
if is_control_file(f):
620
raise BzrError("cannot add control file %s" % quotefn(f))
621
622
fp = splitpath(f)
623
624
if len(fp) == 0:
625
raise BzrError("cannot add top-level %r" % f)
626
627
fullpath = os.path.normpath(self.abspath(f))
628
629
try:
630
kind = file_kind(fullpath)
631
except OSError:
632
# maybe something better?
633
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
634
635
if not InventoryEntry.versionable_kind(kind):
636
raise BzrError('cannot add: not a versionable file ('
637
'i.e. regular file, symlink or directory): %s' % quotefn(f))
638
639
if file_id is None:
640
file_id = gen_file_id(f)
641
inv.add_path(f, kind=kind, file_id=file_id)
642
643
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
644
645
self._write_inventory(inv)
646
finally:
647
self.unlock()
648
649
650
def print_file(self, file, revno):
251
651
"""Print `file` to stdout."""
252
raise NotImplementedError('print_file is abstract')
652
self.lock_read()
653
try:
654
tree = self.revision_tree(self.get_rev_id(revno))
655
# use inventory as it was in that revision
656
file_id = tree.inventory.path2id(file)
657
if not file_id:
658
raise BzrError("%r is not present in revision %s" % (file, revno))
659
tree.print_file(file_id)
660
finally:
661
self.unlock()
662
663
664
def remove(self, files, verbose=False):
665
"""Mark nominated files for removal from the inventory.
666
667
This does not remove their text. This does not run on
668
669
TODO: Refuse to remove modified files unless --force is given?
670
671
TODO: Do something useful with directories.
672
673
TODO: Should this remove the text or not? Tough call; not
674
removing may be useful and the user can just use use rm, and
675
is the opposite of add. Removing it is consistent with most
676
other tools. Maybe an option.
677
"""
678
## TODO: Normalize names
679
## TODO: Remove nested loops; better scalability
680
if isinstance(files, basestring):
681
files = [files]
682
683
self.lock_write()
684
685
try:
686
tree = self.working_tree()
687
inv = tree.inventory
688
689
# do this before any modifications
690
for f in files:
691
fid = inv.path2id(f)
692
if not fid:
693
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
694
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
695
if verbose:
696
# having remove it, it must be either ignored or unknown
697
if tree.is_ignored(f):
698
new_status = 'I'
699
else:
700
new_status = '?'
701
show_status(new_status, inv[fid].kind, quotefn(f))
702
del inv[fid]
703
704
self._write_inventory(inv)
705
finally:
706
self.unlock()
707
708
# FIXME: this doesn't need to be a branch method
709
def set_inventory(self, new_inventory_list):
710
from bzrlib.inventory import Inventory, InventoryEntry
711
inv = Inventory(self.get_root_id())
712
for path, file_id, parent, kind in new_inventory_list:
713
name = os.path.basename(path)
714
if name == "":
715
continue
716
# fixme, there should be a factory function inv,add_??
717
if kind == 'directory':
718
inv.add(inventory.InventoryDirectory(file_id, name, parent))
719
elif kind == 'file':
720
inv.add(inventory.InventoryFile(file_id, name, parent))
721
elif kind == 'symlink':
722
inv.add(inventory.InventoryLink(file_id, name, parent))
723
else:
724
raise BzrError("unknown kind %r" % kind)
725
self._write_inventory(inv)
726
727
def unknowns(self):
728
"""Return all unknown files.
729
730
These are files in the working directory that are not versioned or
731
control files or ignored.
732
733
>>> b = ScratchBranch(files=['foo', 'foo~'])
734
>>> list(b.unknowns())
735
['foo']
736
>>> b.add('foo')
737
>>> list(b.unknowns())
738
[]
739
>>> b.remove('foo')
740
>>> list(b.unknowns())
741
['foo']
742
"""
743
return self.working_tree().unknowns()
744
253
745
254
746
def append_revision(self, *revision_ids):
255
raise NotImplementedError('append_revision is abstract')
256
257
def set_revision_history(self, rev_history):
258
raise NotImplementedError('set_revision_history is abstract')
747
for revision_id in revision_ids:
748
mutter("add {%s} to revision-history" % revision_id)
749
self.lock_write()
750
try:
751
rev_history = self.revision_history()
752
rev_history.extend(revision_ids)
753
self.put_controlfile('revision-history', '\n'.join(rev_history))
754
finally:
755
self.unlock()
756
757
def has_revision(self, revision_id):
758
"""True if this branch has a copy of the revision.
759
760
This does not necessarily imply the revision is merge
761
or on the mainline."""
762
return (revision_id is None
763
or revision_id in self.revision_store)
764
765
def get_revision_xml_file(self, revision_id):
766
"""Return XML file object for revision object."""
767
if not revision_id or not isinstance(revision_id, basestring):
768
raise InvalidRevisionId(revision_id)
769
770
self.lock_read()
771
try:
772
try:
773
return self.revision_store[revision_id]
774
except (IndexError, KeyError):
775
raise bzrlib.errors.NoSuchRevision(self, revision_id)
776
finally:
777
self.unlock()
778
779
#deprecated
780
get_revision_xml = get_revision_xml_file
781
782
def get_revision_xml(self, revision_id):
783
return self.get_revision_xml_file(revision_id).read()
784
785
786
def get_revision(self, revision_id):
787
"""Return the Revision object for a named revision"""
788
xml_file = self.get_revision_xml_file(revision_id)
789
790
try:
791
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
792
except SyntaxError, e:
793
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
794
[revision_id,
795
str(e)])
796
797
assert r.revision_id == revision_id
798
return r
799
800
def get_revision_delta(self, revno):
801
"""Return the delta for one revision.
802
803
The delta is relative to its mainline predecessor, or the
804
empty tree for revision 1.
805
"""
806
assert isinstance(revno, int)
807
rh = self.revision_history()
808
if not (1 <= revno <= len(rh)):
809
raise InvalidRevisionNumber(revno)
810
811
# revno is 1-based; list is 0-based
812
813
new_tree = self.revision_tree(rh[revno-1])
814
if revno == 1:
815
old_tree = EmptyTree()
816
else:
817
old_tree = self.revision_tree(rh[revno-2])
818
819
return compare_trees(old_tree, new_tree)
820
821
def get_revision_sha1(self, revision_id):
822
"""Hash the stored value of a revision, and return it."""
823
# In the future, revision entries will be signed. At that
824
# point, it is probably best *not* to include the signature
825
# in the revision hash. Because that lets you re-sign
826
# the revision, (add signatures/remove signatures) and still
827
# have all hash pointers stay consistent.
828
# But for now, just hash the contents.
829
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
830
831
def get_ancestry(self, revision_id):
832
"""Return a list of revision-ids integrated by a revision.
833
834
This currently returns a list, but the ordering is not guaranteed:
835
treat it as a set.
836
"""
837
if revision_id is None:
838
return [None]
839
w = self.get_inventory_weave()
840
return [None] + map(w.idx_to_name,
841
w.inclusions([w.lookup(revision_id)]))
842
843
def get_inventory_weave(self):
844
return self.control_weaves.get_weave('inventory',
845
self.get_transaction())
846
847
def get_inventory(self, revision_id):
848
"""Get Inventory object by hash."""
849
xml = self.get_inventory_xml(revision_id)
850
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
851
852
def get_inventory_xml(self, revision_id):
853
"""Get inventory XML as a file object."""
854
try:
855
assert isinstance(revision_id, basestring), type(revision_id)
856
iw = self.get_inventory_weave()
857
return iw.get_text(iw.lookup(revision_id))
858
except IndexError:
859
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
860
861
def get_inventory_sha1(self, revision_id):
862
"""Return the sha1 hash of the inventory entry
863
"""
864
return self.get_revision(revision_id).inventory_sha1
865
866
def get_revision_inventory(self, revision_id):
867
"""Return inventory of a past revision."""
868
# TODO: Unify this with get_inventory()
869
# bzr 0.0.6 and later imposes the constraint that the inventory_id
870
# must be the same as its revision, so this is trivial.
871
if revision_id == None:
872
return Inventory(self.get_root_id())
873
else:
874
return self.get_inventory(revision_id)
259
875
260
876
def revision_history(self):
261
877
"""Return sequence of revision hashes on to this branch."""
262
raise NotImplementedError('revision_history is abstract')
878
self.lock_read()
879
try:
880
transaction = self.get_transaction()
881
history = transaction.map.find_revision_history()
882
if history is not None:
883
mutter("cache hit for revision-history in %s", self)
884
return list(history)
885
history = [l.rstrip('\r\n') for l in
886
self.controlfile('revision-history', 'r').readlines()]
887
transaction.map.add_revision_history(history)
888
# this call is disabled because revision_history is
889
# not really an object yet, and the transaction is for objects.
890
# transaction.register_clean(history, precious=True)
891
return list(history)
892
finally:
893
self.unlock()
894
895
def common_ancestor(self, other, self_revno=None, other_revno=None):
896
"""
897
>>> from bzrlib.commit import commit
898
>>> sb = ScratchBranch(files=['foo', 'foo~'])
899
>>> sb.common_ancestor(sb) == (None, None)
900
True
901
>>> commit(sb, "Committing first revision", verbose=False)
902
>>> sb.common_ancestor(sb)[0]
903
1
904
>>> clone = sb.clone()
905
>>> commit(sb, "Committing second revision", verbose=False)
906
>>> sb.common_ancestor(sb)[0]
907
2
908
>>> sb.common_ancestor(clone)[0]
909
1
910
>>> commit(clone, "Committing divergent second revision",
911
... verbose=False)
912
>>> sb.common_ancestor(clone)[0]
913
1
914
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
915
True
916
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
917
True
918
>>> clone2 = sb.clone()
919
>>> sb.common_ancestor(clone2)[0]
920
2
921
>>> sb.common_ancestor(clone2, self_revno=1)[0]
922
1
923
>>> sb.common_ancestor(clone2, other_revno=1)[0]
924
1
925
"""
926
my_history = self.revision_history()
927
other_history = other.revision_history()
928
if self_revno is None:
929
self_revno = len(my_history)
930
if other_revno is None:
931
other_revno = len(other_history)
932
indices = range(min((self_revno, other_revno)))
933
indices.reverse()
934
for r in indices:
935
if my_history[r] == other_history[r]:
936
return r+1, my_history[r]
937
return None, None
938
263
939
264
940
def revno(self):
265
941
"""Return current revision number for this branch.
269
945
"""
270
946
return len(self.revision_history())
271
947
272
def unbind(self):
273
"""Older format branches cannot bind or unbind."""
274
raise errors.UpgradeRequired(self.base)
275
948
276
949
def last_revision(self):
277
"""Return last patch hash, or None if no history."""
950
"""Return last patch hash, or None if no history.
951
"""
278
952
ph = self.revision_history()
279
953
if ph:
280
954
return ph[-1]
281
955
else:
282
956
return None
283
957
284
def missing_revisions(self, other, stop_revision=None):
958
959
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
285
960
"""Return a list of new revisions that would perfectly fit.
286
961
287
962
If self and other have not diverged, return a list of the revisions
288
963
present in other, but missing from self.
289
964
290
>>> from bzrlib.workingtree import WorkingTree
965
>>> from bzrlib.commit import commit
291
966
>>> bzrlib.trace.silent = True
292
>>> d1 = bzrdir.ScratchDir()
293
>>> br1 = d1.open_branch()
294
>>> wt1 = d1.open_workingtree()
295
>>> d2 = bzrdir.ScratchDir()
296
>>> br2 = d2.open_branch()
297
>>> wt2 = d2.open_workingtree()
967
>>> br1 = ScratchBranch()
968
>>> br2 = ScratchBranch()
298
969
>>> br1.missing_revisions(br2)
299
970
[]
300
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
971
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
301
972
>>> br1.missing_revisions(br2)
302
973
[u'REVISION-ID-1']
303
974
>>> br2.missing_revisions(br1)
304
975
[]
305
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
976
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
306
977
>>> br1.missing_revisions(br2)
307
978
[]
308
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
979
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
309
980
>>> br1.missing_revisions(br2)
310
981
[u'REVISION-ID-2A']
311
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
982
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
312
983
>>> br1.missing_revisions(br2)
313
984
Traceback (most recent call last):
314
DivergedBranches: These branches have diverged. Try merge.
985
DivergedBranches: These branches have diverged.
315
986
"""
987
# FIXME: If the branches have diverged, but the latest
988
# revision in this branch is completely merged into the other,
989
# then we should still be able to pull.
316
990
self_history = self.revision_history()
317
991
self_len = len(self_history)
318
992
other_history = other.revision_history()
331
1005
return other_history[self_len:stop_revision]
332
1006
333
1007
def update_revisions(self, other, stop_revision=None):
334
"""Pull in new perfect-fit revisions.
335
336
:param other: Another Branch to pull from
337
:param stop_revision: Updated until the given revision
338
:return: None
339
"""
340
raise NotImplementedError('update_revisions is abstract')
341
1008
"""Pull in new perfect-fit revisions."""
1009
from bzrlib.fetch import greedy_fetch
1010
from bzrlib.revision import get_intervening_revisions
1011
if stop_revision is None:
1012
stop_revision = other.last_revision()
1013
if (stop_revision is not None and
1014
stop_revision in self.revision_history()):
1015
return
1016
greedy_fetch(to_branch=self, from_branch=other,
1017
revision=stop_revision)
1018
pullable_revs = self.missing_revisions(
1019
other, other.revision_id_to_revno(stop_revision))
1020
if pullable_revs:
1021
greedy_fetch(to_branch=self,
1022
from_branch=other,
1023
revision=pullable_revs[-1])
1024
self.append_revision(*pullable_revs)
1025
1026
1027
def commit(self, *args, **kw):
1028
from bzrlib.commit import Commit
1029
Commit().commit(self, *args, **kw)
1030
342
1031
def revision_id_to_revno(self, revision_id):
343
1032
"""Given a revision id, return its revno"""
344
1033
if revision_id is None:
359
1048
raise bzrlib.errors.NoSuchRevision(self, revno)
360
1049
return history[revno - 1]
361
1050
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
1051
def revision_tree(self, revision_id):
1052
"""Return Tree for a revision on this branch.
1053
1054
`revision_id` may be None for the null revision, in which case
1055
an `EmptyTree` is returned."""
1056
# TODO: refactor this to use an existing revision object
1057
# so we don't need to read it in twice.
1058
if revision_id == None:
1059
return EmptyTree()
1060
else:
1061
inv = self.get_revision_inventory(revision_id)
1062
return RevisionTree(self.weave_store, inv, revision_id)
1063
1064
1065
def working_tree(self):
1066
"""Return a `Tree` for the working copy."""
1067
from bzrlib.workingtree import WorkingTree
1068
# TODO: In the future, WorkingTree should utilize Transport
1069
# RobertCollins 20051003 - I don't think it should - working trees are
1070
# much more complex to keep consistent than our careful .bzr subset.
1071
# instead, we should say that working trees are local only, and optimise
1072
# for that.
1073
return WorkingTree(self._transport.base, self.read_working_inventory())
1074
364
1075
365
1076
def basis_tree(self):
366
1077
"""Return `Tree` object for last revision.
367
1078
368
1079
If there are no revisions yet, return an `EmptyTree`.
369
1080
"""
370
return self.repository.revision_tree(self.last_revision())
1081
return self.revision_tree(self.last_revision())
1082
371
1083
372
1084
def rename_one(self, from_rel, to_rel):
373
1085
"""Rename one file.
374
1086
375
1087
This can change the directory or the filename or both.
376
1088
"""
377
raise NotImplementedError('rename_one is abstract')
1089
self.lock_write()
1090
try:
1091
tree = self.working_tree()
1092
inv = tree.inventory
1093
if not tree.has_filename(from_rel):
1094
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1095
if tree.has_filename(to_rel):
1096
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1097
1098
file_id = inv.path2id(from_rel)
1099
if file_id == None:
1100
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1101
1102
if inv.path2id(to_rel):
1103
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1104
1105
to_dir, to_tail = os.path.split(to_rel)
1106
to_dir_id = inv.path2id(to_dir)
1107
if to_dir_id == None and to_dir != '':
1108
raise BzrError("can't determine destination directory id for %r" % to_dir)
1109
1110
mutter("rename_one:")
1111
mutter(" file_id {%s}" % file_id)
1112
mutter(" from_rel %r" % from_rel)
1113
mutter(" to_rel %r" % to_rel)
1114
mutter(" to_dir %r" % to_dir)
1115
mutter(" to_dir_id {%s}" % to_dir_id)
1116
1117
inv.rename(file_id, to_dir_id, to_tail)
1118
1119
from_abs = self.abspath(from_rel)
1120
to_abs = self.abspath(to_rel)
1121
try:
1122
rename(from_abs, to_abs)
1123
except OSError, e:
1124
raise BzrError("failed to rename %r to %r: %s"
1125
% (from_abs, to_abs, e[1]),
1126
["rename rolled back"])
1127
1128
self._write_inventory(inv)
1129
finally:
1130
self.unlock()
1131
378
1132
379
1133
def move(self, from_paths, to_name):
380
1134
"""Rename files.
390
1144
This returns a list of (from_path, to_path) pairs for each
391
1145
entry that is moved.
392
1146
"""
393
raise NotImplementedError('move is abstract')
1147
result = []
1148
self.lock_write()
1149
try:
1150
## TODO: Option to move IDs only
1151
assert not isinstance(from_paths, basestring)
1152
tree = self.working_tree()
1153
inv = tree.inventory
1154
to_abs = self.abspath(to_name)
1155
if not isdir(to_abs):
1156
raise BzrError("destination %r is not a directory" % to_abs)
1157
if not tree.has_filename(to_name):
1158
raise BzrError("destination %r not in working directory" % to_abs)
1159
to_dir_id = inv.path2id(to_name)
1160
if to_dir_id == None and to_name != '':
1161
raise BzrError("destination %r is not a versioned directory" % to_name)
1162
to_dir_ie = inv[to_dir_id]
1163
if to_dir_ie.kind not in ('directory', 'root_directory'):
1164
raise BzrError("destination %r is not a directory" % to_abs)
1165
1166
to_idpath = inv.get_idpath(to_dir_id)
1167
1168
for f in from_paths:
1169
if not tree.has_filename(f):
1170
raise BzrError("%r does not exist in working tree" % f)
1171
f_id = inv.path2id(f)
1172
if f_id == None:
1173
raise BzrError("%r is not versioned" % f)
1174
name_tail = splitpath(f)[-1]
1175
dest_path = appendpath(to_name, name_tail)
1176
if tree.has_filename(dest_path):
1177
raise BzrError("destination %r already exists" % dest_path)
1178
if f_id in to_idpath:
1179
raise BzrError("can't move %r to a subdirectory of itself" % f)
1180
1181
# OK, so there's a race here, it's possible that someone will
1182
# create a file in this interval and then the rename might be
1183
# left half-done. But we should have caught most problems.
1184
1185
for f in from_paths:
1186
name_tail = splitpath(f)[-1]
1187
dest_path = appendpath(to_name, name_tail)
1188
result.append((f, dest_path))
1189
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1190
try:
1191
rename(self.abspath(f), self.abspath(dest_path))
1192
except OSError, e:
1193
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1194
["rename rolled back"])
1195
1196
self._write_inventory(inv)
1197
finally:
1198
self.unlock()
1199
1200
return result
1201
1202
1203
def revert(self, filenames, old_tree=None, backups=True):
1204
"""Restore selected files to the versions from a previous tree.
1205
1206
backups
1207
If true (default) backups are made of files before
1208
they're renamed.
1209
"""
1210
from bzrlib.errors import NotVersionedError, BzrError
1211
from bzrlib.atomicfile import AtomicFile
1212
from bzrlib.osutils import backup_file
1213
1214
inv = self.read_working_inventory()
1215
if old_tree is None:
1216
old_tree = self.basis_tree()
1217
old_inv = old_tree.inventory
1218
1219
nids = []
1220
for fn in filenames:
1221
file_id = inv.path2id(fn)
1222
if not file_id:
1223
raise NotVersionedError("not a versioned file", fn)
1224
if not old_inv.has_id(file_id):
1225
raise BzrError("file not present in old tree", fn, file_id)
1226
nids.append((fn, file_id))
1227
1228
# TODO: Rename back if it was previously at a different location
1229
1230
# TODO: If given a directory, restore the entire contents from
1231
# the previous version.
1232
1233
# TODO: Make a backup to a temporary file.
1234
1235
# TODO: If the file previously didn't exist, delete it?
1236
for fn, file_id in nids:
1237
backup_file(fn)
1238
1239
f = AtomicFile(fn, 'wb')
1240
try:
1241
f.write(old_tree.get_file(file_id).read())
1242
f.commit()
1243
finally:
1244
f.close()
1245
1246
1247
def pending_merges(self):
1248
"""Return a list of pending merges.
1249
1250
These are revisions that have been merged into the working
1251
directory but not yet committed.
1252
"""
1253
cfn = self._rel_controlfilename('pending-merges')
1254
if not self._transport.has(cfn):
1255
return []
1256
p = []
1257
for l in self.controlfile('pending-merges', 'r').readlines():
1258
p.append(l.rstrip('\n'))
1259
return p
1260
1261
1262
def add_pending_merge(self, *revision_ids):
1263
# TODO: Perhaps should check at this point that the
1264
# history of the revision is actually present?
1265
p = self.pending_merges()
1266
updated = False
1267
for rev_id in revision_ids:
1268
if rev_id in p:
1269
continue
1270
p.append(rev_id)
1271
updated = True
1272
if updated:
1273
self.set_pending_merges(p)
1274
1275
def set_pending_merges(self, rev_list):
1276
self.lock_write()
1277
try:
1278
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1279
finally:
1280
self.unlock()
1281
394
1282
395
1283
def get_parent(self):
396
1284
"""Return the parent location of the branch.
399
1287
pattern is that the user can override it by specifying a
400
1288
location.
401
1289
"""
402
raise NotImplementedError('get_parent is abstract')
403
404
def get_push_location(self):
405
"""Return the None or the location to push this branch to."""
406
raise NotImplementedError('get_push_location is abstract')
407
408
def set_push_location(self, location):
409
"""Set a new push location for this branch."""
410
raise NotImplementedError('set_push_location is abstract')
1290
import errno
1291
_locs = ['parent', 'pull', 'x-pull']
1292
for l in _locs:
1293
try:
1294
return self.controlfile(l, 'r').read().strip('\n')
1295
except IOError, e:
1296
if e.errno != errno.ENOENT:
1297
raise
1298
return None
1299
411
1300
412
1301
def set_parent(self, url):
413
raise NotImplementedError('set_parent is abstract')
414
415
@needs_write_lock
416
def update(self):
417
"""Synchronise this branch with the master branch if any.
418
419
:return: None or the last_revision pivoted out during the update.
420
"""
421
return None
1302
# TODO: Maybe delete old location files?
1303
from bzrlib.atomicfile import AtomicFile
1304
self.lock_write()
1305
try:
1306
f = AtomicFile(self.controlfilename('parent'))
1307
try:
1308
f.write(url + '\n')
1309
f.commit()
1310
finally:
1311
f.close()
1312
finally:
1313
self.unlock()
422
1314
423
1315
def check_revno(self, revno):
424
1316
"""\
435
1327
"""
436
1328
if revno < 1 or revno > self.revno():
437
1329
raise InvalidRevisionNumber(revno)
438
439
@needs_read_lock
440
def clone(self, *args, **kwargs):
441
"""Clone this branch into to_bzrdir preserving all semantic values.
442
443
revision_id: if not None, the revision history in the new branch will
444
be truncated to end with revision_id.
445
"""
446
# for API compatability, until 0.8 releases we provide the old api:
447
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
448
# after 0.8 releases, the *args and **kwargs should be changed:
449
# def clone(self, to_bzrdir, revision_id=None):
450
if (kwargs.get('to_location', None) or
451
kwargs.get('revision', None) or
452
kwargs.get('basis_branch', None) or
453
(len(args) and isinstance(args[0], basestring))):
454
# backwards compatability api:
455
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
456
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
457
# get basis_branch
458
if len(args) > 2:
459
basis_branch = args[2]
460
else:
461
basis_branch = kwargs.get('basis_branch', None)
462
if basis_branch:
463
basis = basis_branch.bzrdir
464
else:
465
basis = None
466
# get revision
467
if len(args) > 1:
468
revision_id = args[1]
469
else:
470
revision_id = kwargs.get('revision', None)
471
# get location
472
if len(args):
473
url = args[0]
474
else:
475
# no default to raise if not provided.
476
url = kwargs.get('to_location')
477
return self.bzrdir.clone(url,
478
revision_id=revision_id,
479
basis=basis).open_branch()
480
# new cleaner api.
481
# generate args by hand
482
if len(args) > 1:
483
revision_id = args[1]
484
else:
485
revision_id = kwargs.get('revision_id', None)
486
if len(args):
487
to_bzrdir = args[0]
488
else:
489
# no default to raise if not provided.
490
to_bzrdir = kwargs.get('to_bzrdir')
491
result = self._format.initialize(to_bzrdir)
492
self.copy_content_into(result, revision_id=revision_id)
493
return result
494
495
@needs_read_lock
496
def sprout(self, to_bzrdir, revision_id=None):
497
"""Create a new line of development from the branch, into to_bzrdir.
498
499
revision_id: if not None, the revision history in the new branch will
500
be truncated to end with revision_id.
501
"""
502
result = self._format.initialize(to_bzrdir)
503
self.copy_content_into(result, revision_id=revision_id)
504
result.set_parent(self.bzrdir.root_transport.base)
505
return result
506
507
@needs_read_lock
508
def copy_content_into(self, destination, revision_id=None):
509
"""Copy the content of self into destination.
510
511
revision_id: if not None, the revision history in the new branch will
512
be truncated to end with revision_id.
513
"""
514
new_history = self.revision_history()
515
if revision_id is not None:
516
try:
517
new_history = new_history[:new_history.index(revision_id) + 1]
518
except ValueError:
519
rev = self.repository.get_revision(revision_id)
520
new_history = rev.get_history(self.repository)[1:]
521
destination.set_revision_history(new_history)
522
parent = self.get_parent()
523
if parent:
524
destination.set_parent(parent)
525
526
527
class BranchFormat(object):
528
"""An encapsulation of the initialization and open routines for a format.
529
530
Formats provide three things:
531
* An initialization routine,
532
* a format string,
533
* an open routine.
534
535
Formats are placed in an dict by their format string for reference
536
during branch opening. Its not required that these be instances, they
537
can be classes themselves with class methods - it simply depends on
538
whether state is needed for a given format or not.
539
540
Once a format is deprecated, just deprecate the initialize and open
541
methods on the format class. Do not deprecate the object, as the
542
object will be created every time regardless.
543
"""
544
545
_default_format = None
546
"""The default format used for new branches."""
547
548
_formats = {}
549
"""The known formats."""
550
551
@classmethod
552
def find_format(klass, a_bzrdir):
553
"""Return the format for the branch object in a_bzrdir."""
554
try:
555
transport = a_bzrdir.get_branch_transport(None)
556
format_string = transport.get("format").read()
557
return klass._formats[format_string]
558
except NoSuchFile:
559
raise NotBranchError(path=transport.base)
560
except KeyError:
561
raise errors.UnknownFormatError(format_string)
562
563
@classmethod
564
def get_default_format(klass):
565
"""Return the current default format."""
566
return klass._default_format
567
568
def get_format_string(self):
569
"""Return the ASCII format string that identifies this format."""
570
raise NotImplementedError(self.get_format_string)
571
572
def get_format_description(self):
573
"""Return the short format description for this format."""
574
raise NotImplementedError(self.get_format_string)
575
576
def initialize(self, a_bzrdir):
577
"""Create a branch of this format in a_bzrdir."""
578
raise NotImplementedError(self.initialized)
579
580
def is_supported(self):
581
"""Is this format supported?
582
583
Supported formats can be initialized and opened.
584
Unsupported formats may not support initialization or committing or
585
some other features depending on the reason for not being supported.
586
"""
587
return True
588
589
def open(self, a_bzrdir, _found=False):
590
"""Return the branch object for a_bzrdir
591
592
_found is a private parameter, do not use it. It is used to indicate
593
if format probing has already be done.
594
"""
595
raise NotImplementedError(self.open)
596
597
@classmethod
598
def register_format(klass, format):
599
klass._formats[format.get_format_string()] = format
600
601
@classmethod
602
def set_default_format(klass, format):
603
klass._default_format = format
604
605
@classmethod
606
def unregister_format(klass, format):
607
assert klass._formats[format.get_format_string()] is format
608
del klass._formats[format.get_format_string()]
609
610
def __str__(self):
611
return self.get_format_string().rstrip()
612
613
614
class BzrBranchFormat4(BranchFormat):
615
"""Bzr branch format 4.
616
617
This format has:
618
- a revision-history file.
619
- a branch-lock lock file [ to be shared with the bzrdir ]
620
"""
621
622
def get_format_description(self):
623
"""See BranchFormat.get_format_description()."""
624
return "Branch format 4"
625
626
def initialize(self, a_bzrdir):
627
"""Create a branch of this format in a_bzrdir."""
628
mutter('creating branch in %s', a_bzrdir.transport.base)
629
branch_transport = a_bzrdir.get_branch_transport(self)
630
utf8_files = [('revision-history', ''),
631
('branch-name', ''),
632
]
633
control_files = LockableFiles(branch_transport, 'branch-lock',
634
TransportLock)
635
control_files.create_lock()
636
control_files.lock_write()
637
try:
638
for file, content in utf8_files:
639
control_files.put_utf8(file, content)
640
finally:
641
control_files.unlock()
642
return self.open(a_bzrdir, _found=True)
643
644
def __init__(self):
645
super(BzrBranchFormat4, self).__init__()
646
self._matchingbzrdir = bzrdir.BzrDirFormat6()
647
648
def open(self, a_bzrdir, _found=False):
649
"""Return the branch object for a_bzrdir
650
651
_found is a private parameter, do not use it. It is used to indicate
652
if format probing has already be done.
653
"""
654
if not _found:
655
# we are being called directly and must probe.
656
raise NotImplementedError
657
return BzrBranch(_format=self,
658
_control_files=a_bzrdir._control_files,
659
a_bzrdir=a_bzrdir,
660
_repository=a_bzrdir.open_repository())
661
662
def __str__(self):
663
return "Bazaar-NG branch format 4"
664
665
666
class BzrBranchFormat5(BranchFormat):
667
"""Bzr branch format 5.
668
669
This format has:
670
- a revision-history file.
671
- a format string
672
- a lock dir guarding the branch itself
673
- all of this stored in a branch/ subdirectory
674
- works with shared repositories.
675
676
This format is new in bzr 0.8.
677
"""
678
679
def get_format_string(self):
680
"""See BranchFormat.get_format_string()."""
681
return "Bazaar-NG branch format 5\n"
682
683
def get_format_description(self):
684
"""See BranchFormat.get_format_description()."""
685
return "Branch format 5"
686
687
def initialize(self, a_bzrdir):
688
"""Create a branch of this format in a_bzrdir."""
689
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
690
branch_transport = a_bzrdir.get_branch_transport(self)
691
utf8_files = [('revision-history', ''),
692
('branch-name', ''),
693
]
694
control_files = LockableFiles(branch_transport, 'lock', LockDir)
695
control_files.create_lock()
696
control_files.lock_write()
697
control_files.put_utf8('format', self.get_format_string())
698
try:
699
for file, content in utf8_files:
700
control_files.put_utf8(file, content)
701
finally:
702
control_files.unlock()
703
return self.open(a_bzrdir, _found=True, )
704
705
def __init__(self):
706
super(BzrBranchFormat5, self).__init__()
707
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
708
709
def open(self, a_bzrdir, _found=False):
710
"""Return the branch object for a_bzrdir
711
712
_found is a private parameter, do not use it. It is used to indicate
713
if format probing has already be done.
714
"""
715
if not _found:
716
format = BranchFormat.find_format(a_bzrdir)
717
assert format.__class__ == self.__class__
718
transport = a_bzrdir.get_branch_transport(None)
719
control_files = LockableFiles(transport, 'lock', LockDir)
720
return BzrBranch5(_format=self,
721
_control_files=control_files,
722
a_bzrdir=a_bzrdir,
723
_repository=a_bzrdir.find_repository())
724
725
def __str__(self):
726
return "Bazaar-NG Metadir branch format 5"
727
728
729
class BranchReferenceFormat(BranchFormat):
730
"""Bzr branch reference format.
731
732
Branch references are used in implementing checkouts, they
733
act as an alias to the real branch which is at some other url.
734
735
This format has:
736
- A location file
737
- a format string
738
"""
739
740
def get_format_string(self):
741
"""See BranchFormat.get_format_string()."""
742
return "Bazaar-NG Branch Reference Format 1\n"
743
744
def get_format_description(self):
745
"""See BranchFormat.get_format_description()."""
746
return "Checkout reference format 1"
747
748
def initialize(self, a_bzrdir, target_branch=None):
749
"""Create a branch of this format in a_bzrdir."""
750
if target_branch is None:
751
# this format does not implement branch itself, thus the implicit
752
# creation contract must see it as uninitializable
753
raise errors.UninitializableFormat(self)
754
mutter('creating branch reference in %s', a_bzrdir.transport.base)
755
branch_transport = a_bzrdir.get_branch_transport(self)
756
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
757
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
758
branch_transport.put('format', StringIO(self.get_format_string()))
759
return self.open(a_bzrdir, _found=True)
760
761
def __init__(self):
762
super(BranchReferenceFormat, self).__init__()
763
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
764
765
def _make_reference_clone_function(format, a_branch):
766
"""Create a clone() routine for a branch dynamically."""
767
def clone(to_bzrdir, revision_id=None):
768
"""See Branch.clone()."""
769
return format.initialize(to_bzrdir, a_branch)
770
# cannot obey revision_id limits when cloning a reference ...
771
# FIXME RBC 20060210 either nuke revision_id for clone, or
772
# emit some sort of warning/error to the caller ?!
773
return clone
774
775
def open(self, a_bzrdir, _found=False):
776
"""Return the branch that the branch reference in a_bzrdir points at.
777
778
_found is a private parameter, do not use it. It is used to indicate
779
if format probing has already be done.
780
"""
781
if not _found:
782
format = BranchFormat.find_format(a_bzrdir)
783
assert format.__class__ == self.__class__
784
transport = a_bzrdir.get_branch_transport(None)
785
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
786
result = real_bzrdir.open_branch()
787
# this changes the behaviour of result.clone to create a new reference
788
# rather than a copy of the content of the branch.
789
# I did not use a proxy object because that needs much more extensive
790
# testing, and we are only changing one behaviour at the moment.
791
# If we decide to alter more behaviours - i.e. the implicit nickname
792
# then this should be refactored to introduce a tested proxy branch
793
# and a subclass of that for use in overriding clone() and ....
794
# - RBC 20060210
795
result.clone = self._make_reference_clone_function(result)
796
return result
797
798
799
# formats which have no format string are not discoverable
800
# and not independently creatable, so are not registered.
801
__default_format = BzrBranchFormat5()
802
BranchFormat.register_format(__default_format)
803
BranchFormat.register_format(BranchReferenceFormat())
804
BranchFormat.set_default_format(__default_format)
805
_legacy_formats = [BzrBranchFormat4(),
806
]
807
808
class BzrBranch(Branch):
809
"""A branch stored in the actual filesystem.
810
811
Note that it's "local" in the context of the filesystem; it doesn't
812
really matter if it's on an nfs/smb/afs/coda/... share, as long as
813
it's writable, and can be accessed via the normal filesystem API.
814
"""
1330
1331
1332
1333
1334
1335
class ScratchBranch(_Branch):
1336
"""Special test class: a branch that cleans up after itself.
1337
1338
>>> b = ScratchBranch()
1339
>>> isdir(b.base)
1340
True
1341
>>> bd = b.base
1342
>>> b.destroy()
1343
>>> isdir(bd)
1344
False
1345
"""
1346
def __init__(self, files=[], dirs=[], base=None):
1347
"""Make a test branch.
1348
1349
This creates a temporary directory and runs init-tree in it.
1350
1351
If any files are listed, they are created in the working copy.
1352
"""
1353
from tempfile import mkdtemp
1354
init = False
1355
if base is None:
1356
base = mkdtemp()
1357
init = True
1358
if isinstance(base, basestring):
1359
base = get_transport(base)
1360
_Branch.__init__(self, base, init=init)
1361
for d in dirs:
1362
self._transport.mkdir(d)
1363
1364
for f in files:
1365
self._transport.put(f, 'content of %s' % f)
1366
1367
1368
def clone(self):
1369
"""
1370
>>> orig = ScratchBranch(files=["file1", "file2"])
1371
>>> clone = orig.clone()
1372
>>> if os.name != 'nt':
1373
... os.path.samefile(orig.base, clone.base)
1374
... else:
1375
... orig.base == clone.base
1376
...
1377
False
1378
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1379
True
1380
"""
1381
from shutil import copytree
1382
from tempfile import mkdtemp
1383
base = mkdtemp()
1384
os.rmdir(base)
1385
copytree(self.base, base, symlinks=True)
1386
return ScratchBranch(base=base)
1387
1388
def __del__(self):
1389
self.destroy()
1390
1391
def destroy(self):
1392
"""Destroy the test branch, removing the scratch directory."""
1393
from shutil import rmtree
1394
try:
1395
if self.base:
1396
mutter("delete ScratchBranch %s" % self.base)
1397
rmtree(self.base)
1398
except OSError, e:
1399
# Work around for shutil.rmtree failing on Windows when
1400
# readonly files are encountered
1401
mutter("hit exception in destroying ScratchBranch: %s" % e)
1402
for root, dirs, files in os.walk(self.base, topdown=False):
1403
for name in files:
1404
os.chmod(os.path.join(root, name), 0700)
1405
rmtree(self.base)
1406
self._transport = None
1407
815
1408
816
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
817
relax_version_check=DEPRECATED_PARAMETER, _format=None,
818
_control_files=None, a_bzrdir=None, _repository=None):
819
"""Create new branch object at a particular location.
820
821
transport -- A Transport object, defining how to access files.
822
823
init -- If True, create new control files in a previously
824
unversioned directory. If False, the branch must already
825
be versioned.
826
827
relax_version_check -- If true, the usual check for the branch
828
version is not applied. This is intended only for
829
upgrade/recovery type use; it's not guaranteed that
830
all operations will work on old format branches.
831
"""
832
if a_bzrdir is None:
833
self.bzrdir = bzrdir.BzrDir.open(transport.base)
834
else:
835
self.bzrdir = a_bzrdir
836
self._transport = self.bzrdir.transport.clone('..')
837
self._base = self._transport.base
838
self._format = _format
839
if _control_files is None:
840
raise BzrBadParameterMissing('_control_files')
841
self.control_files = _control_files
842
if deprecated_passed(init):
843
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
844
"deprecated as of bzr 0.8. Please use Branch.create().",
845
DeprecationWarning,
846
stacklevel=2)
847
if init:
848
# this is slower than before deprecation, oh well never mind.
849
# -> its deprecated.
850
self._initialize(transport.base)
851
self._check_format(_format)
852
if deprecated_passed(relax_version_check):
853
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
854
"relax_version_check parameter is deprecated as of bzr 0.8. "
855
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
856
"open() method.",
857
DeprecationWarning,
858
stacklevel=2)
859
if (not relax_version_check
860
and not self._format.is_supported()):
861
raise errors.UnsupportedFormatError(
862
'sorry, branch format %r not supported' % fmt,
863
['use a different bzr version',
864
'or remove the .bzr directory'
865
' and "bzr init" again'])
866
if deprecated_passed(transport):
867
warn("BzrBranch.__init__(transport=XXX...): The transport "
868
"parameter is deprecated as of bzr 0.8. "
869
"Please use Branch.open, or bzrdir.open_branch().",
870
DeprecationWarning,
871
stacklevel=2)
872
self.repository = _repository
873
874
def __str__(self):
875
return '%s(%r)' % (self.__class__.__name__, self.base)
876
877
__repr__ = __str__
878
879
def __del__(self):
880
# TODO: It might be best to do this somewhere else,
881
# but it is nice for a Branch object to automatically
882
# cache it's information.
883
# Alternatively, we could have the Transport objects cache requests
884
# See the earlier discussion about how major objects (like Branch)
885
# should never expect their __del__ function to run.
886
# XXX: cache_root seems to be unused, 2006-01-13 mbp
887
if hasattr(self, 'cache_root') and self.cache_root is not None:
888
try:
889
shutil.rmtree(self.cache_root)
890
except:
891
pass
892
self.cache_root = None
893
894
def _get_base(self):
895
return self._base
896
897
base = property(_get_base, doc="The URL for the root of this branch.")
898
899
def _finish_transaction(self):
900
"""Exit the current transaction."""
901
return self.control_files._finish_transaction()
902
903
def get_transaction(self):
904
"""Return the current active transaction.
905
906
If no transaction is active, this returns a passthrough object
907
for which all data is immediately flushed and no caching happens.
908
"""
909
# this is an explicit function so that we can do tricky stuff
910
# when the storage in rev_storage is elsewhere.
911
# we probably need to hook the two 'lock a location' and
912
# 'have a transaction' together more delicately, so that
913
# we can have two locks (branch and storage) and one transaction
914
# ... and finishing the transaction unlocks both, but unlocking
915
# does not. - RBC 20051121
916
return self.control_files.get_transaction()
917
918
def _set_transaction(self, transaction):
919
"""Set a new active transaction."""
920
return self.control_files._set_transaction(transaction)
921
922
def abspath(self, name):
923
"""See Branch.abspath."""
924
return self.control_files._transport.abspath(name)
925
926
def _check_format(self, format):
927
"""Identify the branch format if needed.
928
929
The format is stored as a reference to the format object in
930
self._format for code that needs to check it later.
931
932
The format parameter is either None or the branch format class
933
used to open this branch.
934
935
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
936
"""
937
if format is None:
938
format = BzrBranchFormat.find_format(self.bzrdir)
939
self._format = format
940
mutter("got branch format %s", self._format)
941
942
@needs_read_lock
943
def get_root_id(self):
944
"""See Branch.get_root_id."""
945
tree = self.repository.revision_tree(self.last_revision())
946
return tree.inventory.root.file_id
947
948
def is_locked(self):
949
return self.control_files.is_locked()
950
951
def lock_write(self):
952
# TODO: test for failed two phase locks. This is known broken.
953
self.control_files.lock_write()
954
self.repository.lock_write()
955
956
def lock_read(self):
957
# TODO: test for failed two phase locks. This is known broken.
958
self.control_files.lock_read()
959
self.repository.lock_read()
960
961
def unlock(self):
962
# TODO: test for failed two phase locks. This is known broken.
963
self.repository.unlock()
964
self.control_files.unlock()
965
966
def peek_lock_mode(self):
967
if self.control_files._lock_count == 0:
968
return None
969
else:
970
return self.control_files._lock_mode
971
972
def get_physical_lock_status(self):
973
return self.control_files.get_physical_lock_status()
974
975
@needs_read_lock
976
def print_file(self, file, revision_id):
977
"""See Branch.print_file."""
978
return self.repository.print_file(file, revision_id)
979
980
@needs_write_lock
981
def append_revision(self, *revision_ids):
982
"""See Branch.append_revision."""
983
for revision_id in revision_ids:
984
mutter("add {%s} to revision-history" % revision_id)
985
rev_history = self.revision_history()
986
rev_history.extend(revision_ids)
987
self.set_revision_history(rev_history)
988
989
@needs_write_lock
990
def set_revision_history(self, rev_history):
991
"""See Branch.set_revision_history."""
992
self.control_files.put_utf8(
993
'revision-history', '\n'.join(rev_history))
994
transaction = self.get_transaction()
995
history = transaction.map.find_revision_history()
996
if history is not None:
997
# update the revision history in the identity map.
998
history[:] = list(rev_history)
999
# this call is disabled because revision_history is
1000
# not really an object yet, and the transaction is for objects.
1001
# transaction.register_dirty(history)
1002
else:
1003
transaction.map.add_revision_history(rev_history)
1004
# this call is disabled because revision_history is
1005
# not really an object yet, and the transaction is for objects.
1006
# transaction.register_clean(history)
1007
1008
def get_revision_delta(self, revno):
1009
"""Return the delta for one revision.
1010
1011
The delta is relative to its mainline predecessor, or the
1012
empty tree for revision 1.
1013
"""
1014
assert isinstance(revno, int)
1015
rh = self.revision_history()
1016
if not (1 <= revno <= len(rh)):
1017
raise InvalidRevisionNumber(revno)
1018
1019
# revno is 1-based; list is 0-based
1020
1021
new_tree = self.repository.revision_tree(rh[revno-1])
1022
if revno == 1:
1023
old_tree = EmptyTree()
1024
else:
1025
old_tree = self.repository.revision_tree(rh[revno-2])
1026
return compare_trees(old_tree, new_tree)
1027
1028
@needs_read_lock
1029
def revision_history(self):
1030
"""See Branch.revision_history."""
1031
transaction = self.get_transaction()
1032
history = transaction.map.find_revision_history()
1033
if history is not None:
1034
mutter("cache hit for revision-history in %s", self)
1035
return list(history)
1036
history = [l.rstrip('\r\n') for l in
1037
self.control_files.get_utf8('revision-history').readlines()]
1038
transaction.map.add_revision_history(history)
1039
# this call is disabled because revision_history is
1040
# not really an object yet, and the transaction is for objects.
1041
# transaction.register_clean(history, precious=True)
1042
return list(history)
1043
1044
@needs_write_lock
1045
def update_revisions(self, other, stop_revision=None):
1046
"""See Branch.update_revisions."""
1047
other.lock_read()
1048
try:
1049
if stop_revision is None:
1050
stop_revision = other.last_revision()
1051
if stop_revision is None:
1052
# if there are no commits, we're done.
1053
return
1054
# whats the current last revision, before we fetch [and change it
1055
# possibly]
1056
last_rev = self.last_revision()
1057
# we fetch here regardless of whether we need to so that we pickup
1058
# filled in ghosts.
1059
self.fetch(other, stop_revision)
1060
my_ancestry = self.repository.get_ancestry(last_rev)
1061
if stop_revision in my_ancestry:
1062
# last_revision is a descendant of stop_revision
1063
return
1064
# stop_revision must be a descendant of last_revision
1065
stop_graph = self.repository.get_revision_graph(stop_revision)
1066
if last_rev is not None and last_rev not in stop_graph:
1067
# our previous tip is not merged into stop_revision
1068
raise errors.DivergedBranches(self, other)
1069
# make a new revision history from the graph
1070
current_rev_id = stop_revision
1071
new_history = []
1072
while current_rev_id not in (None, NULL_REVISION):
1073
new_history.append(current_rev_id)
1074
current_rev_id_parents = stop_graph[current_rev_id]
1075
try:
1076
current_rev_id = current_rev_id_parents[0]
1077
except IndexError:
1078
current_rev_id = None
1079
new_history.reverse()
1080
self.set_revision_history(new_history)
1081
finally:
1082
other.unlock()
1083
1084
@deprecated_method(zero_eight)
1085
def pullable_revisions(self, other, stop_revision):
1086
"""Please use bzrlib.missing instead."""
1087
other_revno = other.revision_id_to_revno(stop_revision)
1088
try:
1089
return self.missing_revisions(other, other_revno)
1090
except DivergedBranches, e:
1091
try:
1092
pullable_revs = get_intervening_revisions(self.last_revision(),
1093
stop_revision,
1094
self.repository)
1095
assert self.last_revision() not in pullable_revs
1096
return pullable_revs
1097
except bzrlib.errors.NotAncestor:
1098
if is_ancestor(self.last_revision(), stop_revision, self):
1099
return []
1100
else:
1101
raise e
1102
1103
def basis_tree(self):
1104
"""See Branch.basis_tree."""
1105
return self.repository.revision_tree(self.last_revision())
1106
1107
@deprecated_method(zero_eight)
1108
def working_tree(self):
1109
"""Create a Working tree object for this branch."""
1110
from bzrlib.workingtree import WorkingTree
1111
from bzrlib.transport.local import LocalTransport
1112
if (self.base.find('://') != -1 or
1113
not isinstance(self._transport, LocalTransport)):
1114
raise NoWorkingTree(self.base)
1115
return self.bzrdir.open_workingtree()
1116
1117
@needs_write_lock
1118
def pull(self, source, overwrite=False, stop_revision=None):
1119
"""See Branch.pull."""
1120
source.lock_read()
1121
try:
1122
old_count = len(self.revision_history())
1123
try:
1124
self.update_revisions(source,stop_revision)
1125
except DivergedBranches:
1126
if not overwrite:
1127
raise
1128
if overwrite:
1129
self.set_revision_history(source.revision_history())
1130
new_count = len(self.revision_history())
1131
return new_count - old_count
1132
finally:
1133
source.unlock()
1134
1135
def get_parent(self):
1136
"""See Branch.get_parent."""
1137
import errno
1138
_locs = ['parent', 'pull', 'x-pull']
1139
for l in _locs:
1140
try:
1141
return self.control_files.get_utf8(l).read().strip('\n')
1142
except NoSuchFile:
1143
pass
1144
return None
1145
1146
def get_push_location(self):
1147
"""See Branch.get_push_location."""
1148
config = bzrlib.config.BranchConfig(self)
1149
push_loc = config.get_user_option('push_location')
1150
return push_loc
1151
1152
def set_push_location(self, location):
1153
"""See Branch.set_push_location."""
1154
config = bzrlib.config.LocationConfig(self.base)
1155
config.set_user_option('push_location', location)
1156
1157
@needs_write_lock
1158
def set_parent(self, url):
1159
"""See Branch.set_parent."""
1160
# TODO: Maybe delete old location files?
1161
# URLs should never be unicode, even on the local fs,
1162
# FIXUP this and get_parent in a future branch format bump:
1163
# read and rewrite the file, and have the new format code read
1164
# using .get not .get_utf8. RBC 20060125
1165
if url is None:
1166
self.control_files._transport.delete('parent')
1167
else:
1168
self.control_files.put_utf8('parent', url + '\n')
1169
1170
def tree_config(self):
1171
return TreeConfig(self)
1172
1173
1174
class BzrBranch5(BzrBranch):
1175
"""A format 5 branch. This supports new features over plan branches.
1176
1177
It has support for a master_branch which is the data for bound branches.
1178
"""
1179
1180
def __init__(self,
1181
_format,
1182
_control_files,
1183
a_bzrdir,
1184
_repository):
1185
super(BzrBranch5, self).__init__(_format=_format,
1186
_control_files=_control_files,
1187
a_bzrdir=a_bzrdir,
1188
_repository=_repository)
1189
1190
@needs_write_lock
1191
def pull(self, source, overwrite=False, stop_revision=None):
1192
"""Updates branch.pull to be bound branch aware."""
1193
bound_location = self.get_bound_location()
1194
if source.base != bound_location:
1195
# not pulling from master, so we need to update master.
1196
master_branch = self.get_master_branch()
1197
if master_branch:
1198
master_branch.pull(source)
1199
source = master_branch
1200
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1201
1202
def get_bound_location(self):
1203
try:
1204
return self.control_files.get_utf8('bound').read()[:-1]
1205
except errors.NoSuchFile:
1206
return None
1207
1208
@needs_read_lock
1209
def get_master_branch(self):
1210
"""Return the branch we are bound to.
1211
1212
:return: Either a Branch, or None
1213
1214
This could memoise the branch, but if thats done
1215
it must be revalidated on each new lock.
1216
So for now we just dont memoise it.
1217
# RBC 20060304 review this decision.
1218
"""
1219
bound_loc = self.get_bound_location()
1220
if not bound_loc:
1221
return None
1222
try:
1223
return Branch.open(bound_loc)
1224
except (errors.NotBranchError, errors.ConnectionError), e:
1225
raise errors.BoundBranchConnectionFailure(
1226
self, bound_loc, e)
1227
1228
@needs_write_lock
1229
def set_bound_location(self, location):
1230
"""Set the target where this branch is bound to.
1231
1232
:param location: URL to the target branch
1233
"""
1234
if location:
1235
self.control_files.put_utf8('bound', location+'\n')
1236
else:
1237
try:
1238
self.control_files._transport.delete('bound')
1239
except NoSuchFile:
1240
return False
1409
1410
######################################################################
1411
# predicates
1412
1413
1414
def is_control_file(filename):
1415
## FIXME: better check
1416
filename = os.path.normpath(filename)
1417
while filename != '':
1418
head, tail = os.path.split(filename)
1419
## mutter('check %r for control file' % ((head, tail), ))
1420
if tail == bzrlib.BZRDIR:
1241
1421
return True
1242
1243
@needs_write_lock
1244
def bind(self, other):
1245
"""Bind the local branch the other branch.
1246
1247
:param other: The branch to bind to
1248
:type other: Branch
1249
"""
1250
# TODO: jam 20051230 Consider checking if the target is bound
1251
# It is debatable whether you should be able to bind to
1252
# a branch which is itself bound.
1253
# Committing is obviously forbidden,
1254
# but binding itself may not be.
1255
# Since we *have* to check at commit time, we don't
1256
# *need* to check here
1257
self.pull(other)
1258
1259
# we are now equal to or a suffix of other.
1260
1261
# Since we have 'pulled' from the remote location,
1262
# now we should try to pull in the opposite direction
1263
# in case the local tree has more revisions than the
1264
# remote one.
1265
# There may be a different check you could do here
1266
# rather than actually trying to install revisions remotely.
1267
# TODO: capture an exception which indicates the remote branch
1268
# is not writeable.
1269
# If it is up-to-date, this probably should not be a failure
1270
1271
# lock other for write so the revision-history syncing cannot race
1272
other.lock_write()
1273
try:
1274
other.pull(self)
1275
# if this does not error, other now has the same last rev we do
1276
# it can only error if the pull from other was concurrent with
1277
# a commit to other from someone else.
1278
1279
# until we ditch revision-history, we need to sync them up:
1280
self.set_revision_history(other.revision_history())
1281
# now other and self are up to date with each other and have the
1282
# same revision-history.
1283
finally:
1284
other.unlock()
1285
1286
self.set_bound_location(other.base)
1287
1288
@needs_write_lock
1289
def unbind(self):
1290
"""If bound, unbind"""
1291
return self.set_bound_location(None)
1292
1293
@needs_write_lock
1294
def update(self):
1295
"""Synchronise this branch with the master branch if any.
1296
1297
:return: None or the last_revision that was pivoted out during the
1298
update.
1299
"""
1300
master = self.get_master_branch()
1301
if master is not None:
1302
old_tip = self.last_revision()
1303
self.pull(master, overwrite=True)
1304
if old_tip in self.repository.get_ancestry(self.last_revision()):
1305
return None
1306
return old_tip
1307
return None
1308
1309
1310
class BranchTestProviderAdapter(object):
1311
"""A tool to generate a suite testing multiple branch formats at once.
1312
1313
This is done by copying the test once for each transport and injecting
1314
the transport_server, transport_readonly_server, and branch_format
1315
classes into each copy. Each copy is also given a new id() to make it
1316
easy to identify.
1317
"""
1318
1319
def __init__(self, transport_server, transport_readonly_server, formats):
1320
self._transport_server = transport_server
1321
self._transport_readonly_server = transport_readonly_server
1322
self._formats = formats
1323
1324
def adapt(self, test):
1325
result = TestSuite()
1326
for branch_format, bzrdir_format in self._formats:
1327
new_test = deepcopy(test)
1328
new_test.transport_server = self._transport_server
1329
new_test.transport_readonly_server = self._transport_readonly_server
1330
new_test.bzrdir_format = bzrdir_format
1331
new_test.branch_format = branch_format
1332
def make_new_test_id():
1333
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1334
return lambda: new_id
1335
new_test.id = make_new_test_id()
1336
result.addTest(new_test)
1337
return result
1338
1339
1340
######################################################################
1341
# predicates
1342
1343
1344
@deprecated_function(zero_eight)
1345
def ScratchBranch(*args, **kwargs):
1346
"""See bzrlib.bzrdir.ScratchDir."""
1347
d = ScratchDir(*args, **kwargs)
1348
return d.open_branch()
1349
1350
1351
@deprecated_function(zero_eight)
1352
def is_control_file(*args, **kwargs):
1353
"""See bzrlib.workingtree.is_control_file."""
1354
return bzrlib.workingtree.is_control_file(*args, **kwargs)
1422
if filename == head:
1423
break
1424
filename = head
1425
return False
1426
1427
1428
1429
def gen_file_id(name):
1430
"""Return new file id.
1431
1432
This should probably generate proper UUIDs, but for the moment we
1433
cope with just randomness because running uuidgen every time is
1434
slow."""
1435
import re
1436
from binascii import hexlify
1437
from time import time
1438
1439
# get last component
1440
idx = name.rfind('/')
1441
if idx != -1:
1442
name = name[idx+1 : ]
1443
idx = name.rfind('\\')
1444
if idx != -1:
1445
name = name[idx+1 : ]
1446
1447
# make it not a hidden file
1448
name = name.lstrip('.')
1449
1450
# remove any wierd characters; we don't escape them but rather
1451
# just pull them out
1452
name = re.sub(r'[^\w.]', '', name)
1453
1454
s = hexlify(rand_bytes(8))
1455
return '-'.join((name, compact_date(time()), s))
1456
1457
1458
def gen_root_id():
1459
"""Return a new tree-root file id."""
1460
return gen_file_id('TREE_ROOT')
1461
1462
Loggerhead is a web-based interface for Breezy
Version: 2.0.1