To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 2279.7.7
- compare with another revision
- download diff
- download tarball
- view history from revision 2279.7.7
- Committer: Andrew Bennetts
- Date: 2007-04-11 13:35:32 UTC
- mto: (2018.5.146 hpss)
- mto: This revision was merged to the branch mainline in revision 2414.
- Revision ID: andrew.bennetts@canonical.com-20070411133532-u6x6edf3dmzamnaq
LockDir, Repository and Branch lock token changes from the hpss branch.
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/benchmarks/tree_creator
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- bzrlib/repofmt
- bzrlib/smart
- 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/intertree_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/per_lock
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/tree_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/version_info_formats
- tools/doc_generate
- tools/win32
- files removed:
- bzrlib/mdiff.py
- notes
- patches
- plugins/changeset
- urlgrabber
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__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/testdiff.py => bzrlib/tests/test_diff.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
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- tutorial.txt => doc/tutorial.txt
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006, 2007 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
import sys
19
import os
18
from cStringIO import StringIO
19
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
20
25
21
26
import bzrlib
27
from bzrlib import (
28
bzrdir,
29
cache_utf8,
30
config as _mod_config,
31
errors,
32
lockdir,
33
lockable_files,
34
osutils,
35
revision as _mod_revision,
36
transport,
37
tree,
38
ui,
39
urlutils,
40
)
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
44
BasicTags,
45
DisabledTags,
46
)
47
""")
48
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
56
)
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
59
deprecated_method,
60
DEPRECATED_PARAMETER,
61
deprecated_passed,
62
zero_eight, zero_nine, zero_sixteen,
63
)
22
64
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
import bzrlib.errors
28
from bzrlib.textui import show_status
29
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
35
## TODO: Maybe include checks for common corruption of newlines, etc?
36
65
66
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
70
71
72
# TODO: Maybe include checks for common corruption of newlines, etc?
37
73
38
74
# TODO: Some operations like log might retrieve the same revisions
39
75
# repeatedly to calculate deltas. We could perhaps have a weakref
40
# cache in memory to make this faster.
41
42
43
def find_branch(f, **args):
44
if f and (f.startswith('http://') or f.startswith('https://')):
45
import remotebranch
46
return remotebranch.RemoteBranch(f, **args)
47
else:
48
return Branch(f, **args)
49
50
51
def find_cached_branch(f, cache_root, **args):
52
from remotebranch import RemoteBranch
53
br = find_branch(f, **args)
54
def cacheify(br, store_name):
55
from meta_store import CachedStore
56
cache_path = os.path.join(cache_root, store_name)
57
os.mkdir(cache_path)
58
new_store = CachedStore(getattr(br, store_name), cache_path)
59
setattr(br, store_name, new_store)
60
61
if isinstance(br, RemoteBranch):
62
cacheify(br, 'inventory_store')
63
cacheify(br, 'text_store')
64
cacheify(br, 'revision_store')
65
return br
66
67
68
def _relpath(base, path):
69
"""Return path relative to base, or raise exception.
70
71
The path may be either an absolute path or a path relative to the
72
current working directory.
73
74
Lifted out of Branch.relpath for ease of testing.
75
76
os.path.commonprefix (python2.4) has a bad bug that it works just
77
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
78
avoids that problem."""
79
rp = os.path.abspath(path)
80
81
s = []
82
head = rp
83
while len(head) >= len(base):
84
if head == base:
85
break
86
head, tail = os.path.split(head)
87
if tail:
88
s.insert(0, tail)
89
else:
90
from errors import NotBranchError
91
raise NotBranchError("path %r is not within branch %r" % (rp, base))
92
93
return os.sep.join(s)
94
95
96
def find_branch_root(f=None):
97
"""Find the branch root enclosing f, or pwd.
98
99
f may be a filename or a URL.
100
101
It is not necessary that f exists.
102
103
Basically we keep looking up until we find the control directory or
104
run into the root."""
105
if f == None:
106
f = os.getcwd()
107
elif hasattr(os.path, 'realpath'):
108
f = os.path.realpath(f)
109
else:
110
f = os.path.abspath(f)
111
if not os.path.exists(f):
112
raise BzrError('%r does not exist' % f)
113
114
115
orig_f = f
116
117
while True:
118
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
119
return f
120
head, tail = os.path.split(f)
121
if head == f:
122
# reached the root, whatever that may be
123
raise BzrError('%r is not in a branch' % orig_f)
124
f = head
125
126
class DivergedBranches(Exception):
127
def __init__(self, branch1, branch2):
128
self.branch1 = branch1
129
self.branch2 = branch2
130
Exception.__init__(self, "These branches have diverged.")
76
# cache in memory to make this faster. In general anything can be
77
# cached in memory between lock and unlock operations. .. nb thats
78
# what the transaction identity map provides
131
79
132
80
133
81
######################################################################
137
85
"""Branch holding a history of revisions.
138
86
139
87
base
140
Base directory of the branch.
141
142
_lock_mode
143
None, or 'r' or 'w'
144
145
_lock_count
146
If _lock_mode is true, a positive count of the number of times the
147
lock has been taken.
148
149
_lock
150
Lock object from bzrlib.lock.
88
Base directory/url of the branch.
89
90
hooks: An instance of BranchHooks.
151
91
"""
92
# this is really an instance variable - FIXME move it there
93
# - RBC 20060112
152
94
base = None
153
_lock_mode = None
154
_lock_count = None
155
_lock = None
156
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
161
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
164
165
base -- Base directory for the branch.
166
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
169
be versioned.
170
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
173
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
176
"""
177
from bzrlib.store import ImmutableStore
178
if init:
179
self.base = os.path.realpath(base)
180
self._make_control()
181
elif find_root:
182
self.base = find_branch_root(base)
183
else:
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
190
self._check_format()
191
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
195
196
197
def __str__(self):
198
return '%s(%r)' % (self.__class__.__name__, self.base)
199
200
201
__repr__ = __str__
202
203
204
def __del__(self):
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
208
self._lock.unlock()
209
210
95
96
# override this to set the strategy for storing tags
97
def _make_tags(self):
98
return DisabledTags(self)
99
100
def __init__(self, *ignored, **ignored_too):
101
self.tags = self._make_tags()
102
self._revision_history_cache = None
103
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
106
107
Uses the ui factory to ask for confirmation if the lock may be from
108
an active process.
109
110
This will probe the repository for its lock as well.
111
"""
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
116
master.break_lock()
117
118
@staticmethod
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
123
124
@staticmethod
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
127
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
130
"""
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
133
134
@staticmethod
135
def open_containing(url):
136
"""Open an existing branch which contains url.
137
138
This probes for a branch at url, and searches upwards from there.
139
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
145
"""
146
control, relpath = bzrdir.BzrDir.open_containing(url)
147
return control.open_branch(), relpath
148
149
@staticmethod
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
153
154
NOTE: This will soon be deprecated in favour of creation
155
through a BzrDir.
156
"""
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
158
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
163
164
NOTE: This is unused.
165
"""
166
pass
167
168
def get_config(self):
169
return BranchConfig(self)
170
171
def _get_nick(self):
172
return self.get_config().get_nickname()
173
174
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick)
176
177
nick = property(_get_nick, _set_nick)
178
179
def is_locked(self):
180
raise NotImplementedError(self.is_locked)
211
181
212
182
def lock_write(self):
213
if self._lock_mode:
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
217
self._lock_mode)
218
self._lock_count += 1
219
else:
220
from bzrlib.lock import WriteLock
221
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
224
self._lock_count = 1
225
226
183
raise NotImplementedError(self.lock_write)
227
184
228
185
def lock_read(self):
229
if self._lock_mode:
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
233
else:
234
from bzrlib.lock import ReadLock
235
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
238
self._lock_count = 1
239
240
241
186
raise NotImplementedError(self.lock_read)
187
242
188
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
246
247
if self._lock_count > 1:
248
self._lock_count -= 1
249
else:
250
self._lock.unlock()
251
self._lock = None
252
self._lock_mode = self._lock_count = None
253
189
raise NotImplementedError(self.unlock)
190
191
def peek_lock_mode(self):
192
"""Return lock mode for the Branch: 'r', 'w' or None"""
193
raise NotImplementedError(self.peek_lock_mode)
194
195
def get_physical_lock_status(self):
196
raise NotImplementedError(self.get_physical_lock_status)
197
198
def leave_lock_in_place(self):
199
"""Tell this branch object not to release the physical lock when this
200
object is unlocked.
201
202
If lock_write doesn't return a token, then this method is not supported.
203
"""
204
self.control_files.leave_in_place()
205
206
def dont_leave_lock_in_place(self):
207
"""Tell this branch object to release the physical lock when this
208
object is unlocked, even if it didn't originally acquire it.
209
210
If lock_write doesn't return a token, then this method is not supported.
211
"""
212
self.control_files.dont_leave_in_place()
254
213
255
214
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
258
259
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
262
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
265
266
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
272
273
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
276
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
281
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
284
"""
285
286
fn = self.controlfilename(file_or_path)
287
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
293
import codecs
294
return codecs.open(fn, mode + 'b', 'utf-8',
295
buffering=60000)
296
else:
297
raise BzrError("invalid controlfile mode %r" % mode)
298
299
300
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
304
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
314
'branch-lock',
315
'pending-merges'):
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
318
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
320
321
322
def _check_format(self):
323
"""Check this branch format is supported.
324
325
The current tool only supports the current unstable format.
326
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
329
"""
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
339
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
344
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
351
for fid in inv:
352
entry = inv[fid]
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
356
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
362
before = time()
363
self.lock_read()
364
try:
365
# ElementTree does its own conversion from UTF-8, so open in
366
# binary.
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
371
return inv
372
finally:
373
self.unlock()
374
375
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
378
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
381
"""
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
384
385
self.lock_write()
386
try:
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
try:
389
pack_xml(inv, f)
390
f.commit()
391
finally:
392
f.close()
393
finally:
394
self.unlock()
395
396
mutter('wrote working inventory')
397
398
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
401
402
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
405
406
Note that the command line normally calls smart_add instead.
407
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
410
411
files
412
List of paths to add, relative to the base of the tree.
413
414
ids
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
418
419
TODO: Perhaps have an option to add the ids even if the files do
420
not (yet) exist.
421
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
424
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
427
higher-level method.
428
"""
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
433
files = [files]
434
if ids is not None:
435
ids = [ids]
436
437
if ids is None:
438
ids = [None] * len(files)
439
else:
440
assert(len(ids) == len(files))
441
442
self.lock_write()
443
try:
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
448
449
fp = splitpath(f)
450
451
if len(fp) == 0:
452
raise BzrError("cannot add top-level %r" % f)
453
454
fullpath = os.path.normpath(self.abspath(f))
455
456
try:
457
kind = file_kind(fullpath)
458
except OSError:
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
465
if file_id is None:
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
468
469
if verbose:
470
print 'added', quotefn(f)
471
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
474
self._write_inventory(inv)
475
finally:
476
self.unlock()
477
478
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
481
self.lock_read()
482
try:
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
486
if not file_id:
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
489
finally:
490
self.unlock()
491
492
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
495
496
This does not remove their text. This does not run on
497
498
TODO: Refuse to remove modified files unless --force is given?
499
500
TODO: Do something useful with directories.
501
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
506
"""
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
510
files = [files]
511
512
self.lock_write()
513
514
try:
515
tree = self.working_tree()
516
inv = tree.inventory
517
518
# do this before any modifications
519
for f in files:
520
fid = inv.path2id(f)
521
if not fid:
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
524
if verbose:
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
527
new_status = 'I'
528
else:
529
new_status = '?'
530
show_status(new_status, inv[fid].kind, quotefn(f))
531
del inv[fid]
532
533
self._write_inventory(inv)
534
finally:
535
self.unlock()
536
537
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
544
if name == "":
545
continue
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
548
549
550
def unknowns(self):
551
"""Return all unknown files.
552
553
These are files in the working directory that are not versioned or
554
control files or ignored.
555
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
558
['foo']
559
>>> b.add('foo')
560
>>> list(b.unknowns())
561
[]
562
>>> b.remove('foo')
563
>>> list(b.unknowns())
564
['foo']
565
"""
566
return self.working_tree().unknowns()
567
568
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
571
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
574
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
577
578
f = AtomicFile(self.controlfilename('revision-history'))
579
try:
580
for rev_id in rev_history:
581
print >>f, rev_id
582
f.commit()
583
finally:
584
f.close()
585
586
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
591
592
self.lock_read()
593
try:
594
try:
595
return self.revision_store[revision_id]
596
except IndexError:
597
raise bzrlib.errors.NoSuchRevision(revision_id)
598
finally:
599
self.unlock()
600
601
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
605
606
try:
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
[revision_id,
611
str(e)])
612
613
assert r.revision_id == revision_id
614
return r
615
215
"""Return absolute filename for something in the branch
216
217
XXX: Robert Collins 20051017 what is this used for? why is it a branch
218
method and not a tree method.
219
"""
220
raise NotImplementedError(self.abspath)
221
222
def bind(self, other):
223
"""Bind the local branch the other branch.
224
225
:param other: The branch to bind to
226
:type other: Branch
227
"""
228
raise errors.UpgradeRequired(self.base)
229
230
@needs_write_lock
231
def fetch(self, from_branch, last_revision=None, pb=None):
232
"""Copy revisions from from_branch into this branch.
233
234
:param from_branch: Where to copy from.
235
:param last_revision: What revision to stop at (None for at the end
236
of the branch.
237
:param pb: An optional progress bar to use.
238
239
Returns the copied revision count and the failed revisions in a tuple:
240
(copied, failures).
241
"""
242
if self.base == from_branch.base:
243
return (0, [])
244
if pb is None:
245
nested_pb = ui.ui_factory.nested_progress_bar()
246
pb = nested_pb
247
else:
248
nested_pb = None
249
250
from_branch.lock_read()
251
try:
252
if last_revision is None:
253
pb.update('get source history')
254
last_revision = from_branch.last_revision()
255
if last_revision is None:
256
last_revision = _mod_revision.NULL_REVISION
257
return self.repository.fetch(from_branch.repository,
258
revision_id=last_revision,
259
pb=nested_pb)
260
finally:
261
if nested_pb is not None:
262
nested_pb.finished()
263
from_branch.unlock()
264
265
def get_bound_location(self):
266
"""Return the URL of the branch we are bound to.
267
268
Older format branches cannot bind, please be sure to use a metadir
269
branch.
270
"""
271
return None
272
273
def get_old_bound_location(self):
274
"""Return the URL of the branch we used to be bound to
275
"""
276
raise errors.UpgradeRequired(self.base)
277
278
def get_commit_builder(self, parents, config=None, timestamp=None,
279
timezone=None, committer=None, revprops=None,
280
revision_id=None):
281
"""Obtain a CommitBuilder for this branch.
282
283
:param parents: Revision ids of the parents of the new revision.
284
:param config: Optional configuration to use.
285
:param timestamp: Optional timestamp recorded for commit.
286
:param timezone: Optional timezone for timestamp.
287
:param committer: Optional committer to set for commit.
288
:param revprops: Optional dictionary of revision properties.
289
:param revision_id: Optional revision id.
290
"""
291
292
if config is None:
293
config = self.get_config()
294
295
return self.repository.get_commit_builder(self, parents, config,
296
timestamp, timezone, committer, revprops, revision_id)
297
298
def get_master_branch(self):
299
"""Return the branch we are bound to.
300
301
:return: Either a Branch, or None
302
"""
303
return None
616
304
617
305
def get_revision_delta(self, revno):
618
306
"""Return the delta for one revision.
624
312
rh = self.revision_history()
625
313
if not (1 <= revno <= len(rh)):
626
314
raise InvalidRevisionNumber(revno)
627
628
# revno is 1-based; list is 0-based
629
630
new_tree = self.revision_tree(rh[revno-1])
631
if revno == 1:
632
old_tree = EmptyTree()
633
else:
634
old_tree = self.revision_tree(rh[revno-2])
635
636
return compare_trees(old_tree, new_tree)
637
638
639
640
def get_revision_sha1(self, revision_id):
641
"""Hash the stored value of a revision, and return it."""
642
# In the future, revision entries will be signed. At that
643
# point, it is probably best *not* to include the signature
644
# in the revision hash. Because that lets you re-sign
645
# the revision, (add signatures/remove signatures) and still
646
# have all hash pointers stay consistent.
647
# But for now, just hash the contents.
648
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
649
650
651
def get_inventory(self, inventory_id):
652
"""Get Inventory object by hash.
653
654
TODO: Perhaps for this and similar methods, take a revision
655
parameter which can be either an integer revno or a
656
string hash."""
657
from bzrlib.inventory import Inventory
658
from bzrlib.xml import unpack_xml
659
660
return unpack_xml(Inventory, self.inventory_store[inventory_id])
661
662
663
def get_inventory_sha1(self, inventory_id):
664
"""Return the sha1 hash of the inventory entry
665
"""
666
return sha_file(self.inventory_store[inventory_id])
667
668
669
def get_revision_inventory(self, revision_id):
670
"""Return inventory of a past revision."""
671
# bzr 0.0.6 imposes the constraint that the inventory_id
672
# must be the same as its revision, so this is trivial.
673
if revision_id == None:
674
from bzrlib.inventory import Inventory
675
return Inventory(self.get_root_id())
676
else:
677
return self.get_inventory(revision_id)
678
679
315
return self.repository.get_revision_delta(rh[revno-1])
316
317
@deprecated_method(zero_sixteen)
318
def get_root_id(self):
319
"""Return the id of this branches root
320
321
Deprecated: branches don't have root ids-- trees do.
322
Use basis_tree().get_root_id() instead.
323
"""
324
raise NotImplementedError(self.get_root_id)
325
326
def print_file(self, file, revision_id):
327
"""Print `file` to stdout."""
328
raise NotImplementedError(self.print_file)
329
330
def append_revision(self, *revision_ids):
331
raise NotImplementedError(self.append_revision)
332
333
def set_revision_history(self, rev_history):
334
raise NotImplementedError(self.set_revision_history)
335
336
def _cache_revision_history(self, rev_history):
337
"""Set the cached revision history to rev_history.
338
339
The revision_history method will use this cache to avoid regenerating
340
the revision history.
341
342
This API is semi-public; it only for use by subclasses, all other code
343
should consider it to be private.
344
"""
345
self._revision_history_cache = rev_history
346
347
def _clear_cached_state(self):
348
"""Clear any cached data on this branch, e.g. cached revision history.
349
350
This means the next call to revision_history will need to call
351
_gen_revision_history.
352
353
This API is semi-public; it only for use by subclasses, all other code
354
should consider it to be private.
355
"""
356
self._revision_history_cache = None
357
358
def _gen_revision_history(self):
359
"""Return sequence of revision hashes on to this branch.
360
361
Unlike revision_history, this method always regenerates or rereads the
362
revision history, i.e. it does not cache the result, so repeated calls
363
may be expensive.
364
365
Concrete subclasses should override this instead of revision_history so
366
that subclasses do not need to deal with caching logic.
367
368
This API is semi-public; it only for use by subclasses, all other code
369
should consider it to be private.
370
"""
371
raise NotImplementedError(self._gen_revision_history)
372
373
@needs_read_lock
680
374
def revision_history(self):
681
375
"""Return sequence of revision hashes on to this branch.
682
683
>>> ScratchBranch().revision_history()
684
[]
685
"""
686
self.lock_read()
687
try:
688
return [l.rstrip('\r\n') for l in
689
self.controlfile('revision-history', 'r').readlines()]
690
finally:
691
self.unlock()
692
693
694
def common_ancestor(self, other, self_revno=None, other_revno=None):
695
"""
696
>>> import commit
697
>>> sb = ScratchBranch(files=['foo', 'foo~'])
698
>>> sb.common_ancestor(sb) == (None, None)
699
True
700
>>> commit.commit(sb, "Committing first revision", verbose=False)
701
>>> sb.common_ancestor(sb)[0]
702
1
703
>>> clone = sb.clone()
704
>>> commit.commit(sb, "Committing second revision", verbose=False)
705
>>> sb.common_ancestor(sb)[0]
706
2
707
>>> sb.common_ancestor(clone)[0]
708
1
709
>>> commit.commit(clone, "Committing divergent second revision",
710
... verbose=False)
711
>>> sb.common_ancestor(clone)[0]
712
1
713
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
714
True
715
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
716
True
717
>>> clone2 = sb.clone()
718
>>> sb.common_ancestor(clone2)[0]
719
2
720
>>> sb.common_ancestor(clone2, self_revno=1)[0]
721
1
722
>>> sb.common_ancestor(clone2, other_revno=1)[0]
723
1
724
"""
725
my_history = self.revision_history()
726
other_history = other.revision_history()
727
if self_revno is None:
728
self_revno = len(my_history)
729
if other_revno is None:
730
other_revno = len(other_history)
731
indices = range(min((self_revno, other_revno)))
732
indices.reverse()
733
for r in indices:
734
if my_history[r] == other_history[r]:
735
return r+1, my_history[r]
736
return None, None
737
376
377
This method will cache the revision history for as long as it is safe to
378
do so.
379
"""
380
if self._revision_history_cache is not None:
381
history = self._revision_history_cache
382
else:
383
history = self._gen_revision_history()
384
self._cache_revision_history(history)
385
return list(history)
738
386
739
387
def revno(self):
740
388
"""Return current revision number for this branch.
744
392
"""
745
393
return len(self.revision_history())
746
394
747
748
def last_patch(self):
749
"""Return last patch hash, or None if no history.
750
"""
395
def unbind(self):
396
"""Older format branches cannot bind or unbind."""
397
raise errors.UpgradeRequired(self.base)
398
399
def set_append_revisions_only(self, enabled):
400
"""Older format branches are never restricted to append-only"""
401
raise errors.UpgradeRequired(self.base)
402
403
def last_revision(self):
404
"""Return last revision id, or None"""
751
405
ph = self.revision_history()
752
406
if ph:
753
407
return ph[-1]
754
408
else:
755
409
return None
756
410
411
def last_revision_info(self):
412
"""Return information about the last revision.
413
414
:return: A tuple (revno, last_revision_id).
415
"""
416
rh = self.revision_history()
417
revno = len(rh)
418
if revno:
419
return (revno, rh[-1])
420
else:
421
return (0, _mod_revision.NULL_REVISION)
757
422
758
423
def missing_revisions(self, other, stop_revision=None):
759
"""
424
"""Return a list of new revisions that would perfectly fit.
425
760
426
If self and other have not diverged, return a list of the revisions
761
427
present in other, but missing from self.
762
763
>>> from bzrlib.commit import commit
764
>>> bzrlib.trace.silent = True
765
>>> br1 = ScratchBranch()
766
>>> br2 = ScratchBranch()
767
>>> br1.missing_revisions(br2)
768
[]
769
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
770
>>> br1.missing_revisions(br2)
771
[u'REVISION-ID-1']
772
>>> br2.missing_revisions(br1)
773
[]
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
775
>>> br1.missing_revisions(br2)
776
[]
777
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
778
>>> br1.missing_revisions(br2)
779
[u'REVISION-ID-2A']
780
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
781
>>> br1.missing_revisions(br2)
782
Traceback (most recent call last):
783
DivergedBranches: These branches have diverged.
784
428
"""
785
429
self_history = self.revision_history()
786
430
self_len = len(self_history)
793
437
794
438
if stop_revision is None:
795
439
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
798
440
else:
441
assert isinstance(stop_revision, int)
442
if stop_revision > other_len:
443
raise errors.NoSuchRevision(self, stop_revision)
799
444
return other_history[self_len:stop_revision]
800
445
801
802
446
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
804
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
808
>>> br1.add('foo')
809
>>> br1.add('bar')
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
813
Added 2 texts.
814
Added 1 inventories.
815
Added 1 revisions.
816
>>> br2.revision_history()
817
[u'REVISION-ID-1']
818
>>> br2.update_revisions(br1)
819
Added 0 texts.
820
Added 0 inventories.
821
Added 0 revisions.
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
823
True
824
"""
825
from bzrlib.progress import ProgressBar
826
827
pb = ProgressBar()
828
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
831
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
838
839
revisions = []
840
needed_texts = set()
841
i = 0
842
for rev_id in revision_ids:
843
i += 1
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
850
continue
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
853
854
pb.clear()
855
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
860
inventory_ids)
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
864
revision_ids)
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
868
869
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
873
874
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
878
return info
879
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
882
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
887
"""
888
if revision is None:
889
return 0, None
890
revno = None
891
try:# Convert to int if possible
892
revision = int(revision)
893
except ValueError:
894
pass
895
revs = self.revision_history()
896
if isinstance(revision, int):
897
if revision == 0:
898
return 0, None
899
# Mabye we should do this first, but we don't need it if revision == 0
900
if revision < 0:
901
revno = len(revs) + revision + 1
902
else:
903
revno = revision
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
908
break
909
else:
910
raise BzrError('No namespace registered for string: %r' % revision)
911
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
915
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
919
try:
920
return int(revision[6:])
921
except ValueError:
922
return None
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
924
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
927
try:
928
return revs.index(revision[6:]) + 1
929
except ValueError:
930
return None
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
932
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
935
try:
936
offset = int(revision[5:])
937
except ValueError:
938
return None
939
else:
940
if offset <= 0:
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
944
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
949
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
952
import datetime
953
# Spec for date revisions:
954
# date:value
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
959
#
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
964
#
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
968
val = revision[5:]
969
match_style = '='
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
972
val = val[1:]
973
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
978
dt = today
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
981
else:
982
import re
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
986
r'(,|T)?\s*'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
988
)
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
992
993
if m.group('date'):
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
995
else:
996
year, month, day = today.year, today.month, today.day
997
if m.group('time'):
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1002
else:
1003
second = 0
1004
else:
1005
hour, minute, second = 0,0,0
1006
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1009
first = dt
1010
last = None
1011
reversed = False
1012
if match_style == '-':
1013
reversed = True
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1016
1017
if reversed:
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1023
return i+1
1024
else:
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1030
return i+1
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1032
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1035
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1041
return EmptyTree()
1042
else:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1045
1046
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
1051
447
"""Pull in new perfect-fit revisions.
448
449
:param other: Another Branch to pull from
450
:param stop_revision: Updated until the given revision
451
:return: None
452
"""
453
raise NotImplementedError(self.update_revisions)
454
455
def revision_id_to_revno(self, revision_id):
456
"""Given a revision id, return its revno"""
457
if revision_id is None:
458
return 0
459
revision_id = osutils.safe_revision_id(revision_id)
460
history = self.revision_history()
461
try:
462
return history.index(revision_id) + 1
463
except ValueError:
464
raise bzrlib.errors.NoSuchRevision(self, revision_id)
465
466
def get_rev_id(self, revno, history=None):
467
"""Find the revision id of the specified revno."""
468
if revno == 0:
469
return None
470
if history is None:
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise bzrlib.errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
475
476
def pull(self, source, overwrite=False, stop_revision=None):
477
"""Mirror source into this branch.
478
479
This branch is considered to be 'local', having low latency.
480
481
:returns: PullResult instance
482
"""
483
raise NotImplementedError(self.pull)
484
485
def push(self, target, overwrite=False, stop_revision=None):
486
"""Mirror this branch into target.
487
488
This branch is considered to be 'local', having low latency.
489
"""
490
raise NotImplementedError(self.push)
1052
491
1053
492
def basis_tree(self):
1054
"""Return `Tree` object for last revision.
1055
1056
If there are no revisions yet, return an `EmptyTree`.
1057
"""
1058
r = self.last_patch()
1059
if r == None:
1060
return EmptyTree()
1061
else:
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1063
1064
493
"""Return `Tree` object for last revision."""
494
return self.repository.revision_tree(self.last_revision())
1065
495
1066
496
def rename_one(self, from_rel, to_rel):
1067
497
"""Rename one file.
1068
498
1069
499
This can change the directory or the filename or both.
1070
500
"""
1071
self.lock_write()
1072
try:
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1079
1080
file_id = inv.path2id(from_rel)
1081
if file_id == None:
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1083
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1086
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1091
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1098
1099
inv.rename(file_id, to_dir_id, to_tail)
1100
1101
print "%s => %s" % (from_rel, to_rel)
1102
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1105
try:
1106
os.rename(from_abs, to_abs)
1107
except OSError, e:
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1111
1112
self._write_inventory(inv)
1113
finally:
1114
self.unlock()
1115
501
raise NotImplementedError(self.rename_one)
1116
502
1117
503
def move(self, from_paths, to_name):
1118
504
"""Rename files.
1124
510
1125
511
Note that to_name is only the last component of the new name;
1126
512
this doesn't change the directory.
1127
"""
1128
self.lock_write()
1129
try:
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1145
1146
to_idpath = inv.get_idpath(to_dir_id)
1147
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1152
if f_id == None:
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1160
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1164
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1170
try:
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1172
except OSError, e:
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1175
1176
self._write_inventory(inv)
1177
finally:
1178
self.unlock()
1179
1180
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1183
1184
backups
1185
If true (default) backups are made of files before
1186
they're renamed.
1187
"""
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1191
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1196
1197
nids = []
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1200
if not file_id:
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1205
1206
# TODO: Rename back if it was previously at a different location
1207
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1210
1211
# TODO: Make a backup to a temporary file.
1212
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1215
backup_file(fn)
1216
1217
f = AtomicFile(fn, 'wb')
1218
try:
1219
f.write(old_tree.get_file(file_id).read())
1220
f.commit()
1221
finally:
1222
f.close()
1223
1224
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1227
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1230
"""
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1233
return []
1234
p = []
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1237
return p
1238
1239
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1242
1243
validate_revision_id(revision_id)
1244
1245
p = self.pending_merges()
1246
if revision_id in p:
1247
return
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1250
1251
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1254
self.lock_write()
1255
try:
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1257
try:
1258
for l in rev_list:
1259
print >>f, l
1260
f.commit()
1261
finally:
1262
f.close()
1263
finally:
1264
self.unlock()
1265
1266
1267
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1270
1271
>>> b = ScratchBranch()
1272
>>> isdir(b.base)
1273
True
1274
>>> bd = b.base
1275
>>> b.destroy()
1276
>>> isdir(bd)
1277
False
1278
"""
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1281
1282
This creates a temporary directory and runs init-tree in it.
1283
1284
If any files are listed, they are created in the working copy.
1285
"""
1286
from tempfile import mkdtemp
1287
init = False
1288
if base is None:
1289
base = mkdtemp()
1290
init = True
1291
Branch.__init__(self, base, init=init)
1292
for d in dirs:
1293
os.mkdir(self.abspath(d))
1294
1295
for f in files:
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1297
1298
1299
def clone(self):
1300
"""
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1304
False
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
True
1307
"""
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1310
base = mkdtemp()
1311
os.rmdir(base)
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1314
1315
def __del__(self):
1316
self.destroy()
1317
1318
def destroy(self):
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1321
try:
1322
if self.base:
1323
mutter("delete ScratchBranch %s" % self.base)
1324
rmtree(self.base)
1325
except OSError, e:
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1330
for name in files:
1331
os.chmod(os.path.join(root, name), 0700)
1332
rmtree(self.base)
1333
self.base = None
1334
1335
1336
1337
######################################################################
1338
# predicates
1339
1340
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
513
514
This returns a list of (from_path, to_path) pairs for each
515
entry that is moved.
516
"""
517
raise NotImplementedError(self.move)
518
519
def get_parent(self):
520
"""Return the parent location of the branch.
521
522
This is the default location for push/pull/missing. The usual
523
pattern is that the user can override it by specifying a
524
location.
525
"""
526
raise NotImplementedError(self.get_parent)
527
528
def _set_config_location(self, name, url, config=None,
529
make_relative=False):
530
if config is None:
531
config = self.get_config()
532
if url is None:
533
url = ''
534
elif make_relative:
535
url = urlutils.relative_url(self.base, url)
536
config.set_user_option(name, url)
537
538
def _get_config_location(self, name, config=None):
539
if config is None:
540
config = self.get_config()
541
location = config.get_user_option(name)
542
if location == '':
543
location = None
544
return location
545
546
def get_submit_branch(self):
547
"""Return the submit location of the branch.
548
549
This is the default location for bundle. The usual
550
pattern is that the user can override it by specifying a
551
location.
552
"""
553
return self.get_config().get_user_option('submit_branch')
554
555
def set_submit_branch(self, location):
556
"""Return the submit location of the branch.
557
558
This is the default location for bundle. The usual
559
pattern is that the user can override it by specifying a
560
location.
561
"""
562
self.get_config().set_user_option('submit_branch', location)
563
564
def get_public_branch(self):
565
"""Return the public location of the branch.
566
567
This is is used by merge directives.
568
"""
569
return self._get_config_location('public_branch')
570
571
def set_public_branch(self, location):
572
"""Return the submit location of the branch.
573
574
This is the default location for bundle. The usual
575
pattern is that the user can override it by specifying a
576
location.
577
"""
578
self._set_config_location('public_branch', location)
579
580
def get_push_location(self):
581
"""Return the None or the location to push this branch to."""
582
raise NotImplementedError(self.get_push_location)
583
584
def set_push_location(self, location):
585
"""Set a new push location for this branch."""
586
raise NotImplementedError(self.set_push_location)
587
588
def set_parent(self, url):
589
raise NotImplementedError(self.set_parent)
590
591
@needs_write_lock
592
def update(self):
593
"""Synchronise this branch with the master branch if any.
594
595
:return: None or the last_revision pivoted out during the update.
596
"""
597
return None
598
599
def check_revno(self, revno):
600
"""\
601
Check whether a revno corresponds to any revision.
602
Zero (the NULL revision) is considered valid.
603
"""
604
if revno != 0:
605
self.check_real_revno(revno)
606
607
def check_real_revno(self, revno):
608
"""\
609
Check whether a revno corresponds to a real revision.
610
Zero (the NULL revision) is considered invalid
611
"""
612
if revno < 1 or revno > self.revno():
613
raise InvalidRevisionNumber(revno)
614
615
@needs_read_lock
616
def clone(self, to_bzrdir, revision_id=None):
617
"""Clone this branch into to_bzrdir preserving all semantic values.
618
619
revision_id: if not None, the revision history in the new branch will
620
be truncated to end with revision_id.
621
"""
622
result = self._format.initialize(to_bzrdir)
623
self.copy_content_into(result, revision_id=revision_id)
624
return result
625
626
@needs_read_lock
627
def sprout(self, to_bzrdir, revision_id=None):
628
"""Create a new line of development from the branch, into to_bzrdir.
629
630
revision_id: if not None, the revision history in the new branch will
631
be truncated to end with revision_id.
632
"""
633
result = self._format.initialize(to_bzrdir)
634
self.copy_content_into(result, revision_id=revision_id)
635
result.set_parent(self.bzrdir.root_transport.base)
636
return result
637
638
def _synchronize_history(self, destination, revision_id):
639
"""Synchronize last revision and revision history between branches.
640
641
This version is most efficient when the destination is also a
642
BzrBranch5, but works for BzrBranch6 as long as the revision
643
history is the true lefthand parent history, and all of the revisions
644
are in the destination's repository. If not, set_revision_history
645
will fail.
646
647
:param destination: The branch to copy the history into
648
:param revision_id: The revision-id to truncate history at. May
649
be None to copy complete history.
650
"""
651
new_history = self.revision_history()
652
if revision_id is not None:
653
revision_id = osutils.safe_revision_id(revision_id)
654
try:
655
new_history = new_history[:new_history.index(revision_id) + 1]
656
except ValueError:
657
rev = self.repository.get_revision(revision_id)
658
new_history = rev.get_history(self.repository)[1:]
659
destination.set_revision_history(new_history)
660
661
@needs_read_lock
662
def copy_content_into(self, destination, revision_id=None):
663
"""Copy the content of self into destination.
664
665
revision_id: if not None, the revision history in the new branch will
666
be truncated to end with revision_id.
667
"""
668
self._synchronize_history(destination, revision_id)
669
try:
670
parent = self.get_parent()
671
except errors.InaccessibleParent, e:
672
mutter('parent was not accessible to copy: %s', e)
673
else:
674
if parent:
675
destination.set_parent(parent)
676
self.tags.merge_to(destination.tags)
677
678
@needs_read_lock
679
def check(self):
680
"""Check consistency of the branch.
681
682
In particular this checks that revisions given in the revision-history
683
do actually match up in the revision graph, and that they're all
684
present in the repository.
685
686
Callers will typically also want to check the repository.
687
688
:return: A BranchCheckResult.
689
"""
690
mainline_parent_id = None
691
for revision_id in self.revision_history():
692
try:
693
revision = self.repository.get_revision(revision_id)
694
except errors.NoSuchRevision, e:
695
raise errors.BzrCheckError("mainline revision {%s} not in repository"
696
% revision_id)
697
# In general the first entry on the revision history has no parents.
698
# But it's not illegal for it to have parents listed; this can happen
699
# in imports from Arch when the parents weren't reachable.
700
if mainline_parent_id is not None:
701
if mainline_parent_id not in revision.parent_ids:
702
raise errors.BzrCheckError("previous revision {%s} not listed among "
703
"parents of {%s}"
704
% (mainline_parent_id, revision_id))
705
mainline_parent_id = revision_id
706
return BranchCheckResult(self)
707
708
def _get_checkout_format(self):
709
"""Return the most suitable metadir for a checkout of this branch.
710
Weaves are used if this branch's repostory uses weaves.
711
"""
712
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
713
from bzrlib.repofmt import weaverepo
714
format = bzrdir.BzrDirMetaFormat1()
715
format.repository_format = weaverepo.RepositoryFormat7()
716
else:
717
format = self.repository.bzrdir.checkout_metadir()
718
format.set_branch_format(self._format)
719
return format
720
721
def create_checkout(self, to_location, revision_id=None,
722
lightweight=False):
723
"""Create a checkout of a branch.
724
725
:param to_location: The url to produce the checkout at
726
:param revision_id: The revision to check out
727
:param lightweight: If True, produce a lightweight checkout, otherwise,
728
produce a bound branch (heavyweight checkout)
729
:return: The tree of the created checkout
730
"""
731
t = transport.get_transport(to_location)
732
try:
733
t.mkdir('.')
734
except errors.FileExists:
735
pass
736
if lightweight:
737
format = self._get_checkout_format()
738
checkout = format.initialize_on_transport(t)
739
BranchReferenceFormat().initialize(checkout, self)
740
else:
741
format = self._get_checkout_format()
742
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
743
to_location, force_new_tree=False, format=format)
744
checkout = checkout_branch.bzrdir
745
checkout_branch.bind(self)
746
# pull up to the specified revision_id to set the initial
747
# branch tip correctly, and seed it with history.
748
checkout_branch.pull(self, stop_revision=revision_id)
749
tree = checkout.create_workingtree(revision_id)
750
basis_tree = tree.basis_tree()
751
basis_tree.lock_read()
752
try:
753
for path, file_id in basis_tree.iter_references():
754
reference_parent = self.reference_parent(file_id, path)
755
reference_parent.create_checkout(tree.abspath(path),
756
basis_tree.get_reference_revision(file_id, path),
757
lightweight)
758
finally:
759
basis_tree.unlock()
760
return tree
761
762
def reference_parent(self, file_id, path):
763
"""Return the parent branch for a tree-reference file_id
764
:param file_id: The file_id of the tree reference
765
:param path: The path of the file_id in the tree
766
:return: A branch associated with the file_id
767
"""
768
# FIXME should provide multiple branches, based on config
769
return Branch.open(self.bzrdir.root_transport.clone(path).base)
770
771
def supports_tags(self):
772
return self._format.supports_tags()
773
774
775
class BranchFormat(object):
776
"""An encapsulation of the initialization and open routines for a format.
777
778
Formats provide three things:
779
* An initialization routine,
780
* a format string,
781
* an open routine.
782
783
Formats are placed in an dict by their format string for reference
784
during branch opening. Its not required that these be instances, they
785
can be classes themselves with class methods - it simply depends on
786
whether state is needed for a given format or not.
787
788
Once a format is deprecated, just deprecate the initialize and open
789
methods on the format class. Do not deprecate the object, as the
790
object will be created every time regardless.
791
"""
792
793
_default_format = None
794
"""The default format used for new branches."""
795
796
_formats = {}
797
"""The known formats."""
798
799
@classmethod
800
def find_format(klass, a_bzrdir):
801
"""Return the format for the branch object in a_bzrdir."""
802
try:
803
transport = a_bzrdir.get_branch_transport(None)
804
format_string = transport.get("format").read()
805
return klass._formats[format_string]
806
except NoSuchFile:
807
raise NotBranchError(path=transport.base)
808
except KeyError:
809
raise errors.UnknownFormatError(format=format_string)
810
811
@classmethod
812
def get_default_format(klass):
813
"""Return the current default format."""
814
return klass._default_format
815
816
def get_format_string(self):
817
"""Return the ASCII format string that identifies this format."""
818
raise NotImplementedError(self.get_format_string)
819
820
def get_format_description(self):
821
"""Return the short format description for this format."""
822
raise NotImplementedError(self.get_format_description)
823
824
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
825
set_format=True):
826
"""Initialize a branch in a bzrdir, with specified files
827
828
:param a_bzrdir: The bzrdir to initialize the branch in
829
:param utf8_files: The files to create as a list of
830
(filename, content) tuples
831
:param set_format: If True, set the format with
832
self.get_format_string. (BzrBranch4 has its format set
833
elsewhere)
834
:return: a branch in this format
835
"""
836
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
837
branch_transport = a_bzrdir.get_branch_transport(self)
838
lock_map = {
839
'metadir': ('lock', lockdir.LockDir),
840
'branch4': ('branch-lock', lockable_files.TransportLock),
841
}
842
lock_name, lock_class = lock_map[lock_type]
843
control_files = lockable_files.LockableFiles(branch_transport,
844
lock_name, lock_class)
845
control_files.create_lock()
846
control_files.lock_write()
847
if set_format:
848
control_files.put_utf8('format', self.get_format_string())
849
try:
850
for file, content in utf8_files:
851
control_files.put_utf8(file, content)
852
finally:
853
control_files.unlock()
854
return self.open(a_bzrdir, _found=True)
855
856
def initialize(self, a_bzrdir):
857
"""Create a branch of this format in a_bzrdir."""
858
raise NotImplementedError(self.initialize)
859
860
def is_supported(self):
861
"""Is this format supported?
862
863
Supported formats can be initialized and opened.
864
Unsupported formats may not support initialization or committing or
865
some other features depending on the reason for not being supported.
866
"""
867
return True
868
869
def open(self, a_bzrdir, _found=False):
870
"""Return the branch object for a_bzrdir
871
872
_found is a private parameter, do not use it. It is used to indicate
873
if format probing has already be done.
874
"""
875
raise NotImplementedError(self.open)
876
877
@classmethod
878
def register_format(klass, format):
879
klass._formats[format.get_format_string()] = format
880
881
@classmethod
882
def set_default_format(klass, format):
883
klass._default_format = format
884
885
@classmethod
886
def unregister_format(klass, format):
887
assert klass._formats[format.get_format_string()] is format
888
del klass._formats[format.get_format_string()]
889
890
def __str__(self):
891
return self.get_format_string().rstrip()
892
893
def supports_tags(self):
894
"""True if this format supports tags stored in the branch"""
895
return False # by default
896
897
# XXX: Probably doesn't really belong here -- mbp 20070212
898
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
899
lock_class):
900
branch_transport = a_bzrdir.get_branch_transport(self)
901
control_files = lockable_files.LockableFiles(branch_transport,
902
lock_filename, lock_class)
903
control_files.create_lock()
904
control_files.lock_write()
905
try:
906
for filename, content in utf8_files:
907
control_files.put_utf8(filename, content)
908
finally:
909
control_files.unlock()
910
911
912
class BranchHooks(Hooks):
913
"""A dictionary mapping hook name to a list of callables for branch hooks.
914
915
e.g. ['set_rh'] Is the list of items to be called when the
916
set_revision_history function is invoked.
917
"""
918
919
def __init__(self):
920
"""Create the default hooks.
921
922
These are all empty initially, because by default nothing should get
923
notified.
924
"""
925
Hooks.__init__(self)
926
# Introduced in 0.15:
927
# invoked whenever the revision history has been set
928
# with set_revision_history. The api signature is
929
# (branch, revision_history), and the branch will
930
# be write-locked.
931
self['set_rh'] = []
932
# invoked after a push operation completes.
933
# the api signature is
934
# (push_result)
935
# containing the members
936
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
937
# where local is the local branch or None, master is the target
938
# master branch, and the rest should be self explanatory. The source
939
# is read locked and the target branches write locked. Source will
940
# be the local low-latency branch.
941
self['post_push'] = []
942
# invoked after a pull operation completes.
943
# the api signature is
944
# (pull_result)
945
# containing the members
946
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
947
# where local is the local branch or None, master is the target
948
# master branch, and the rest should be self explanatory. The source
949
# is read locked and the target branches write locked. The local
950
# branch is the low-latency branch.
951
self['post_pull'] = []
952
# invoked after a commit operation completes.
953
# the api signature is
954
# (local, master, old_revno, old_revid, new_revno, new_revid)
955
# old_revid is NULL_REVISION for the first commit to a branch.
956
self['post_commit'] = []
957
# invoked after a uncommit operation completes.
958
# the api signature is
959
# (local, master, old_revno, old_revid, new_revno, new_revid) where
960
# local is the local branch or None, master is the target branch,
961
# and an empty branch recieves new_revno of 0, new_revid of None.
962
self['post_uncommit'] = []
963
964
965
# install the default hooks into the Branch class.
966
Branch.hooks = BranchHooks()
967
968
969
class BzrBranchFormat4(BranchFormat):
970
"""Bzr branch format 4.
971
972
This format has:
973
- a revision-history file.
974
- a branch-lock lock file [ to be shared with the bzrdir ]
975
"""
976
977
def get_format_description(self):
978
"""See BranchFormat.get_format_description()."""
979
return "Branch format 4"
980
981
def initialize(self, a_bzrdir):
982
"""Create a branch of this format in a_bzrdir."""
983
utf8_files = [('revision-history', ''),
984
('branch-name', ''),
985
]
986
return self._initialize_helper(a_bzrdir, utf8_files,
987
lock_type='branch4', set_format=False)
988
989
def __init__(self):
990
super(BzrBranchFormat4, self).__init__()
991
self._matchingbzrdir = bzrdir.BzrDirFormat6()
992
993
def open(self, a_bzrdir, _found=False):
994
"""Return the branch object for a_bzrdir
995
996
_found is a private parameter, do not use it. It is used to indicate
997
if format probing has already be done.
998
"""
999
if not _found:
1000
# we are being called directly and must probe.
1001
raise NotImplementedError
1002
return BzrBranch(_format=self,
1003
_control_files=a_bzrdir._control_files,
1004
a_bzrdir=a_bzrdir,
1005
_repository=a_bzrdir.open_repository())
1006
1007
def __str__(self):
1008
return "Bazaar-NG branch format 4"
1009
1010
1011
class BzrBranchFormat5(BranchFormat):
1012
"""Bzr branch format 5.
1013
1014
This format has:
1015
- a revision-history file.
1016
- a format string
1017
- a lock dir guarding the branch itself
1018
- all of this stored in a branch/ subdirectory
1019
- works with shared repositories.
1020
1021
This format is new in bzr 0.8.
1022
"""
1023
1024
def get_format_string(self):
1025
"""See BranchFormat.get_format_string()."""
1026
return "Bazaar-NG branch format 5\n"
1027
1028
def get_format_description(self):
1029
"""See BranchFormat.get_format_description()."""
1030
return "Branch format 5"
1031
1032
def initialize(self, a_bzrdir):
1033
"""Create a branch of this format in a_bzrdir."""
1034
utf8_files = [('revision-history', ''),
1035
('branch-name', ''),
1036
]
1037
return self._initialize_helper(a_bzrdir, utf8_files)
1038
1039
def __init__(self):
1040
super(BzrBranchFormat5, self).__init__()
1041
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1042
1043
def open(self, a_bzrdir, _found=False):
1044
"""Return the branch object for a_bzrdir
1045
1046
_found is a private parameter, do not use it. It is used to indicate
1047
if format probing has already be done.
1048
"""
1049
if not _found:
1050
format = BranchFormat.find_format(a_bzrdir)
1051
assert format.__class__ == self.__class__
1052
transport = a_bzrdir.get_branch_transport(None)
1053
control_files = lockable_files.LockableFiles(transport, 'lock',
1054
lockdir.LockDir)
1055
return BzrBranch5(_format=self,
1056
_control_files=control_files,
1057
a_bzrdir=a_bzrdir,
1058
_repository=a_bzrdir.find_repository())
1059
1060
1061
class BzrBranchFormat6(BzrBranchFormat5):
1062
"""Branch format with last-revision
1063
1064
Unlike previous formats, this has no explicit revision history. Instead,
1065
this just stores the last-revision, and the left-hand history leading
1066
up to there is the history.
1067
1068
This format was introduced in bzr 0.15
1069
"""
1070
1071
def get_format_string(self):
1072
"""See BranchFormat.get_format_string()."""
1073
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1074
1075
def get_format_description(self):
1076
"""See BranchFormat.get_format_description()."""
1077
return "Branch format 6"
1078
1079
def initialize(self, a_bzrdir):
1080
"""Create a branch of this format in a_bzrdir."""
1081
utf8_files = [('last-revision', '0 null:\n'),
1082
('branch-name', ''),
1083
('branch.conf', ''),
1084
('tags', ''),
1085
]
1086
return self._initialize_helper(a_bzrdir, utf8_files)
1087
1088
def open(self, a_bzrdir, _found=False):
1089
"""Return the branch object for a_bzrdir
1090
1091
_found is a private parameter, do not use it. It is used to indicate
1092
if format probing has already be done.
1093
"""
1094
if not _found:
1095
format = BranchFormat.find_format(a_bzrdir)
1096
assert format.__class__ == self.__class__
1097
transport = a_bzrdir.get_branch_transport(None)
1098
control_files = lockable_files.LockableFiles(transport, 'lock',
1099
lockdir.LockDir)
1100
return BzrBranch6(_format=self,
1101
_control_files=control_files,
1102
a_bzrdir=a_bzrdir,
1103
_repository=a_bzrdir.find_repository())
1104
1105
def supports_tags(self):
1106
return True
1107
1108
1109
class BranchReferenceFormat(BranchFormat):
1110
"""Bzr branch reference format.
1111
1112
Branch references are used in implementing checkouts, they
1113
act as an alias to the real branch which is at some other url.
1114
1115
This format has:
1116
- A location file
1117
- a format string
1118
"""
1119
1120
def get_format_string(self):
1121
"""See BranchFormat.get_format_string()."""
1122
return "Bazaar-NG Branch Reference Format 1\n"
1123
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Checkout reference format 1"
1127
1128
def initialize(self, a_bzrdir, target_branch=None):
1129
"""Create a branch of this format in a_bzrdir."""
1130
if target_branch is None:
1131
# this format does not implement branch itself, thus the implicit
1132
# creation contract must see it as uninitializable
1133
raise errors.UninitializableFormat(self)
1134
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1135
branch_transport = a_bzrdir.get_branch_transport(self)
1136
branch_transport.put_bytes('location',
1137
target_branch.bzrdir.root_transport.base)
1138
branch_transport.put_bytes('format', self.get_format_string())
1139
return self.open(a_bzrdir, _found=True)
1140
1141
def __init__(self):
1142
super(BranchReferenceFormat, self).__init__()
1143
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1144
1145
def _make_reference_clone_function(format, a_branch):
1146
"""Create a clone() routine for a branch dynamically."""
1147
def clone(to_bzrdir, revision_id=None):
1148
"""See Branch.clone()."""
1149
return format.initialize(to_bzrdir, a_branch)
1150
# cannot obey revision_id limits when cloning a reference ...
1151
# FIXME RBC 20060210 either nuke revision_id for clone, or
1152
# emit some sort of warning/error to the caller ?!
1153
return clone
1154
1155
def open(self, a_bzrdir, _found=False):
1156
"""Return the branch that the branch reference in a_bzrdir points at.
1157
1158
_found is a private parameter, do not use it. It is used to indicate
1159
if format probing has already be done.
1160
"""
1161
if not _found:
1162
format = BranchFormat.find_format(a_bzrdir)
1163
assert format.__class__ == self.__class__
1164
transport = a_bzrdir.get_branch_transport(None)
1165
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1166
result = real_bzrdir.open_branch()
1167
# this changes the behaviour of result.clone to create a new reference
1168
# rather than a copy of the content of the branch.
1169
# I did not use a proxy object because that needs much more extensive
1170
# testing, and we are only changing one behaviour at the moment.
1171
# If we decide to alter more behaviours - i.e. the implicit nickname
1172
# then this should be refactored to introduce a tested proxy branch
1173
# and a subclass of that for use in overriding clone() and ....
1174
# - RBC 20060210
1175
result.clone = self._make_reference_clone_function(result)
1176
return result
1177
1178
1179
# formats which have no format string are not discoverable
1180
# and not independently creatable, so are not registered.
1181
__default_format = BzrBranchFormat5()
1182
BranchFormat.register_format(__default_format)
1183
BranchFormat.register_format(BranchReferenceFormat())
1184
BranchFormat.register_format(BzrBranchFormat6())
1185
BranchFormat.set_default_format(__default_format)
1186
_legacy_formats = [BzrBranchFormat4(),
1187
]
1188
1189
class BzrBranch(Branch):
1190
"""A branch stored in the actual filesystem.
1191
1192
Note that it's "local" in the context of the filesystem; it doesn't
1193
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1194
it's writable, and can be accessed via the normal filesystem API.
1195
"""
1196
1197
def __init__(self, _format=None,
1198
_control_files=None, a_bzrdir=None, _repository=None):
1199
"""Create new branch object at a particular location."""
1200
Branch.__init__(self)
1201
if a_bzrdir is None:
1202
raise ValueError('a_bzrdir must be supplied')
1203
else:
1204
self.bzrdir = a_bzrdir
1205
# self._transport used to point to the directory containing the
1206
# control directory, but was not used - now it's just the transport
1207
# for the branch control files. mbp 20070212
1208
self._base = self.bzrdir.transport.clone('..').base
1209
self._format = _format
1210
if _control_files is None:
1211
raise ValueError('BzrBranch _control_files is None')
1212
self.control_files = _control_files
1213
self._transport = _control_files._transport
1214
self.repository = _repository
1215
1216
def __str__(self):
1217
return '%s(%r)' % (self.__class__.__name__, self.base)
1218
1219
__repr__ = __str__
1220
1221
def _get_base(self):
1222
"""Returns the directory containing the control directory."""
1223
return self._base
1224
1225
base = property(_get_base, doc="The URL for the root of this branch.")
1226
1227
def abspath(self, name):
1228
"""See Branch.abspath."""
1229
return self.control_files._transport.abspath(name)
1230
1231
1232
@deprecated_method(zero_sixteen)
1233
@needs_read_lock
1234
def get_root_id(self):
1235
"""See Branch.get_root_id."""
1236
tree = self.repository.revision_tree(self.last_revision())
1237
return tree.inventory.root.file_id
1238
1239
def is_locked(self):
1240
return self.control_files.is_locked()
1241
1242
def lock_write(self, tokens=None):
1243
if tokens is not None:
1244
branch_token, repo_token = tokens
1245
else:
1246
branch_token = repo_token = None
1247
repo_token = self.repository.lock_write(token=repo_token)
1248
try:
1249
branch_token = self.control_files.lock_write(token=branch_token)
1250
except:
1251
self.repository.unlock()
1252
raise
1253
else:
1254
tokens = (branch_token, repo_token)
1255
assert tokens == (None, None) or None not in tokens, (
1256
'Both branch and repository locks must return tokens, or else '
1257
'neither must return tokens. Got %r.' % (tokens,))
1258
if tokens == (None, None):
1259
return None
1260
else:
1261
return tokens
1262
1263
def lock_read(self):
1264
self.repository.lock_read()
1265
try:
1266
self.control_files.lock_read()
1267
except:
1268
self.repository.unlock()
1269
raise
1270
1271
def unlock(self):
1272
# TODO: test for failed two phase locks. This is known broken.
1273
try:
1274
self.control_files.unlock()
1275
finally:
1276
self.repository.unlock()
1277
if not self.control_files.is_locked():
1278
# we just released the lock
1279
self._clear_cached_state()
1280
1281
def peek_lock_mode(self):
1282
if self.control_files._lock_count == 0:
1283
return None
1284
else:
1285
return self.control_files._lock_mode
1286
1287
def get_physical_lock_status(self):
1288
return self.control_files.get_physical_lock_status()
1289
1290
@needs_read_lock
1291
def print_file(self, file, revision_id):
1292
"""See Branch.print_file."""
1293
return self.repository.print_file(file, revision_id)
1294
1295
@needs_write_lock
1296
def append_revision(self, *revision_ids):
1297
"""See Branch.append_revision."""
1298
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1299
for revision_id in revision_ids:
1300
_mod_revision.check_not_reserved_id(revision_id)
1301
mutter("add {%s} to revision-history" % revision_id)
1302
rev_history = self.revision_history()
1303
rev_history.extend(revision_ids)
1304
self.set_revision_history(rev_history)
1305
1306
def _write_revision_history(self, history):
1307
"""Factored out of set_revision_history.
1308
1309
This performs the actual writing to disk.
1310
It is intended to be called by BzrBranch5.set_revision_history."""
1311
self.control_files.put_bytes(
1312
'revision-history', '\n'.join(history))
1313
1314
@needs_write_lock
1315
def set_revision_history(self, rev_history):
1316
"""See Branch.set_revision_history."""
1317
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1318
self._write_revision_history(rev_history)
1319
self._cache_revision_history(rev_history)
1320
for hook in Branch.hooks['set_rh']:
1321
hook(self, rev_history)
1322
1323
@needs_write_lock
1324
def set_last_revision_info(self, revno, revision_id):
1325
revision_id = osutils.safe_revision_id(revision_id)
1326
history = self._lefthand_history(revision_id)
1327
assert len(history) == revno, '%d != %d' % (len(history), revno)
1328
self.set_revision_history(history)
1329
1330
def _gen_revision_history(self):
1331
history = self.control_files.get('revision-history').read().split('\n')
1332
if history[-1:] == ['']:
1333
# There shouldn't be a trailing newline, but just in case.
1334
history.pop()
1335
return history
1336
1337
def _lefthand_history(self, revision_id, last_rev=None,
1338
other_branch=None):
1339
# stop_revision must be a descendant of last_revision
1340
stop_graph = self.repository.get_revision_graph(revision_id)
1341
if last_rev is not None and last_rev not in stop_graph:
1342
# our previous tip is not merged into stop_revision
1343
raise errors.DivergedBranches(self, other_branch)
1344
# make a new revision history from the graph
1345
current_rev_id = revision_id
1346
new_history = []
1347
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1348
new_history.append(current_rev_id)
1349
current_rev_id_parents = stop_graph[current_rev_id]
1350
try:
1351
current_rev_id = current_rev_id_parents[0]
1352
except IndexError:
1353
current_rev_id = None
1354
new_history.reverse()
1355
return new_history
1356
1357
@needs_write_lock
1358
def generate_revision_history(self, revision_id, last_rev=None,
1359
other_branch=None):
1360
"""Create a new revision history that will finish with revision_id.
1361
1362
:param revision_id: the new tip to use.
1363
:param last_rev: The previous last_revision. If not None, then this
1364
must be a ancestory of revision_id, or DivergedBranches is raised.
1365
:param other_branch: The other branch that DivergedBranches should
1366
raise with respect to.
1367
"""
1368
revision_id = osutils.safe_revision_id(revision_id)
1369
self.set_revision_history(self._lefthand_history(revision_id,
1370
last_rev, other_branch))
1371
1372
@needs_write_lock
1373
def update_revisions(self, other, stop_revision=None):
1374
"""See Branch.update_revisions."""
1375
other.lock_read()
1376
try:
1377
if stop_revision is None:
1378
stop_revision = other.last_revision()
1379
if stop_revision is None:
1380
# if there are no commits, we're done.
1381
return
1382
else:
1383
stop_revision = osutils.safe_revision_id(stop_revision)
1384
# whats the current last revision, before we fetch [and change it
1385
# possibly]
1386
last_rev = self.last_revision()
1387
# we fetch here regardless of whether we need to so that we pickup
1388
# filled in ghosts.
1389
self.fetch(other, stop_revision)
1390
my_ancestry = self.repository.get_ancestry(last_rev)
1391
if stop_revision in my_ancestry:
1392
# last_revision is a descendant of stop_revision
1393
return
1394
self.generate_revision_history(stop_revision, last_rev=last_rev,
1395
other_branch=other)
1396
finally:
1397
other.unlock()
1398
1399
def basis_tree(self):
1400
"""See Branch.basis_tree."""
1401
return self.repository.revision_tree(self.last_revision())
1402
1403
@deprecated_method(zero_eight)
1404
def working_tree(self):
1405
"""Create a Working tree object for this branch."""
1406
1407
from bzrlib.transport.local import LocalTransport
1408
if (self.base.find('://') != -1 or
1409
not isinstance(self._transport, LocalTransport)):
1410
raise NoWorkingTree(self.base)
1411
return self.bzrdir.open_workingtree()
1412
1413
@needs_write_lock
1414
def pull(self, source, overwrite=False, stop_revision=None,
1415
_hook_master=None, _run_hooks=True):
1416
"""See Branch.pull.
1417
1418
:param _hook_master: Private parameter - set the branch to
1419
be supplied as the master to push hooks.
1420
:param _run_hooks: Private parameter - allow disabling of
1421
hooks, used when pushing to a master branch.
1422
"""
1423
result = PullResult()
1424
result.source_branch = source
1425
result.target_branch = self
1426
source.lock_read()
1427
try:
1428
result.old_revno, result.old_revid = self.last_revision_info()
1429
try:
1430
self.update_revisions(source, stop_revision)
1431
except DivergedBranches:
1432
if not overwrite:
1433
raise
1434
if overwrite:
1435
if stop_revision is None:
1436
stop_revision = source.last_revision()
1437
self.generate_revision_history(stop_revision)
1438
result.tag_conflicts = source.tags.merge_to(self.tags)
1439
result.new_revno, result.new_revid = self.last_revision_info()
1440
if _hook_master:
1441
result.master_branch = _hook_master
1442
result.local_branch = self
1443
else:
1444
result.master_branch = self
1445
result.local_branch = None
1446
if _run_hooks:
1447
for hook in Branch.hooks['post_pull']:
1448
hook(result)
1449
finally:
1450
source.unlock()
1451
return result
1452
1453
def _get_parent_location(self):
1454
_locs = ['parent', 'pull', 'x-pull']
1455
for l in _locs:
1456
try:
1457
return self.control_files.get(l).read().strip('\n')
1458
except NoSuchFile:
1459
pass
1460
return None
1461
1462
@needs_read_lock
1463
def push(self, target, overwrite=False, stop_revision=None,
1464
_hook_master=None, _run_hooks=True):
1465
"""See Branch.push.
1466
1467
:param _hook_master: Private parameter - set the branch to
1468
be supplied as the master to push hooks.
1469
:param _run_hooks: Private parameter - allow disabling of
1470
hooks, used when pushing to a master branch.
1471
"""
1472
result = PushResult()
1473
result.source_branch = self
1474
result.target_branch = target
1475
target.lock_write()
1476
try:
1477
result.old_revno, result.old_revid = target.last_revision_info()
1478
try:
1479
target.update_revisions(self, stop_revision)
1480
except DivergedBranches:
1481
if not overwrite:
1482
raise
1483
if overwrite:
1484
target.set_revision_history(self.revision_history())
1485
result.tag_conflicts = self.tags.merge_to(target.tags)
1486
result.new_revno, result.new_revid = target.last_revision_info()
1487
if _hook_master:
1488
result.master_branch = _hook_master
1489
result.local_branch = target
1490
else:
1491
result.master_branch = target
1492
result.local_branch = None
1493
if _run_hooks:
1494
for hook in Branch.hooks['post_push']:
1495
hook(result)
1496
finally:
1497
target.unlock()
1498
return result
1499
1500
def get_parent(self):
1501
"""See Branch.get_parent."""
1502
1503
assert self.base[-1] == '/'
1504
parent = self._get_parent_location()
1505
if parent is None:
1506
return parent
1507
# This is an old-format absolute path to a local branch
1508
# turn it into a url
1509
if parent.startswith('/'):
1510
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1511
try:
1512
return urlutils.join(self.base[:-1], parent)
1513
except errors.InvalidURLJoin, e:
1514
raise errors.InaccessibleParent(parent, self.base)
1515
1516
def get_push_location(self):
1517
"""See Branch.get_push_location."""
1518
push_loc = self.get_config().get_user_option('push_location')
1519
return push_loc
1520
1521
def set_push_location(self, location):
1522
"""See Branch.set_push_location."""
1523
self.get_config().set_user_option(
1524
'push_location', location,
1525
store=_mod_config.STORE_LOCATION_NORECURSE)
1526
1527
@needs_write_lock
1528
def set_parent(self, url):
1529
"""See Branch.set_parent."""
1530
# TODO: Maybe delete old location files?
1531
# URLs should never be unicode, even on the local fs,
1532
# FIXUP this and get_parent in a future branch format bump:
1533
# read and rewrite the file, and have the new format code read
1534
# using .get not .get_utf8. RBC 20060125
1535
if url is not None:
1536
if isinstance(url, unicode):
1537
try:
1538
url = url.encode('ascii')
1539
except UnicodeEncodeError:
1540
raise bzrlib.errors.InvalidURL(url,
1541
"Urls must be 7-bit ascii, "
1542
"use bzrlib.urlutils.escape")
1543
url = urlutils.relative_url(self.base, url)
1544
self._set_parent_location(url)
1545
1546
def _set_parent_location(self, url):
1547
if url is None:
1548
self.control_files._transport.delete('parent')
1549
else:
1550
assert isinstance(url, str)
1551
self.control_files.put_bytes('parent', url + '\n')
1552
1553
@deprecated_function(zero_nine)
1554
def tree_config(self):
1555
"""DEPRECATED; call get_config instead.
1556
TreeConfig has become part of BranchConfig."""
1557
return TreeConfig(self)
1558
1559
1560
class BzrBranch5(BzrBranch):
1561
"""A format 5 branch. This supports new features over plan branches.
1562
1563
It has support for a master_branch which is the data for bound branches.
1564
"""
1565
1566
def __init__(self,
1567
_format,
1568
_control_files,
1569
a_bzrdir,
1570
_repository):
1571
super(BzrBranch5, self).__init__(_format=_format,
1572
_control_files=_control_files,
1573
a_bzrdir=a_bzrdir,
1574
_repository=_repository)
1575
1576
@needs_write_lock
1577
def pull(self, source, overwrite=False, stop_revision=None,
1578
_run_hooks=True):
1579
"""Extends branch.pull to be bound branch aware.
1580
1581
:param _run_hooks: Private parameter used to force hook running
1582
off during bound branch double-pushing.
1583
"""
1584
bound_location = self.get_bound_location()
1585
master_branch = None
1586
if bound_location and source.base != bound_location:
1587
# not pulling from master, so we need to update master.
1588
master_branch = self.get_master_branch()
1589
master_branch.lock_write()
1590
try:
1591
if master_branch:
1592
# pull from source into master.
1593
master_branch.pull(source, overwrite, stop_revision,
1594
_run_hooks=False)
1595
return super(BzrBranch5, self).pull(source, overwrite,
1596
stop_revision, _hook_master=master_branch,
1597
_run_hooks=_run_hooks)
1598
finally:
1599
if master_branch:
1600
master_branch.unlock()
1601
1602
@needs_read_lock
1603
def push(self, target, overwrite=False, stop_revision=None):
1604
"""Updates branch.push to be bound branch aware."""
1605
bound_location = target.get_bound_location()
1606
master_branch = None
1607
if bound_location and target.base != bound_location:
1608
# not pushing to master, so we need to update master.
1609
master_branch = target.get_master_branch()
1610
master_branch.lock_write()
1611
try:
1612
if master_branch:
1613
# push into the master from this branch.
1614
super(BzrBranch5, self).push(master_branch, overwrite,
1615
stop_revision, _run_hooks=False)
1616
# and push into the target branch from this. Note that we push from
1617
# this branch again, because its considered the highest bandwidth
1618
# repository.
1619
return super(BzrBranch5, self).push(target, overwrite,
1620
stop_revision, _hook_master=master_branch)
1621
finally:
1622
if master_branch:
1623
master_branch.unlock()
1624
1625
def get_bound_location(self):
1626
try:
1627
return self.control_files.get_utf8('bound').read()[:-1]
1628
except errors.NoSuchFile:
1629
return None
1630
1631
@needs_read_lock
1632
def get_master_branch(self):
1633
"""Return the branch we are bound to.
1634
1635
:return: Either a Branch, or None
1636
1637
This could memoise the branch, but if thats done
1638
it must be revalidated on each new lock.
1639
So for now we just don't memoise it.
1640
# RBC 20060304 review this decision.
1641
"""
1642
bound_loc = self.get_bound_location()
1643
if not bound_loc:
1644
return None
1645
try:
1646
return Branch.open(bound_loc)
1647
except (errors.NotBranchError, errors.ConnectionError), e:
1648
raise errors.BoundBranchConnectionFailure(
1649
self, bound_loc, e)
1650
1651
@needs_write_lock
1652
def set_bound_location(self, location):
1653
"""Set the target where this branch is bound to.
1654
1655
:param location: URL to the target branch
1656
"""
1657
if location:
1658
self.control_files.put_utf8('bound', location+'\n')
1659
else:
1660
try:
1661
self.control_files._transport.delete('bound')
1662
except NoSuchFile:
1663
return False
1348
1664
return True
1349
if filename == head:
1350
break
1351
filename = head
1352
return False
1353
1354
1355
1356
def gen_file_id(name):
1357
"""Return new file id.
1358
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1361
slow."""
1362
import re
1363
from binascii import hexlify
1364
from time import time
1365
1366
# get last component
1367
idx = name.rfind('/')
1368
if idx != -1:
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1371
if idx != -1:
1372
name = name[idx+1 : ]
1373
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1376
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1380
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1383
1384
1385
def gen_root_id():
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
1388
1665
1666
@needs_write_lock
1667
def bind(self, other):
1668
"""Bind this branch to the branch other.
1669
1670
This does not push or pull data between the branches, though it does
1671
check for divergence to raise an error when the branches are not
1672
either the same, or one a prefix of the other. That behaviour may not
1673
be useful, so that check may be removed in future.
1674
1675
:param other: The branch to bind to
1676
:type other: Branch
1677
"""
1678
# TODO: jam 20051230 Consider checking if the target is bound
1679
# It is debatable whether you should be able to bind to
1680
# a branch which is itself bound.
1681
# Committing is obviously forbidden,
1682
# but binding itself may not be.
1683
# Since we *have* to check at commit time, we don't
1684
# *need* to check here
1685
1686
# we want to raise diverged if:
1687
# last_rev is not in the other_last_rev history, AND
1688
# other_last_rev is not in our history, and do it without pulling
1689
# history around
1690
last_rev = self.last_revision()
1691
if last_rev is not None:
1692
other.lock_read()
1693
try:
1694
other_last_rev = other.last_revision()
1695
if other_last_rev is not None:
1696
# neither branch is new, we have to do some work to
1697
# ascertain diversion.
1698
remote_graph = other.repository.get_revision_graph(
1699
other_last_rev)
1700
local_graph = self.repository.get_revision_graph(last_rev)
1701
if (last_rev not in remote_graph and
1702
other_last_rev not in local_graph):
1703
raise errors.DivergedBranches(self, other)
1704
finally:
1705
other.unlock()
1706
self.set_bound_location(other.base)
1707
1708
@needs_write_lock
1709
def unbind(self):
1710
"""If bound, unbind"""
1711
return self.set_bound_location(None)
1712
1713
@needs_write_lock
1714
def update(self):
1715
"""Synchronise this branch with the master branch if any.
1716
1717
:return: None or the last_revision that was pivoted out during the
1718
update.
1719
"""
1720
master = self.get_master_branch()
1721
if master is not None:
1722
old_tip = self.last_revision()
1723
self.pull(master, overwrite=True)
1724
if old_tip in self.repository.get_ancestry(self.last_revision()):
1725
return None
1726
return old_tip
1727
return None
1728
1729
1730
class BzrBranchExperimental(BzrBranch5):
1731
"""Bzr experimental branch format
1732
1733
This format has:
1734
- a revision-history file.
1735
- a format string
1736
- a lock dir guarding the branch itself
1737
- all of this stored in a branch/ subdirectory
1738
- works with shared repositories.
1739
- a tag dictionary in the branch
1740
1741
This format is new in bzr 0.15, but shouldn't be used for real data,
1742
only for testing.
1743
1744
This class acts as it's own BranchFormat.
1745
"""
1746
1747
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1748
1749
@classmethod
1750
def get_format_string(cls):
1751
"""See BranchFormat.get_format_string()."""
1752
return "Bazaar-NG branch format experimental\n"
1753
1754
@classmethod
1755
def get_format_description(cls):
1756
"""See BranchFormat.get_format_description()."""
1757
return "Experimental branch format"
1758
1759
@classmethod
1760
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1761
lock_class):
1762
branch_transport = a_bzrdir.get_branch_transport(cls)
1763
control_files = lockable_files.LockableFiles(branch_transport,
1764
lock_filename, lock_class)
1765
control_files.create_lock()
1766
control_files.lock_write()
1767
try:
1768
for filename, content in utf8_files:
1769
control_files.put_utf8(filename, content)
1770
finally:
1771
control_files.unlock()
1772
1773
@classmethod
1774
def initialize(cls, a_bzrdir):
1775
"""Create a branch of this format in a_bzrdir."""
1776
utf8_files = [('format', cls.get_format_string()),
1777
('revision-history', ''),
1778
('branch-name', ''),
1779
('tags', ''),
1780
]
1781
cls._initialize_control_files(a_bzrdir, utf8_files,
1782
'lock', lockdir.LockDir)
1783
return cls.open(a_bzrdir, _found=True)
1784
1785
@classmethod
1786
def open(cls, a_bzrdir, _found=False):
1787
"""Return the branch object for a_bzrdir
1788
1789
_found is a private parameter, do not use it. It is used to indicate
1790
if format probing has already be done.
1791
"""
1792
if not _found:
1793
format = BranchFormat.find_format(a_bzrdir)
1794
assert format.__class__ == cls
1795
transport = a_bzrdir.get_branch_transport(None)
1796
control_files = lockable_files.LockableFiles(transport, 'lock',
1797
lockdir.LockDir)
1798
return cls(_format=cls,
1799
_control_files=control_files,
1800
a_bzrdir=a_bzrdir,
1801
_repository=a_bzrdir.find_repository())
1802
1803
@classmethod
1804
def is_supported(cls):
1805
return True
1806
1807
def _make_tags(self):
1808
return BasicTags(self)
1809
1810
@classmethod
1811
def supports_tags(cls):
1812
return True
1813
1814
1815
BranchFormat.register_format(BzrBranchExperimental)
1816
1817
1818
class BzrBranch6(BzrBranch5):
1819
1820
@needs_read_lock
1821
def last_revision_info(self):
1822
revision_string = self.control_files.get('last-revision').read()
1823
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1824
revision_id = cache_utf8.get_cached_utf8(revision_id)
1825
revno = int(revno)
1826
return revno, revision_id
1827
1828
def last_revision(self):
1829
"""Return last revision id, or None"""
1830
revision_id = self.last_revision_info()[1]
1831
if revision_id == _mod_revision.NULL_REVISION:
1832
revision_id = None
1833
return revision_id
1834
1835
def _write_last_revision_info(self, revno, revision_id):
1836
"""Simply write out the revision id, with no checks.
1837
1838
Use set_last_revision_info to perform this safely.
1839
1840
Does not update the revision_history cache.
1841
Intended to be called by set_last_revision_info and
1842
_write_revision_history.
1843
"""
1844
if revision_id is None:
1845
revision_id = 'null:'
1846
out_string = '%d %s\n' % (revno, revision_id)
1847
self.control_files.put_bytes('last-revision', out_string)
1848
1849
@needs_write_lock
1850
def set_last_revision_info(self, revno, revision_id):
1851
revision_id = osutils.safe_revision_id(revision_id)
1852
if self._get_append_revisions_only():
1853
self._check_history_violation(revision_id)
1854
self._write_last_revision_info(revno, revision_id)
1855
self._clear_cached_state()
1856
1857
def _check_history_violation(self, revision_id):
1858
last_revision = self.last_revision()
1859
if last_revision is None:
1860
return
1861
if last_revision not in self._lefthand_history(revision_id):
1862
raise errors.AppendRevisionsOnlyViolation(self.base)
1863
1864
def _gen_revision_history(self):
1865
"""Generate the revision history from last revision
1866
"""
1867
history = list(self.repository.iter_reverse_revision_history(
1868
self.last_revision()))
1869
history.reverse()
1870
return history
1871
1872
def _write_revision_history(self, history):
1873
"""Factored out of set_revision_history.
1874
1875
This performs the actual writing to disk, with format-specific checks.
1876
It is intended to be called by BzrBranch5.set_revision_history.
1877
"""
1878
if len(history) == 0:
1879
last_revision = 'null:'
1880
else:
1881
if history != self._lefthand_history(history[-1]):
1882
raise errors.NotLefthandHistory(history)
1883
last_revision = history[-1]
1884
if self._get_append_revisions_only():
1885
self._check_history_violation(last_revision)
1886
self._write_last_revision_info(len(history), last_revision)
1887
1888
@needs_write_lock
1889
def append_revision(self, *revision_ids):
1890
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1891
if len(revision_ids) == 0:
1892
return
1893
prev_revno, prev_revision = self.last_revision_info()
1894
for revision in self.repository.get_revisions(revision_ids):
1895
if prev_revision == _mod_revision.NULL_REVISION:
1896
if revision.parent_ids != []:
1897
raise errors.NotLeftParentDescendant(self, prev_revision,
1898
revision.revision_id)
1899
else:
1900
if revision.parent_ids[0] != prev_revision:
1901
raise errors.NotLeftParentDescendant(self, prev_revision,
1902
revision.revision_id)
1903
prev_revision = revision.revision_id
1904
self.set_last_revision_info(prev_revno + len(revision_ids),
1905
revision_ids[-1])
1906
1907
@needs_write_lock
1908
def _set_parent_location(self, url):
1909
"""Set the parent branch"""
1910
self._set_config_location('parent_location', url, make_relative=True)
1911
1912
@needs_read_lock
1913
def _get_parent_location(self):
1914
"""Set the parent branch"""
1915
return self._get_config_location('parent_location')
1916
1917
def set_push_location(self, location):
1918
"""See Branch.set_push_location."""
1919
self._set_config_location('push_location', location)
1920
1921
def set_bound_location(self, location):
1922
"""See Branch.set_push_location."""
1923
result = None
1924
config = self.get_config()
1925
if location is None:
1926
if config.get_user_option('bound') != 'True':
1927
return False
1928
else:
1929
config.set_user_option('bound', 'False')
1930
return True
1931
else:
1932
self._set_config_location('bound_location', location,
1933
config=config)
1934
config.set_user_option('bound', 'True')
1935
return True
1936
1937
def _get_bound_location(self, bound):
1938
"""Return the bound location in the config file.
1939
1940
Return None if the bound parameter does not match"""
1941
config = self.get_config()
1942
config_bound = (config.get_user_option('bound') == 'True')
1943
if config_bound != bound:
1944
return None
1945
return self._get_config_location('bound_location', config=config)
1946
1947
def get_bound_location(self):
1948
"""See Branch.set_push_location."""
1949
return self._get_bound_location(True)
1950
1951
def get_old_bound_location(self):
1952
"""See Branch.get_old_bound_location"""
1953
return self._get_bound_location(False)
1954
1955
def set_append_revisions_only(self, enabled):
1956
if enabled:
1957
value = 'True'
1958
else:
1959
value = 'False'
1960
self.get_config().set_user_option('append_revisions_only', value)
1961
1962
def _get_append_revisions_only(self):
1963
value = self.get_config().get_user_option('append_revisions_only')
1964
return value == 'True'
1965
1966
def _synchronize_history(self, destination, revision_id):
1967
"""Synchronize last revision and revision history between branches.
1968
1969
This version is most efficient when the destination is also a
1970
BzrBranch6, but works for BzrBranch5, as long as the destination's
1971
repository contains all the lefthand ancestors of the intended
1972
last_revision. If not, set_last_revision_info will fail.
1973
1974
:param destination: The branch to copy the history into
1975
:param revision_id: The revision-id to truncate history at. May
1976
be None to copy complete history.
1977
"""
1978
if revision_id is None:
1979
revno, revision_id = self.last_revision_info()
1980
else:
1981
revno = self.revision_id_to_revno(revision_id)
1982
destination.set_last_revision_info(revno, revision_id)
1983
1984
def _make_tags(self):
1985
return BasicTags(self)
1986
1987
1988
class BranchTestProviderAdapter(object):
1989
"""A tool to generate a suite testing multiple branch formats at once.
1990
1991
This is done by copying the test once for each transport and injecting
1992
the transport_server, transport_readonly_server, and branch_format
1993
classes into each copy. Each copy is also given a new id() to make it
1994
easy to identify.
1995
"""
1996
1997
def __init__(self, transport_server, transport_readonly_server, formats):
1998
self._transport_server = transport_server
1999
self._transport_readonly_server = transport_readonly_server
2000
self._formats = formats
2001
2002
def adapt(self, test):
2003
result = TestSuite()
2004
for branch_format, bzrdir_format in self._formats:
2005
new_test = deepcopy(test)
2006
new_test.transport_server = self._transport_server
2007
new_test.transport_readonly_server = self._transport_readonly_server
2008
new_test.bzrdir_format = bzrdir_format
2009
new_test.branch_format = branch_format
2010
def make_new_test_id():
2011
# the format can be either a class or an instance
2012
name = getattr(branch_format, '__name__',
2013
branch_format.__class__.__name__)
2014
new_id = "%s(%s)" % (new_test.id(), name)
2015
return lambda: new_id
2016
new_test.id = make_new_test_id()
2017
result.addTest(new_test)
2018
return result
2019
2020
2021
######################################################################
2022
# results of operations
2023
2024
2025
class _Result(object):
2026
2027
def _show_tag_conficts(self, to_file):
2028
if not getattr(self, 'tag_conflicts', None):
2029
return
2030
to_file.write('Conflicting tags:\n')
2031
for name, value1, value2 in self.tag_conflicts:
2032
to_file.write(' %s\n' % (name, ))
2033
2034
2035
class PullResult(_Result):
2036
"""Result of a Branch.pull operation.
2037
2038
:ivar old_revno: Revision number before pull.
2039
:ivar new_revno: Revision number after pull.
2040
:ivar old_revid: Tip revision id before pull.
2041
:ivar new_revid: Tip revision id after pull.
2042
:ivar source_branch: Source (local) branch object.
2043
:ivar master_branch: Master branch of the target, or None.
2044
:ivar target_branch: Target/destination branch object.
2045
"""
2046
2047
def __int__(self):
2048
# DEPRECATED: pull used to return the change in revno
2049
return self.new_revno - self.old_revno
2050
2051
def report(self, to_file):
2052
if self.old_revid == self.new_revid:
2053
to_file.write('No revisions to pull.\n')
2054
else:
2055
to_file.write('Now on revision %d.\n' % self.new_revno)
2056
self._show_tag_conficts(to_file)
2057
2058
2059
class PushResult(_Result):
2060
"""Result of a Branch.push operation.
2061
2062
:ivar old_revno: Revision number before push.
2063
:ivar new_revno: Revision number after push.
2064
:ivar old_revid: Tip revision id before push.
2065
:ivar new_revid: Tip revision id after push.
2066
:ivar source_branch: Source branch object.
2067
:ivar master_branch: Master branch of the target, or None.
2068
:ivar target_branch: Target/destination branch object.
2069
"""
2070
2071
def __int__(self):
2072
# DEPRECATED: push used to return the change in revno
2073
return self.new_revno - self.old_revno
2074
2075
def report(self, to_file):
2076
"""Write a human-readable description of the result."""
2077
if self.old_revid == self.new_revid:
2078
to_file.write('No new revisions to push.\n')
2079
else:
2080
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2081
self._show_tag_conficts(to_file)
2082
2083
2084
class BranchCheckResult(object):
2085
"""Results of checking branch consistency.
2086
2087
:see: Branch.check
2088
"""
2089
2090
def __init__(self, branch):
2091
self.branch = branch
2092
2093
def report_results(self, verbose):
2094
"""Report the check results via trace.note.
2095
2096
:param verbose: Requests more detailed display of what was checked,
2097
if any.
2098
"""
2099
note('checked branch %s format %s',
2100
self.branch.base,
2101
self.branch._format)
2102
2103
2104
class Converter5to6(object):
2105
"""Perform an in-place upgrade of format 5 to format 6"""
2106
2107
def convert(self, branch):
2108
# Data for 5 and 6 can peacefully coexist.
2109
format = BzrBranchFormat6()
2110
new_branch = format.open(branch.bzrdir, _found=True)
2111
2112
# Copy source data into target
2113
new_branch.set_last_revision_info(*branch.last_revision_info())
2114
new_branch.set_parent(branch.get_parent())
2115
new_branch.set_bound_location(branch.get_bound_location())
2116
new_branch.set_push_location(branch.get_push_location())
2117
2118
# New branch has no tags by default
2119
new_branch.tags._set_tag_dict({})
2120
2121
# Copying done; now update target format
2122
new_branch.control_files.put_utf8('format',
2123
format.get_format_string())
2124
2125
# Clean up old files
2126
new_branch.control_files._transport.delete('revision-history')
2127
try:
2128
branch.set_parent(None)
2129
except NoSuchFile:
2130
pass
2131
branch.set_bound_location(None)
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0