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