« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 893
- compare with another revision
- download diff
- download tarball
- view history from revision 893
- Committer: Martin Pool
- Date: 2005-07-11 04:53:07 UTC
- Revision ID: mbp@sourcefrog.net-20050711045307-2b38378d043dc25c
- Refactor weave calculation of inclusions
- files added:
- bzrlib/changeset.py
- patches
- plugins/changeset
- files removed:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/store
- 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
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- contrib/emacs
- tools/doc_generate
- files renamed:
- tools/doc_generate/autodoc_man.py => bzr-man.py
- contrib/newinventory.py => bzrlib/newinventory.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/test_hashcache.py => bzrlib/selftest/testhashcache.py
- bzrlib/tests/test_merge3.py => bzrlib/selftest/testmerge3.py
- bzrlib/tests/blackbox/test_versioning.py => bzrlib/selftest/versioning.py
- bzrlib/tests/test_whitebox.py => bzrlib/selftest/whitebox.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/xml_serializer.py => bzrlib/xml.py
- bzrlib/util/effbot/ => effbot/
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/plugins/ => plugins/
- bzrlib/tests/test_weave.py => tools/testweave.py
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
- bzr *
- 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
20
import errno
21
import os
22
import shutil
23
import sys
24
from unittest import TestSuite
25
from warnings import warn
18
import sys, os
26
19
27
20
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
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
37
UnlistableStore,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
39
NoWorkingTree)
40
import bzrlib.inventory as inventory
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
21
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
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
64
import bzrlib.ui
65
import bzrlib.xml5
66
67
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
72
73
# TODO: Maybe include checks for common corruption of newlines, etc?
74
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# 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
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
25
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
## TODO: Maybe include checks for common corruption of newlines, etc?
28
29
30
31
def find_branch(f, **args):
32
if f and (f.startswith('http://') or f.startswith('https://')):
33
import remotebranch
34
return remotebranch.RemoteBranch(f, **args)
35
else:
36
return Branch(f, **args)
37
38
39
def find_cached_branch(f, cache_root, **args):
40
from remotebranch import RemoteBranch
41
br = find_branch(f, **args)
42
def cacheify(br, store_name):
43
from meta_store import CachedStore
44
cache_path = os.path.join(cache_root, store_name)
45
os.mkdir(cache_path)
46
new_store = CachedStore(getattr(br, store_name), cache_path)
47
setattr(br, store_name, new_store)
48
49
if isinstance(br, RemoteBranch):
50
cacheify(br, 'inventory_store')
51
cacheify(br, 'text_store')
52
cacheify(br, 'revision_store')
53
return br
54
55
56
def _relpath(base, path):
57
"""Return path relative to base, or raise exception.
58
59
The path may be either an absolute path or a path relative to the
60
current working directory.
61
62
Lifted out of Branch.relpath for ease of testing.
63
64
os.path.commonprefix (python2.4) has a bad bug that it works just
65
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
66
avoids that problem."""
67
rp = os.path.abspath(path)
68
69
s = []
70
head = rp
71
while len(head) >= len(base):
72
if head == base:
73
break
74
head, tail = os.path.split(head)
75
if tail:
76
s.insert(0, tail)
77
else:
78
from errors import NotBranchError
79
raise NotBranchError("path %r is not within branch %r" % (rp, base))
80
81
return os.sep.join(s)
82
83
84
def find_branch_root(f=None):
85
"""Find the branch root enclosing f, or pwd.
86
87
f may be a filename or a URL.
88
89
It is not necessary that f exists.
90
91
Basically we keep looking up until we find the control directory or
92
run into the root."""
93
if f == None:
94
f = os.getcwd()
95
elif hasattr(os.path, 'realpath'):
96
f = os.path.realpath(f)
97
else:
98
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
101
102
103
orig_f = f
104
105
while True:
106
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
107
return f
108
head, tail = os.path.split(f)
109
if head == f:
110
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
112
f = head
113
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
Exception.__init__(self, "These branches have diverged.")
119
120
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
123
self.branch = branch
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
80
127
81
128
82
129
######################################################################
86
133
"""Branch holding a history of revisions.
87
134
88
135
base
89
Base directory/url of the branch.
136
Base directory of the branch.
137
138
_lock_mode
139
None, or 'r' or 'w'
140
141
_lock_count
142
If _lock_mode is true, a positive count of the number of times the
143
lock has been taken.
144
145
_lock
146
Lock object from bzrlib.lock.
90
147
"""
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
93
148
base = None
94
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
97
98
@staticmethod
99
@deprecated_method(zero_eight)
100
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
103
104
@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)
113
114
@staticmethod
115
def open_containing(url):
116
"""Open an existing branch which contains url.
117
118
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
"""
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
128
129
@staticmethod
130
@deprecated_function(zero_eight)
131
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
138
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
142
"""
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
146
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')
149
_lock_mode = None
150
_lock_count = None
151
_lock = None
152
153
def __init__(self, base, init=False, find_root=True):
154
"""Create new branch object at a particular location.
155
156
base -- Base directory for the branch.
157
158
init -- If True, create new control files in a previously
159
unversioned directory. If False, the branch must already
160
be versioned.
161
162
find_root -- If true and init is false, find the root of the
163
existing branch containing base.
164
165
In the test suite, creation of new trees is tested using the
166
`ScratchBranch` class.
167
"""
168
from bzrlib.store import ImmutableStore
169
if init:
170
self.base = os.path.realpath(base)
171
self._make_control()
172
elif find_root:
173
self.base = find_branch_root(base)
174
else:
175
self.base = os.path.realpath(base)
176
if not isdir(self.controlfilename('.')):
177
from errors import NotBranchError
178
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
179
['use "bzr init" to initialize a new working tree',
180
'current bzr can only operate from top-of-tree'])
181
self._check_format()
182
183
self.text_store = ImmutableStore(self.controlfilename('text-store'))
184
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
185
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
186
187
188
def __str__(self):
189
return '%s(%r)' % (self.__class__.__name__, self.base)
190
191
192
__repr__ = __str__
193
194
195
def __del__(self):
196
if self._lock_mode or self._lock:
197
from warnings import warn
198
warn("branch %r was not explicitly unlocked" % self)
199
self._lock.unlock()
200
201
160
202
161
203
def lock_write(self):
162
raise NotImplementedError('lock_write is abstract')
204
if self._lock_mode:
205
if self._lock_mode != 'w':
206
from errors import LockError
207
raise LockError("can't upgrade to a write lock from %r" %
208
self._lock_mode)
209
self._lock_count += 1
210
else:
211
from bzrlib.lock import WriteLock
212
213
self._lock = WriteLock(self.controlfilename('branch-lock'))
214
self._lock_mode = 'w'
215
self._lock_count = 1
216
217
163
218
164
219
def lock_read(self):
165
raise NotImplementedError('lock_read is abstract')
166
220
if self._lock_mode:
221
assert self._lock_mode in ('r', 'w'), \
222
"invalid lock mode %r" % self._lock_mode
223
self._lock_count += 1
224
else:
225
from bzrlib.lock import ReadLock
226
227
self._lock = ReadLock(self.controlfilename('branch-lock'))
228
self._lock_mode = 'r'
229
self._lock_count = 1
230
231
232
167
233
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')
234
if not self._lock_mode:
235
from errors import LockError
236
raise LockError('branch %r is not locked' % (self))
237
238
if self._lock_count > 1:
239
self._lock_count -= 1
240
else:
241
self._lock.unlock()
242
self._lock = None
243
self._lock_mode = self._lock_count = None
244
176
245
177
246
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
210
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]
220
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.
241
242
:return: Either a Branch, or None
243
"""
244
return None
245
246
def get_root_id(self):
247
"""Return the id of this branches root"""
248
raise NotImplementedError('get_root_id is abstract')
249
250
def print_file(self, file, revision_id):
247
"""Return absolute filename for something in the branch"""
248
return os.path.join(self.base, name)
249
250
251
def relpath(self, path):
252
"""Return path relative to this branch of something inside it.
253
254
Raises an error if path is not in this branch."""
255
return _relpath(self.base, path)
256
257
258
def controlfilename(self, file_or_path):
259
"""Return location relative to branch."""
260
if isinstance(file_or_path, basestring):
261
file_or_path = [file_or_path]
262
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
263
264
265
def controlfile(self, file_or_path, mode='r'):
266
"""Open a control file for this branch.
267
268
There are two classes of file in the control directory: text
269
and binary. binary files are untranslated byte streams. Text
270
control files are stored with Unix newlines and in UTF-8, even
271
if the platform or locale defaults are different.
272
273
Controlfiles should almost never be opened in write mode but
274
rather should be atomically copied and replaced using atomicfile.
275
"""
276
277
fn = self.controlfilename(file_or_path)
278
279
if mode == 'rb' or mode == 'wb':
280
return file(fn, mode)
281
elif mode == 'r' or mode == 'w':
282
# open in binary mode anyhow so there's no newline translation;
283
# codecs uses line buffering by default; don't want that.
284
import codecs
285
return codecs.open(fn, mode + 'b', 'utf-8',
286
buffering=60000)
287
else:
288
raise BzrError("invalid controlfile mode %r" % mode)
289
290
291
292
def _make_control(self):
293
from bzrlib.inventory import Inventory
294
from bzrlib.xml import pack_xml
295
296
os.mkdir(self.controlfilename([]))
297
self.controlfile('README', 'w').write(
298
"This is a Bazaar-NG control directory.\n"
299
"Do not change any files in this directory.\n")
300
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
301
for d in ('text-store', 'inventory-store', 'revision-store'):
302
os.mkdir(self.controlfilename(d))
303
for f in ('revision-history', 'merged-patches',
304
'pending-merged-patches', 'branch-name',
305
'branch-lock',
306
'pending-merges'):
307
self.controlfile(f, 'w').write('')
308
mutter('created control directory in ' + self.base)
309
310
pack_xml(Inventory(), self.controlfile('inventory','w'))
311
312
313
def _check_format(self):
314
"""Check this branch format is supported.
315
316
The current tool only supports the current unstable format.
317
318
In the future, we might need different in-memory Branch
319
classes to support downlevel branches. But not yet.
320
"""
321
# This ignores newlines so that we can open branches created
322
# on Windows from Linux and so on. I think it might be better
323
# to always make all internal files in unix format.
324
fmt = self.controlfile('branch-format', 'r').read()
325
fmt.replace('\r\n', '')
326
if fmt != BZR_BRANCH_FORMAT:
327
raise BzrError('sorry, branch format %r not supported' % fmt,
328
['use a different bzr version',
329
'or remove the .bzr directory and "bzr init" again'])
330
331
332
333
def read_working_inventory(self):
334
"""Read the working inventory."""
335
from bzrlib.inventory import Inventory
336
from bzrlib.xml import unpack_xml
337
from time import time
338
before = time()
339
self.lock_read()
340
try:
341
# ElementTree does its own conversion from UTF-8, so open in
342
# binary.
343
inv = unpack_xml(Inventory,
344
self.controlfile('inventory', 'rb'))
345
mutter("loaded inventory of %d items in %f"
346
% (len(inv), time() - before))
347
return inv
348
finally:
349
self.unlock()
350
351
352
def _write_inventory(self, inv):
353
"""Update the working inventory.
354
355
That is to say, the inventory describing changes underway, that
356
will be committed to the next revision.
357
"""
358
from bzrlib.atomicfile import AtomicFile
359
from bzrlib.xml import pack_xml
360
361
self.lock_write()
362
try:
363
f = AtomicFile(self.controlfilename('inventory'), 'wb')
364
try:
365
pack_xml(inv, f)
366
f.commit()
367
finally:
368
f.close()
369
finally:
370
self.unlock()
371
372
mutter('wrote working inventory')
373
374
375
inventory = property(read_working_inventory, _write_inventory, None,
376
"""Inventory for the working copy.""")
377
378
379
def add(self, files, verbose=False, ids=None):
380
"""Make files versioned.
381
382
Note that the command line normally calls smart_add instead.
383
384
This puts the files in the Added state, so that they will be
385
recorded by the next commit.
386
387
files
388
List of paths to add, relative to the base of the tree.
389
390
ids
391
If set, use these instead of automatically generated ids.
392
Must be the same length as the list of files, but may
393
contain None for ids that are to be autogenerated.
394
395
TODO: Perhaps have an option to add the ids even if the files do
396
not (yet) exist.
397
398
TODO: Perhaps return the ids of the files? But then again it
399
is easy to retrieve them if they're needed.
400
401
TODO: Adding a directory should optionally recurse down and
402
add all non-ignored children. Perhaps do that in a
403
higher-level method.
404
"""
405
from bzrlib.textui import show_status
406
# TODO: Re-adding a file that is removed in the working copy
407
# should probably put it back with the previous ID.
408
if isinstance(files, basestring):
409
assert(ids is None or isinstance(ids, basestring))
410
files = [files]
411
if ids is not None:
412
ids = [ids]
413
414
if ids is None:
415
ids = [None] * len(files)
416
else:
417
assert(len(ids) == len(files))
418
419
self.lock_write()
420
try:
421
inv = self.read_working_inventory()
422
for f,file_id in zip(files, ids):
423
if is_control_file(f):
424
raise BzrError("cannot add control file %s" % quotefn(f))
425
426
fp = splitpath(f)
427
428
if len(fp) == 0:
429
raise BzrError("cannot add top-level %r" % f)
430
431
fullpath = os.path.normpath(self.abspath(f))
432
433
try:
434
kind = file_kind(fullpath)
435
except OSError:
436
# maybe something better?
437
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
438
439
if kind != 'file' and kind != 'directory':
440
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
441
442
if file_id is None:
443
file_id = gen_file_id(f)
444
inv.add_path(f, kind=kind, file_id=file_id)
445
446
if verbose:
447
print 'added', quotefn(f)
448
449
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
450
451
self._write_inventory(inv)
452
finally:
453
self.unlock()
454
455
456
def print_file(self, file, revno):
251
457
"""Print `file` to stdout."""
252
raise NotImplementedError('print_file is abstract')
253
254
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')
458
self.lock_read()
459
try:
460
tree = self.revision_tree(self.lookup_revision(revno))
461
# use inventory as it was in that revision
462
file_id = tree.inventory.path2id(file)
463
if not file_id:
464
raise BzrError("%r is not present in revision %d" % (file, revno))
465
tree.print_file(file_id)
466
finally:
467
self.unlock()
468
469
470
def remove(self, files, verbose=False):
471
"""Mark nominated files for removal from the inventory.
472
473
This does not remove their text. This does not run on
474
475
TODO: Refuse to remove modified files unless --force is given?
476
477
TODO: Do something useful with directories.
478
479
TODO: Should this remove the text or not? Tough call; not
480
removing may be useful and the user can just use use rm, and
481
is the opposite of add. Removing it is consistent with most
482
other tools. Maybe an option.
483
"""
484
from bzrlib.textui import show_status
485
## TODO: Normalize names
486
## TODO: Remove nested loops; better scalability
487
if isinstance(files, basestring):
488
files = [files]
489
490
self.lock_write()
491
492
try:
493
tree = self.working_tree()
494
inv = tree.inventory
495
496
# do this before any modifications
497
for f in files:
498
fid = inv.path2id(f)
499
if not fid:
500
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
501
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
502
if verbose:
503
# having remove it, it must be either ignored or unknown
504
if tree.is_ignored(f):
505
new_status = 'I'
506
else:
507
new_status = '?'
508
show_status(new_status, inv[fid].kind, quotefn(f))
509
del inv[fid]
510
511
self._write_inventory(inv)
512
finally:
513
self.unlock()
514
515
516
# FIXME: this doesn't need to be a branch method
517
def set_inventory(self, new_inventory_list):
518
from bzrlib.inventory import Inventory, InventoryEntry
519
inv = Inventory()
520
for path, file_id, parent, kind in new_inventory_list:
521
name = os.path.basename(path)
522
if name == "":
523
continue
524
inv.add(InventoryEntry(file_id, name, kind, parent))
525
self._write_inventory(inv)
526
527
528
def unknowns(self):
529
"""Return all unknown files.
530
531
These are files in the working directory that are not versioned or
532
control files or ignored.
533
534
>>> b = ScratchBranch(files=['foo', 'foo~'])
535
>>> list(b.unknowns())
536
['foo']
537
>>> b.add('foo')
538
>>> list(b.unknowns())
539
[]
540
>>> b.remove('foo')
541
>>> list(b.unknowns())
542
['foo']
543
"""
544
return self.working_tree().unknowns()
545
546
547
def append_revision(self, revision_id):
548
from bzrlib.atomicfile import AtomicFile
549
550
mutter("add {%s} to revision-history" % revision_id)
551
rev_history = self.revision_history() + [revision_id]
552
553
f = AtomicFile(self.controlfilename('revision-history'))
554
try:
555
for rev_id in rev_history:
556
print >>f, rev_id
557
f.commit()
558
finally:
559
f.close()
560
561
562
def get_revision(self, revision_id):
563
"""Return the Revision object for a named revision"""
564
from bzrlib.revision import Revision
565
from bzrlib.xml import unpack_xml
566
567
self.lock_read()
568
try:
569
if not revision_id or not isinstance(revision_id, basestring):
570
raise ValueError('invalid revision-id: %r' % revision_id)
571
r = unpack_xml(Revision, self.revision_store[revision_id])
572
finally:
573
self.unlock()
574
575
assert r.revision_id == revision_id
576
return r
577
578
579
def get_revision_sha1(self, revision_id):
580
"""Hash the stored value of a revision, and return it."""
581
# In the future, revision entries will be signed. At that
582
# point, it is probably best *not* to include the signature
583
# in the revision hash. Because that lets you re-sign
584
# the revision, (add signatures/remove signatures) and still
585
# have all hash pointers stay consistent.
586
# But for now, just hash the contents.
587
return sha_file(self.revision_store[revision_id])
588
589
590
def get_inventory(self, inventory_id):
591
"""Get Inventory object by hash.
592
593
TODO: Perhaps for this and similar methods, take a revision
594
parameter which can be either an integer revno or a
595
string hash."""
596
from bzrlib.inventory import Inventory
597
from bzrlib.xml import unpack_xml
598
599
return unpack_xml(Inventory, self.inventory_store[inventory_id])
600
601
602
def get_inventory_sha1(self, inventory_id):
603
"""Return the sha1 hash of the inventory entry
604
"""
605
return sha_file(self.inventory_store[inventory_id])
606
607
608
def get_revision_inventory(self, revision_id):
609
"""Return inventory of a past revision."""
610
# bzr 0.0.6 imposes the constraint that the inventory_id
611
# must be the same as its revision, so this is trivial.
612
if revision_id == None:
613
from bzrlib.inventory import Inventory
614
return Inventory()
615
else:
616
return self.get_inventory(revision_id)
617
259
618
260
619
def revision_history(self):
261
"""Return sequence of revision hashes on to this branch."""
262
raise NotImplementedError('revision_history is abstract')
620
"""Return sequence of revision hashes on to this branch.
621
622
>>> ScratchBranch().revision_history()
623
[]
624
"""
625
self.lock_read()
626
try:
627
return [l.rstrip('\r\n') for l in
628
self.controlfile('revision-history', 'r').readlines()]
629
finally:
630
self.unlock()
631
632
633
def common_ancestor(self, other, self_revno=None, other_revno=None):
634
"""
635
>>> import commit
636
>>> sb = ScratchBranch(files=['foo', 'foo~'])
637
>>> sb.common_ancestor(sb) == (None, None)
638
True
639
>>> commit.commit(sb, "Committing first revision", verbose=False)
640
>>> sb.common_ancestor(sb)[0]
641
1
642
>>> clone = sb.clone()
643
>>> commit.commit(sb, "Committing second revision", verbose=False)
644
>>> sb.common_ancestor(sb)[0]
645
2
646
>>> sb.common_ancestor(clone)[0]
647
1
648
>>> commit.commit(clone, "Committing divergent second revision",
649
... verbose=False)
650
>>> sb.common_ancestor(clone)[0]
651
1
652
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
653
True
654
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
655
True
656
>>> clone2 = sb.clone()
657
>>> sb.common_ancestor(clone2)[0]
658
2
659
>>> sb.common_ancestor(clone2, self_revno=1)[0]
660
1
661
>>> sb.common_ancestor(clone2, other_revno=1)[0]
662
1
663
"""
664
my_history = self.revision_history()
665
other_history = other.revision_history()
666
if self_revno is None:
667
self_revno = len(my_history)
668
if other_revno is None:
669
other_revno = len(other_history)
670
indices = range(min((self_revno, other_revno)))
671
indices.reverse()
672
for r in indices:
673
if my_history[r] == other_history[r]:
674
return r+1, my_history[r]
675
return None, None
676
677
def enum_history(self, direction):
678
"""Return (revno, revision_id) for history of branch.
679
680
direction
681
'forward' is from earliest to latest
682
'reverse' is from latest to earliest
683
"""
684
rh = self.revision_history()
685
if direction == 'forward':
686
i = 1
687
for rid in rh:
688
yield i, rid
689
i += 1
690
elif direction == 'reverse':
691
i = len(rh)
692
while i > 0:
693
yield i, rh[i-1]
694
i -= 1
695
else:
696
raise ValueError('invalid history direction', direction)
697
263
698
264
699
def revno(self):
265
700
"""Return current revision number for this branch.
269
704
"""
270
705
return len(self.revision_history())
271
706
272
def unbind(self):
273
"""Older format branches cannot bind or unbind."""
274
raise errors.UpgradeRequired(self.base)
275
707
276
def last_revision(self):
277
"""Return last patch hash, or None if no history."""
708
def last_patch(self):
709
"""Return last patch hash, or None if no history.
710
"""
278
711
ph = self.revision_history()
279
712
if ph:
280
713
return ph[-1]
281
714
else:
282
715
return None
283
716
717
284
718
def missing_revisions(self, other, stop_revision=None):
285
"""Return a list of new revisions that would perfectly fit.
286
719
"""
287
720
If self and other have not diverged, return a list of the revisions
288
721
present in other, but missing from self.
289
722
290
>>> from bzrlib.workingtree import WorkingTree
723
>>> from bzrlib.commit import commit
291
724
>>> 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()
725
>>> br1 = ScratchBranch()
726
>>> br2 = ScratchBranch()
298
727
>>> br1.missing_revisions(br2)
299
728
[]
300
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
729
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
301
730
>>> br1.missing_revisions(br2)
302
731
[u'REVISION-ID-1']
303
732
>>> br2.missing_revisions(br1)
304
733
[]
305
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
734
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
306
735
>>> br1.missing_revisions(br2)
307
736
[]
308
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
737
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
309
738
>>> br1.missing_revisions(br2)
310
739
[u'REVISION-ID-2A']
311
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
740
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
312
741
>>> br1.missing_revisions(br2)
313
742
Traceback (most recent call last):
314
DivergedBranches: These branches have diverged. Try merge.
743
DivergedBranches: These branches have diverged.
315
744
"""
316
745
self_history = self.revision_history()
317
746
self_len = len(self_history)
324
753
325
754
if stop_revision is None:
326
755
stop_revision = other_len
327
else:
328
assert isinstance(stop_revision, int)
329
if stop_revision > other_len:
330
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
756
elif stop_revision > other_len:
757
raise NoSuchRevision(self, stop_revision)
758
331
759
return other_history[self_len:stop_revision]
332
760
761
333
762
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
763
"""Pull in all new revisions from other branch.
764
765
>>> from bzrlib.commit import commit
766
>>> bzrlib.trace.silent = True
767
>>> br1 = ScratchBranch(files=['foo', 'bar'])
768
>>> br1.add('foo')
769
>>> br1.add('bar')
770
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
771
>>> br2 = ScratchBranch()
772
>>> br2.update_revisions(br1)
773
Added 2 texts.
774
Added 1 inventories.
775
Added 1 revisions.
776
>>> br2.revision_history()
777
[u'REVISION-ID-1']
778
>>> br2.update_revisions(br1)
779
Added 0 texts.
780
Added 0 inventories.
781
Added 0 revisions.
782
>>> br1.text_store.total_size() == br2.text_store.total_size()
783
True
339
784
"""
340
raise NotImplementedError('update_revisions is abstract')
341
342
def revision_id_to_revno(self, revision_id):
343
"""Given a revision id, return its revno"""
344
if revision_id is None:
345
return 0
346
history = self.revision_history()
785
from bzrlib.progress import ProgressBar
347
786
try:
348
return history.index(revision_id) + 1
349
except ValueError:
350
raise bzrlib.errors.NoSuchRevision(self, revision_id)
351
352
def get_rev_id(self, revno, history=None):
353
"""Find the revision id of the specified revno."""
787
set
788
except NameError:
789
from sets import Set as set
790
791
pb = ProgressBar()
792
793
pb.update('comparing histories')
794
revision_ids = self.missing_revisions(other, stop_revision)
795
796
if hasattr(other.revision_store, "prefetch"):
797
other.revision_store.prefetch(revision_ids)
798
if hasattr(other.inventory_store, "prefetch"):
799
inventory_ids = [other.get_revision(r).inventory_id
800
for r in revision_ids]
801
other.inventory_store.prefetch(inventory_ids)
802
803
revisions = []
804
needed_texts = set()
805
i = 0
806
for rev_id in revision_ids:
807
i += 1
808
pb.update('fetching revision', i, len(revision_ids))
809
rev = other.get_revision(rev_id)
810
revisions.append(rev)
811
inv = other.get_inventory(str(rev.inventory_id))
812
for key, entry in inv.iter_entries():
813
if entry.text_id is None:
814
continue
815
if entry.text_id not in self.text_store:
816
needed_texts.add(entry.text_id)
817
818
pb.clear()
819
820
count = self.text_store.copy_multi(other.text_store, needed_texts)
821
print "Added %d texts." % count
822
inventory_ids = [ f.inventory_id for f in revisions ]
823
count = self.inventory_store.copy_multi(other.inventory_store,
824
inventory_ids)
825
print "Added %d inventories." % count
826
revision_ids = [ f.revision_id for f in revisions]
827
count = self.revision_store.copy_multi(other.revision_store,
828
revision_ids)
829
for revision_id in revision_ids:
830
self.append_revision(revision_id)
831
print "Added %d revisions." % count
832
833
834
def commit(self, *args, **kw):
835
from bzrlib.commit import commit
836
commit(self, *args, **kw)
837
838
839
def lookup_revision(self, revno):
840
"""Return revision hash for revision number."""
354
841
if revno == 0:
355
842
return None
356
if history is None:
357
history = self.revision_history()
358
elif revno <= 0 or revno > len(history):
359
raise bzrlib.errors.NoSuchRevision(self, revno)
360
return history[revno - 1]
361
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
843
844
try:
845
# list is 0-based; revisions are 1-based
846
return self.revision_history()[revno-1]
847
except IndexError:
848
raise BzrError("no such revision %s" % revno)
849
850
851
def revision_tree(self, revision_id):
852
"""Return Tree for a revision on this branch.
853
854
`revision_id` may be None for the null revision, in which case
855
an `EmptyTree` is returned."""
856
from bzrlib.tree import EmptyTree, RevisionTree
857
# TODO: refactor this to use an existing revision object
858
# so we don't need to read it in twice.
859
if revision_id == None:
860
return EmptyTree()
861
else:
862
inv = self.get_revision_inventory(revision_id)
863
return RevisionTree(self.text_store, inv)
864
865
866
def working_tree(self):
867
"""Return a `Tree` for the working copy."""
868
from workingtree import WorkingTree
869
return WorkingTree(self.base, self.read_working_inventory())
870
364
871
365
872
def basis_tree(self):
366
873
"""Return `Tree` object for last revision.
367
874
368
875
If there are no revisions yet, return an `EmptyTree`.
369
876
"""
370
return self.repository.revision_tree(self.last_revision())
877
from bzrlib.tree import EmptyTree, RevisionTree
878
r = self.last_patch()
879
if r == None:
880
return EmptyTree()
881
else:
882
return RevisionTree(self.text_store, self.get_revision_inventory(r))
883
884
371
885
372
886
def rename_one(self, from_rel, to_rel):
373
887
"""Rename one file.
374
888
375
889
This can change the directory or the filename or both.
376
890
"""
377
raise NotImplementedError('rename_one is abstract')
891
self.lock_write()
892
try:
893
tree = self.working_tree()
894
inv = tree.inventory
895
if not tree.has_filename(from_rel):
896
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
897
if tree.has_filename(to_rel):
898
raise BzrError("can't rename: new working file %r already exists" % to_rel)
899
900
file_id = inv.path2id(from_rel)
901
if file_id == None:
902
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
903
904
if inv.path2id(to_rel):
905
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
906
907
to_dir, to_tail = os.path.split(to_rel)
908
to_dir_id = inv.path2id(to_dir)
909
if to_dir_id == None and to_dir != '':
910
raise BzrError("can't determine destination directory id for %r" % to_dir)
911
912
mutter("rename_one:")
913
mutter(" file_id {%s}" % file_id)
914
mutter(" from_rel %r" % from_rel)
915
mutter(" to_rel %r" % to_rel)
916
mutter(" to_dir %r" % to_dir)
917
mutter(" to_dir_id {%s}" % to_dir_id)
918
919
inv.rename(file_id, to_dir_id, to_tail)
920
921
print "%s => %s" % (from_rel, to_rel)
922
923
from_abs = self.abspath(from_rel)
924
to_abs = self.abspath(to_rel)
925
try:
926
os.rename(from_abs, to_abs)
927
except OSError, e:
928
raise BzrError("failed to rename %r to %r: %s"
929
% (from_abs, to_abs, e[1]),
930
["rename rolled back"])
931
932
self._write_inventory(inv)
933
finally:
934
self.unlock()
935
378
936
379
937
def move(self, from_paths, to_name):
380
938
"""Rename files.
386
944
387
945
Note that to_name is only the last component of the new name;
388
946
this doesn't change the directory.
389
390
This returns a list of (from_path, to_path) pairs for each
391
entry that is moved.
392
"""
393
raise NotImplementedError('move is abstract')
394
395
def get_parent(self):
396
"""Return the parent location of the branch.
397
398
This is the default location for push/pull/missing. The usual
399
pattern is that the user can override it by specifying a
400
location.
401
"""
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')
411
412
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
422
423
def check_revno(self, revno):
424
"""\
425
Check whether a revno corresponds to any revision.
426
Zero (the NULL revision) is considered valid.
427
"""
428
if revno != 0:
429
self.check_real_revno(revno)
430
431
def check_real_revno(self, revno):
432
"""\
433
Check whether a revno corresponds to a real revision.
434
Zero (the NULL revision) is considered invalid
435
"""
436
if revno < 1 or revno > self.revno():
437
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
"""
947
"""
948
self.lock_write()
949
try:
950
## TODO: Option to move IDs only
951
assert not isinstance(from_paths, basestring)
952
tree = self.working_tree()
953
inv = tree.inventory
954
to_abs = self.abspath(to_name)
955
if not isdir(to_abs):
956
raise BzrError("destination %r is not a directory" % to_abs)
957
if not tree.has_filename(to_name):
958
raise BzrError("destination %r not in working directory" % to_abs)
959
to_dir_id = inv.path2id(to_name)
960
if to_dir_id == None and to_name != '':
961
raise BzrError("destination %r is not a versioned directory" % to_name)
962
to_dir_ie = inv[to_dir_id]
963
if to_dir_ie.kind not in ('directory', 'root_directory'):
964
raise BzrError("destination %r is not a directory" % to_abs)
965
966
to_idpath = inv.get_idpath(to_dir_id)
967
968
for f in from_paths:
969
if not tree.has_filename(f):
970
raise BzrError("%r does not exist in working tree" % f)
971
f_id = inv.path2id(f)
972
if f_id == None:
973
raise BzrError("%r is not versioned" % f)
974
name_tail = splitpath(f)[-1]
975
dest_path = appendpath(to_name, name_tail)
976
if tree.has_filename(dest_path):
977
raise BzrError("destination %r already exists" % dest_path)
978
if f_id in to_idpath:
979
raise BzrError("can't move %r to a subdirectory of itself" % f)
980
981
# OK, so there's a race here, it's possible that someone will
982
# create a file in this interval and then the rename might be
983
# left half-done. But we should have caught most problems.
984
985
for f in from_paths:
986
name_tail = splitpath(f)[-1]
987
dest_path = appendpath(to_name, name_tail)
988
print "%s => %s" % (f, dest_path)
989
inv.rename(inv.path2id(f), to_dir_id, name_tail)
990
try:
991
os.rename(self.abspath(f), self.abspath(dest_path))
992
except OSError, e:
993
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
994
["rename rolled back"])
995
996
self._write_inventory(inv)
997
finally:
998
self.unlock()
999
1000
1001
def revert(self, filenames, old_tree=None, backups=True):
1002
"""Restore selected files to the versions from a previous tree.
1003
1004
backups
1005
If true (default) backups are made of files before
1006
they're renamed.
1007
"""
1008
from bzrlib.errors import NotVersionedError, BzrError
1009
from bzrlib.atomicfile import AtomicFile
1010
from bzrlib.osutils import backup_file
1011
1012
inv = self.read_working_inventory()
1013
if old_tree is None:
1014
old_tree = self.basis_tree()
1015
old_inv = old_tree.inventory
1016
1017
nids = []
1018
for fn in filenames:
1019
file_id = inv.path2id(fn)
1020
if not file_id:
1021
raise NotVersionedError("not a versioned file", fn)
1022
if not old_inv.has_id(file_id):
1023
raise BzrError("file not present in old tree", fn, file_id)
1024
nids.append((fn, file_id))
1025
1026
# TODO: Rename back if it was previously at a different location
1027
1028
# TODO: If given a directory, restore the entire contents from
1029
# the previous version.
1030
1031
# TODO: Make a backup to a temporary file.
1032
1033
# TODO: If the file previously didn't exist, delete it?
1034
for fn, file_id in nids:
1035
backup_file(fn)
1036
1037
f = AtomicFile(fn, 'wb')
1038
try:
1039
f.write(old_tree.get_file(file_id).read())
1040
f.commit()
1041
finally:
1042
f.close()
1043
1044
1045
def pending_merges(self):
1046
"""Return a list of pending merges.
1047
1048
These are revisions that have been merged into the working
1049
directory but not yet committed.
1050
"""
1051
cfn = self.controlfilename('pending-merges')
1052
if not os.path.exists(cfn):
1053
return []
1054
p = []
1055
for l in self.controlfile('pending-merges', 'r').readlines():
1056
p.append(l.rstrip('\n'))
1057
return p
1058
1059
1060
def add_pending_merge(self, revision_id):
1061
from bzrlib.revision import validate_revision_id
1062
1063
validate_revision_id(revision_id)
1064
1065
p = self.pending_merges()
1066
if revision_id in p:
1067
return
1068
p.append(revision_id)
1069
self.set_pending_merges(p)
1070
1071
1072
def set_pending_merges(self, rev_list):
1073
from bzrlib.atomicfile import AtomicFile
1074
self.lock_write()
1075
try:
1076
f = AtomicFile(self.controlfilename('pending-merges'))
1077
try:
1078
for l in rev_list:
1079
print >>f, l
1080
f.commit()
1081
finally:
1082
f.close()
1083
finally:
1084
self.unlock()
1085
1086
1087
1088
class ScratchBranch(Branch):
1089
"""Special test class: a branch that cleans up after itself.
1090
1091
>>> b = ScratchBranch()
1092
>>> isdir(b.base)
1093
True
1094
>>> bd = b.base
1095
>>> b.destroy()
1096
>>> isdir(bd)
1097
False
1098
"""
1099
def __init__(self, files=[], dirs=[], base=None):
1100
"""Make a test branch.
1101
1102
This creates a temporary directory and runs init-tree in it.
1103
1104
If any files are listed, they are created in the working copy.
1105
"""
1106
from tempfile import mkdtemp
1107
init = False
1108
if base is None:
1109
base = mkdtemp()
1110
init = True
1111
Branch.__init__(self, base, init=init)
1112
for d in dirs:
1113
os.mkdir(self.abspath(d))
1114
1115
for f in files:
1116
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1117
1118
1119
def clone(self):
1120
"""
1121
>>> orig = ScratchBranch(files=["file1", "file2"])
1122
>>> clone = orig.clone()
1123
>>> os.path.samefile(orig.base, clone.base)
1124
False
1125
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1126
True
1127
"""
1128
from shutil import copytree
1129
from tempfile import mkdtemp
1130
base = mkdtemp()
1131
os.rmdir(base)
1132
copytree(self.base, base, symlinks=True)
1133
return ScratchBranch(base=base)
1134
1135
def __del__(self):
1136
self.destroy()
1137
1138
def destroy(self):
1139
"""Destroy the test branch, removing the scratch directory."""
1140
from shutil import rmtree
1141
try:
1142
if self.base:
1143
mutter("delete ScratchBranch %s" % self.base)
1144
rmtree(self.base)
1145
except OSError, e:
1146
# Work around for shutil.rmtree failing on Windows when
1147
# readonly files are encountered
1148
mutter("hit exception in destroying ScratchBranch: %s" % e)
1149
for root, dirs, files in os.walk(self.base, topdown=False):
1150
for name in files:
1151
os.chmod(os.path.join(root, name), 0700)
1152
rmtree(self.base)
1153
self.base = None
1154
815
1155
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
1156
1157
######################################################################
1158
# predicates
1159
1160
1161
def is_control_file(filename):
1162
## FIXME: better check
1163
filename = os.path.normpath(filename)
1164
while filename != '':
1165
head, tail = os.path.split(filename)
1166
## mutter('check %r for control file' % ((head, tail), ))
1167
if tail == bzrlib.BZRDIR:
1241
1168
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)
1169
if filename == head:
1170
break
1171
filename = head
1172
return False
1173
1174
1175
1176
def gen_file_id(name):
1177
"""Return new file id.
1178
1179
This should probably generate proper UUIDs, but for the moment we
1180
cope with just randomness because running uuidgen every time is
1181
slow."""
1182
import re
1183
from binascii import hexlify
1184
from time import time
1185
1186
# get last component
1187
idx = name.rfind('/')
1188
if idx != -1:
1189
name = name[idx+1 : ]
1190
idx = name.rfind('\\')
1191
if idx != -1:
1192
name = name[idx+1 : ]
1193
1194
# make it not a hidden file
1195
name = name.lstrip('.')
1196
1197
# remove any wierd characters; we don't escape them but rather
1198
# just pull them out
1199
name = re.sub(r'[^\w.]', '', name)
1200
1201
s = hexlify(rand_bytes(8))
1202
return '-'.join((name, compact_date(time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1