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