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