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