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