« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 383
- compare with another revision
- download diff
- download tarball
- view history from revision 383
- Committer: Martin Pool
- Date: 2005-05-05 09:57:17 UTC
- Revision ID: mbp@sourcefrog.net-20050505095717-d67cecd52a717a96
- Show file ids too for log --show-ids
- files added:
- bzrlib/cache.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, zero_nine,
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_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
60
68
61
69
62
70
######################################################################
63
71
# branch objects
64
72
65
class Branch(object):
73
class Branch:
66
74
"""Branch holding a history of revisions.
67
75
68
76
base
69
Base directory/url of the branch.
77
Base directory of the branch.
70
78
"""
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 branch rooted at base.
101
102
For instance, if the branch is at URL/.bzr/branch,
103
Branch.open(URL) -> a Branch instance.
104
"""
105
control = bzrdir.BzrDir.open(base, _unsupported)
106
return control.open_branch(_unsupported)
107
108
@staticmethod
109
def open_containing(url):
110
"""Open an existing branch which contains url.
111
112
This probes for a branch at url, and searches upwards from there.
113
114
Basically we keep looking up until we find the control directory or
115
run into the root. If there isn't one, raises NotBranchError.
116
If there is one and it is either an unrecognised format or an unsupported
117
format, UnknownFormatError or UnsupportedFormatError are raised.
118
If there is one, it is returned, along with the unused portion of url.
119
"""
120
control, relpath = bzrdir.BzrDir.open_containing(url)
121
return control.open_branch(), relpath
122
123
@staticmethod
124
@deprecated_function(zero_eight)
125
def initialize(base):
126
"""Create a new working tree and branch, rooted at 'base' (url)
127
128
NOTE: This will soon be deprecated in favour of creation
129
through a BzrDir.
130
"""
131
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
132
133
def setup_caching(self, cache_root):
134
"""Subclasses that care about caching should override this, and set
135
up cached stores located under cache_root.
136
"""
137
# seems to be unused, 2006-01-13 mbp
138
warn('%s is deprecated' % self.setup_caching)
139
self.cache_root = cache_root
140
141
def get_config(self):
142
return bzrlib.config.BranchConfig(self)
143
144
def _get_nick(self):
145
return self.get_config().get_nickname()
146
147
def _set_nick(self, nick):
148
self.get_config().set_user_option('nickname', nick)
149
150
nick = property(_get_nick, _set_nick)
151
152
def is_locked(self):
153
raise NotImplementedError('is_locked is abstract')
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')
170
171
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
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)
204
101
else:
205
nested_pb = None
206
207
from_branch.lock_read()
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."""
208
125
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]
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)
214
144
else:
215
# no history in the source branch
216
last_revision = revision.NULL_REVISION
217
return self.repository.fetch(from_branch.repository,
218
revision_id=last_revision,
219
pb=nested_pb)
220
finally:
221
if nested_pb is not None:
222
nested_pb.finished()
223
from_branch.unlock()
224
225
def get_bound_location(self):
226
"""Return the URL of the branch we are bound to.
227
228
Older format branches cannot bind, please be sure to use a metadir
229
branch.
230
"""
231
return None
232
233
def get_commit_builder(self, parents, config=None, timestamp=None,
234
timezone=None, committer=None, revprops=None,
235
revision_id=None):
236
"""Obtain a CommitBuilder for this branch.
237
238
:param parents: Revision ids of the parents of the new revision.
239
:param config: Optional configuration to use.
240
:param timestamp: Optional timestamp recorded for commit.
241
:param timezone: Optional timezone for timestamp.
242
:param committer: Optional committer to set for commit.
243
:param revprops: Optional dictionary of revision properties.
244
:param revision_id: Optional revision id.
245
"""
246
247
if config is None:
248
config = self.get_config()
249
250
return self.repository.get_commit_builder(self, parents, config,
251
timestamp, timezone, committer, revprops, revision_id)
252
253
def get_master_branch(self):
254
"""Return the branch we are bound to.
255
256
:return: Either a Branch, or None
257
"""
258
return None
259
260
def get_revision_delta(self, revno):
261
"""Return the delta for one revision.
262
263
The delta is relative to its mainline predecessor, or the
264
empty tree for revision 1.
265
"""
266
assert isinstance(revno, int)
267
rh = self.revision_history()
268
if not (1 <= revno <= len(rh)):
269
raise InvalidRevisionNumber(revno)
270
return self.repository.get_revision_delta(rh[revno-1])
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):
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):
277
373
"""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')
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
285
683
286
684
def revision_history(self):
287
"""Return sequence of revision hashes on to this branch."""
288
raise NotImplementedError('revision_history is abstract')
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
289
693
290
694
def revno(self):
291
695
"""Return current revision number for this branch.
292
696
293
697
That is equivalent to the number of revisions committed to
294
698
this branch.
699
700
>>> b = ScratchBranch()
701
>>> b.revno()
702
0
703
>>> b.commit('no foo')
704
>>> b.revno()
705
1
295
706
"""
296
707
return len(self.revision_history())
297
708
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."""
709
710
def last_patch(self):
711
"""Return last patch hash, or None if no history.
712
713
>>> ScratchBranch().last_patch() == None
714
True
715
"""
304
716
ph = self.revision_history()
305
717
if ph:
306
718
return ph[-1]
307
719
else:
308
720
return None
309
310
def missing_revisions(self, other, stop_revision=None):
311
"""Return a list of new revisions that would perfectly fit.
312
721
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."""
722
723
def lookup_revision(self, revno):
724
"""Return revision hash for revision number."""
354
725
if revno == 0:
355
726
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')
727
728
try:
729
# list is 0-based; revisions are 1-based
730
return self.revision_history()[revno-1]
731
except IndexError:
732
raise BzrError("no such revision %s" % revno)
733
734
735
def revision_tree(self, revision_id):
736
"""Return Tree for a revision on this branch.
737
738
`revision_id` may be None for the null revision, in which case
739
an `EmptyTree` is returned."""
740
self._need_readlock()
741
if revision_id == None:
742
return EmptyTree()
743
else:
744
inv = self.get_revision_inventory(revision_id)
745
return RevisionTree(self.text_store, inv)
746
747
748
def working_tree(self):
749
"""Return a `Tree` for the working copy."""
750
return WorkingTree(self.base, self.read_working_inventory())
751
364
752
365
753
def basis_tree(self):
366
754
"""Return `Tree` object for last revision.
367
755
368
756
If there are no revisions yet, return an `EmptyTree`.
757
758
>>> b = ScratchBranch(files=['foo'])
759
>>> b.basis_tree().has_filename('foo')
760
False
761
>>> b.working_tree().has_filename('foo')
762
True
763
>>> b.add('foo')
764
>>> b.commit('add foo')
765
>>> b.basis_tree().has_filename('foo')
766
True
369
767
"""
370
return self.repository.revision_tree(self.last_revision())
768
r = self.last_patch()
769
if r == None:
770
return EmptyTree()
771
else:
772
return RevisionTree(self.text_store, self.get_revision_inventory(r))
773
774
371
775
372
776
def rename_one(self, from_rel, to_rel):
373
777
"""Rename one file.
374
778
375
779
This can change the directory or the filename or both.
376
780
"""
377
raise NotImplementedError('rename_one is abstract')
781
self._need_writelock()
782
tree = self.working_tree()
783
inv = tree.inventory
784
if not tree.has_filename(from_rel):
785
bailout("can't rename: old working file %r does not exist" % from_rel)
786
if tree.has_filename(to_rel):
787
bailout("can't rename: new working file %r already exists" % to_rel)
788
789
file_id = inv.path2id(from_rel)
790
if file_id == None:
791
bailout("can't rename: old name %r is not versioned" % from_rel)
792
793
if inv.path2id(to_rel):
794
bailout("can't rename: new name %r is already versioned" % to_rel)
795
796
to_dir, to_tail = os.path.split(to_rel)
797
to_dir_id = inv.path2id(to_dir)
798
if to_dir_id == None and to_dir != '':
799
bailout("can't determine destination directory id for %r" % to_dir)
800
801
mutter("rename_one:")
802
mutter(" file_id {%s}" % file_id)
803
mutter(" from_rel %r" % from_rel)
804
mutter(" to_rel %r" % to_rel)
805
mutter(" to_dir %r" % to_dir)
806
mutter(" to_dir_id {%s}" % to_dir_id)
807
808
inv.rename(file_id, to_dir_id, to_tail)
809
810
print "%s => %s" % (from_rel, to_rel)
811
812
from_abs = self.abspath(from_rel)
813
to_abs = self.abspath(to_rel)
814
try:
815
os.rename(from_abs, to_abs)
816
except OSError, e:
817
bailout("failed to rename %r to %r: %s"
818
% (from_abs, to_abs, e[1]),
819
["rename rolled back"])
820
821
self._write_inventory(inv)
822
823
378
824
379
825
def move(self, from_paths, to_name):
380
826
"""Rename files.
386
832
387
833
Note that to_name is only the last component of the new name;
388
834
this doesn't change the directory.
389
390
This returns a list of (from_path, to_path) pairs for each
391
entry that is moved.
392
"""
393
raise NotImplementedError('move is abstract')
394
395
def get_parent(self):
396
"""Return the parent location of the branch.
397
398
This is the default location for push/pull/missing. The usual
399
pattern is that the user can override it by specifying a
400
location.
401
"""
402
raise NotImplementedError('get_parent is abstract')
403
404
def get_submit_branch(self):
405
"""Return the submit location of the branch.
406
407
This is the default location for bundle. The usual
408
pattern is that the user can override it by specifying a
409
location.
410
"""
411
return self.get_config().get_user_option('submit_branch')
412
413
def set_submit_branch(self, location):
414
"""Return the submit location of the branch.
415
416
This is the default location for bundle. The usual
417
pattern is that the user can override it by specifying a
418
location.
419
"""
420
self.get_config().set_user_option('submit_branch', location)
421
422
def get_push_location(self):
423
"""Return the None or the location to push this branch to."""
424
raise NotImplementedError('get_push_location is abstract')
425
426
def set_push_location(self, location):
427
"""Set a new push location for this branch."""
428
raise NotImplementedError('set_push_location is abstract')
429
430
def set_parent(self, url):
431
raise NotImplementedError('set_parent is abstract')
432
433
@needs_write_lock
434
def update(self):
435
"""Synchronise this branch with the master branch if any.
436
437
:return: None or the last_revision pivoted out during the update.
438
"""
439
return None
440
441
def check_revno(self, revno):
442
"""\
443
Check whether a revno corresponds to any revision.
444
Zero (the NULL revision) is considered valid.
445
"""
446
if revno != 0:
447
self.check_real_revno(revno)
835
"""
836
self._need_writelock()
837
## TODO: Option to move IDs only
838
assert not isinstance(from_paths, basestring)
839
tree = self.working_tree()
840
inv = tree.inventory
841
to_abs = self.abspath(to_name)
842
if not isdir(to_abs):
843
bailout("destination %r is not a directory" % to_abs)
844
if not tree.has_filename(to_name):
845
bailout("destination %r not in working directory" % to_abs)
846
to_dir_id = inv.path2id(to_name)
847
if to_dir_id == None and to_name != '':
848
bailout("destination %r is not a versioned directory" % to_name)
849
to_dir_ie = inv[to_dir_id]
850
if to_dir_ie.kind not in ('directory', 'root_directory'):
851
bailout("destination %r is not a directory" % to_abs)
852
853
to_idpath = Set(inv.get_idpath(to_dir_id))
854
855
for f in from_paths:
856
if not tree.has_filename(f):
857
bailout("%r does not exist in working tree" % f)
858
f_id = inv.path2id(f)
859
if f_id == None:
860
bailout("%r is not versioned" % f)
861
name_tail = splitpath(f)[-1]
862
dest_path = appendpath(to_name, name_tail)
863
if tree.has_filename(dest_path):
864
bailout("destination %r already exists" % dest_path)
865
if f_id in to_idpath:
866
bailout("can't move %r to a subdirectory of itself" % f)
867
868
# OK, so there's a race here, it's possible that someone will
869
# create a file in this interval and then the rename might be
870
# left half-done. But we should have caught most problems.
871
872
for f in from_paths:
873
name_tail = splitpath(f)[-1]
874
dest_path = appendpath(to_name, name_tail)
875
print "%s => %s" % (f, dest_path)
876
inv.rename(inv.path2id(f), to_dir_id, name_tail)
877
try:
878
os.rename(self.abspath(f), self.abspath(dest_path))
879
except OSError, e:
880
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
881
["rename rolled back"])
882
883
self._write_inventory(inv)
884
885
886
887
def show_status(self, show_all=False):
888
"""Display single-line status for non-ignored working files.
889
890
The list is show sorted in order by file name.
891
892
>>> b = ScratchBranch(files=['foo', 'foo~'])
893
>>> b.show_status()
894
? foo
895
>>> b.add('foo')
896
>>> b.show_status()
897
A foo
898
>>> b.commit("add foo")
899
>>> b.show_status()
900
>>> os.unlink(b.abspath('foo'))
901
>>> b.show_status()
902
D foo
903
904
TODO: Get state for single files.
905
"""
906
self._need_readlock()
907
908
# We have to build everything into a list first so that it can
909
# sorted by name, incorporating all the different sources.
910
911
# FIXME: Rather than getting things in random order and then sorting,
912
# just step through in order.
913
914
# Interesting case: the old ID for a file has been removed,
915
# but a new file has been created under that name.
916
917
old = self.basis_tree()
918
new = self.working_tree()
919
920
for fs, fid, oldname, newname, kind in diff_trees(old, new):
921
if fs == 'R':
922
show_status(fs, kind,
923
oldname + ' => ' + newname)
924
elif fs == 'A' or fs == 'M':
925
show_status(fs, kind, newname)
926
elif fs == 'D':
927
show_status(fs, kind, oldname)
928
elif fs == '.':
929
if show_all:
930
show_status(fs, kind, newname)
931
elif fs == 'I':
932
if show_all:
933
show_status(fs, kind, newname)
934
elif fs == '?':
935
show_status(fs, kind, newname)
936
else:
937
bailout("weird file state %r" % ((fs, fid),))
938
939
940
941
class ScratchBranch(Branch):
942
"""Special test class: a branch that cleans up after itself.
943
944
>>> b = ScratchBranch()
945
>>> isdir(b.base)
946
True
947
>>> bd = b.base
948
>>> del b
949
>>> isdir(bd)
950
False
951
"""
952
def __init__(self, files=[], dirs=[]):
953
"""Make a test branch.
954
955
This creates a temporary directory and runs init-tree in it.
956
957
If any files are listed, they are created in the working copy.
958
"""
959
Branch.__init__(self, tempfile.mkdtemp(), init=True)
960
for d in dirs:
961
os.mkdir(self.abspath(d))
448
962
449
def check_real_revno(self, revno):
450
"""\
451
Check whether a revno corresponds to a real revision.
452
Zero (the NULL revision) is considered invalid
453
"""
454
if revno < 1 or revno > self.revno():
455
raise InvalidRevisionNumber(revno)
456
457
@needs_read_lock
458
def clone(self, *args, **kwargs):
459
"""Clone this branch into to_bzrdir preserving all semantic values.
460
461
revision_id: if not None, the revision history in the new branch will
462
be truncated to end with revision_id.
463
"""
464
# for API compatibility, until 0.8 releases we provide the old api:
465
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
466
# after 0.8 releases, the *args and **kwargs should be changed:
467
# def clone(self, to_bzrdir, revision_id=None):
468
if (kwargs.get('to_location', None) or
469
kwargs.get('revision', None) or
470
kwargs.get('basis_branch', None) or
471
(len(args) and isinstance(args[0], basestring))):
472
# backwards compatibility api:
473
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
474
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
475
# get basis_branch
476
if len(args) > 2:
477
basis_branch = args[2]
478
else:
479
basis_branch = kwargs.get('basis_branch', None)
480
if basis_branch:
481
basis = basis_branch.bzrdir
482
else:
483
basis = None
484
# get revision
485
if len(args) > 1:
486
revision_id = args[1]
487
else:
488
revision_id = kwargs.get('revision', None)
489
# get location
490
if len(args):
491
url = args[0]
492
else:
493
# no default to raise if not provided.
494
url = kwargs.get('to_location')
495
return self.bzrdir.clone(url,
496
revision_id=revision_id,
497
basis=basis).open_branch()
498
# new cleaner api.
499
# generate args by hand
500
if len(args) > 1:
501
revision_id = args[1]
502
else:
503
revision_id = kwargs.get('revision_id', None)
504
if len(args):
505
to_bzrdir = args[0]
506
else:
507
# no default to raise if not provided.
508
to_bzrdir = kwargs.get('to_bzrdir')
509
result = self._format.initialize(to_bzrdir)
510
self.copy_content_into(result, revision_id=revision_id)
511
return result
512
513
@needs_read_lock
514
def sprout(self, to_bzrdir, revision_id=None):
515
"""Create a new line of development from the branch, into to_bzrdir.
516
517
revision_id: if not None, the revision history in the new branch will
518
be truncated to end with revision_id.
519
"""
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id=revision_id)
522
result.set_parent(self.bzrdir.root_transport.base)
523
return result
524
525
@needs_read_lock
526
def copy_content_into(self, destination, revision_id=None):
527
"""Copy the content of self into destination.
528
529
revision_id: if not None, the revision history in the new branch will
530
be truncated to end with revision_id.
531
"""
532
new_history = self.revision_history()
533
if revision_id is not None:
534
try:
535
new_history = new_history[:new_history.index(revision_id) + 1]
536
except ValueError:
537
rev = self.repository.get_revision(revision_id)
538
new_history = rev.get_history(self.repository)[1:]
539
destination.set_revision_history(new_history)
540
parent = self.get_parent()
541
if parent:
542
destination.set_parent(parent)
543
544
@needs_read_lock
545
def check(self):
546
"""Check consistency of the branch.
547
548
In particular this checks that revisions given in the revision-history
549
do actually match up in the revision graph, and that they're all
550
present in the repository.
551
552
Callers will typically also want to check the repository.
553
554
:return: A BranchCheckResult.
555
"""
556
mainline_parent_id = None
557
for revision_id in self.revision_history():
558
try:
559
revision = self.repository.get_revision(revision_id)
560
except errors.NoSuchRevision, e:
561
raise errors.BzrCheckError("mainline revision {%s} not in repository"
562
% revision_id)
563
# In general the first entry on the revision history has no parents.
564
# But it's not illegal for it to have parents listed; this can happen
565
# in imports from Arch when the parents weren't reachable.
566
if mainline_parent_id is not None:
567
if mainline_parent_id not in revision.parent_ids:
568
raise errors.BzrCheckError("previous revision {%s} not listed among "
569
"parents of {%s}"
570
% (mainline_parent_id, revision_id))
571
mainline_parent_id = revision_id
572
return BranchCheckResult(self)
573
574
575
class BranchFormat(object):
576
"""An encapsulation of the initialization and open routines for a format.
577
578
Formats provide three things:
579
* An initialization routine,
580
* a format string,
581
* an open routine.
582
583
Formats are placed in an dict by their format string for reference
584
during branch opening. Its not required that these be instances, they
585
can be classes themselves with class methods - it simply depends on
586
whether state is needed for a given format or not.
587
588
Once a format is deprecated, just deprecate the initialize and open
589
methods on the format class. Do not deprecate the object, as the
590
object will be created every time regardless.
591
"""
592
593
_default_format = None
594
"""The default format used for new branches."""
595
596
_formats = {}
597
"""The known formats."""
598
599
@classmethod
600
def find_format(klass, a_bzrdir):
601
"""Return the format for the branch object in a_bzrdir."""
602
try:
603
transport = a_bzrdir.get_branch_transport(None)
604
format_string = transport.get("format").read()
605
return klass._formats[format_string]
606
except NoSuchFile:
607
raise NotBranchError(path=transport.base)
608
except KeyError:
609
raise errors.UnknownFormatError(format=format_string)
610
611
@classmethod
612
def get_default_format(klass):
613
"""Return the current default format."""
614
return klass._default_format
615
616
def get_format_string(self):
617
"""Return the ASCII format string that identifies this format."""
618
raise NotImplementedError(self.get_format_string)
619
620
def get_format_description(self):
621
"""Return the short format description for this format."""
622
raise NotImplementedError(self.get_format_string)
623
624
def initialize(self, a_bzrdir):
625
"""Create a branch of this format in a_bzrdir."""
626
raise NotImplementedError(self.initialize)
627
628
def is_supported(self):
629
"""Is this format supported?
630
631
Supported formats can be initialized and opened.
632
Unsupported formats may not support initialization or committing or
633
some other features depending on the reason for not being supported.
634
"""
635
return True
636
637
def open(self, a_bzrdir, _found=False):
638
"""Return the branch object for a_bzrdir
639
640
_found is a private parameter, do not use it. It is used to indicate
641
if format probing has already be done.
642
"""
643
raise NotImplementedError(self.open)
644
645
@classmethod
646
def register_format(klass, format):
647
klass._formats[format.get_format_string()] = format
648
649
@classmethod
650
def set_default_format(klass, format):
651
klass._default_format = format
652
653
@classmethod
654
def unregister_format(klass, format):
655
assert klass._formats[format.get_format_string()] is format
656
del klass._formats[format.get_format_string()]
657
658
def __str__(self):
659
return self.get_format_string().rstrip()
660
661
662
class BzrBranchFormat4(BranchFormat):
663
"""Bzr branch format 4.
664
665
This format has:
666
- a revision-history file.
667
- a branch-lock lock file [ to be shared with the bzrdir ]
668
"""
669
670
def get_format_description(self):
671
"""See BranchFormat.get_format_description()."""
672
return "Branch format 4"
673
674
def initialize(self, a_bzrdir):
675
"""Create a branch of this format in a_bzrdir."""
676
mutter('creating branch in %s', a_bzrdir.transport.base)
677
branch_transport = a_bzrdir.get_branch_transport(self)
678
utf8_files = [('revision-history', ''),
679
('branch-name', ''),
680
]
681
control_files = LockableFiles(branch_transport, 'branch-lock',
682
TransportLock)
683
control_files.create_lock()
684
control_files.lock_write()
685
try:
686
for file, content in utf8_files:
687
control_files.put_utf8(file, content)
688
finally:
689
control_files.unlock()
690
return self.open(a_bzrdir, _found=True)
691
692
def __init__(self):
693
super(BzrBranchFormat4, self).__init__()
694
self._matchingbzrdir = bzrdir.BzrDirFormat6()
695
696
def open(self, a_bzrdir, _found=False):
697
"""Return the branch object for a_bzrdir
698
699
_found is a private parameter, do not use it. It is used to indicate
700
if format probing has already be done.
701
"""
702
if not _found:
703
# we are being called directly and must probe.
704
raise NotImplementedError
705
return BzrBranch(_format=self,
706
_control_files=a_bzrdir._control_files,
707
a_bzrdir=a_bzrdir,
708
_repository=a_bzrdir.open_repository())
709
710
def __str__(self):
711
return "Bazaar-NG branch format 4"
712
713
714
class BzrBranchFormat5(BranchFormat):
715
"""Bzr branch format 5.
716
717
This format has:
718
- a revision-history file.
719
- a format string
720
- a lock dir guarding the branch itself
721
- all of this stored in a branch/ subdirectory
722
- works with shared repositories.
723
724
This format is new in bzr 0.8.
725
"""
726
727
def get_format_string(self):
728
"""See BranchFormat.get_format_string()."""
729
return "Bazaar-NG branch format 5\n"
730
731
def get_format_description(self):
732
"""See BranchFormat.get_format_description()."""
733
return "Branch format 5"
734
735
def initialize(self, a_bzrdir):
736
"""Create a branch of this format in a_bzrdir."""
737
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
738
branch_transport = a_bzrdir.get_branch_transport(self)
739
utf8_files = [('revision-history', ''),
740
('branch-name', ''),
741
]
742
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
743
control_files.create_lock()
744
control_files.lock_write()
745
control_files.put_utf8('format', self.get_format_string())
746
try:
747
for file, content in utf8_files:
748
control_files.put_utf8(file, content)
749
finally:
750
control_files.unlock()
751
return self.open(a_bzrdir, _found=True, )
752
753
def __init__(self):
754
super(BzrBranchFormat5, self).__init__()
755
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
756
757
def open(self, a_bzrdir, _found=False):
758
"""Return the branch object for a_bzrdir
759
760
_found is a private parameter, do not use it. It is used to indicate
761
if format probing has already be done.
762
"""
763
if not _found:
764
format = BranchFormat.find_format(a_bzrdir)
765
assert format.__class__ == self.__class__
766
transport = a_bzrdir.get_branch_transport(None)
767
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
768
return BzrBranch5(_format=self,
769
_control_files=control_files,
770
a_bzrdir=a_bzrdir,
771
_repository=a_bzrdir.find_repository())
772
773
def __str__(self):
774
return "Bazaar-NG Metadir branch format 5"
775
776
777
class BranchReferenceFormat(BranchFormat):
778
"""Bzr branch reference format.
779
780
Branch references are used in implementing checkouts, they
781
act as an alias to the real branch which is at some other url.
782
783
This format has:
784
- A location file
785
- a format string
786
"""
787
788
def get_format_string(self):
789
"""See BranchFormat.get_format_string()."""
790
return "Bazaar-NG Branch Reference Format 1\n"
791
792
def get_format_description(self):
793
"""See BranchFormat.get_format_description()."""
794
return "Checkout reference format 1"
795
796
def initialize(self, a_bzrdir, target_branch=None):
797
"""Create a branch of this format in a_bzrdir."""
798
if target_branch is None:
799
# this format does not implement branch itself, thus the implicit
800
# creation contract must see it as uninitializable
801
raise errors.UninitializableFormat(self)
802
mutter('creating branch reference in %s', a_bzrdir.transport.base)
803
branch_transport = a_bzrdir.get_branch_transport(self)
804
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
805
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
806
branch_transport.put('format', StringIO(self.get_format_string()))
807
return self.open(a_bzrdir, _found=True)
808
809
def __init__(self):
810
super(BranchReferenceFormat, self).__init__()
811
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
812
813
def _make_reference_clone_function(format, a_branch):
814
"""Create a clone() routine for a branch dynamically."""
815
def clone(to_bzrdir, revision_id=None):
816
"""See Branch.clone()."""
817
return format.initialize(to_bzrdir, a_branch)
818
# cannot obey revision_id limits when cloning a reference ...
819
# FIXME RBC 20060210 either nuke revision_id for clone, or
820
# emit some sort of warning/error to the caller ?!
821
return clone
822
823
def open(self, a_bzrdir, _found=False):
824
"""Return the branch that the branch reference in a_bzrdir points at.
825
826
_found is a private parameter, do not use it. It is used to indicate
827
if format probing has already be done.
828
"""
829
if not _found:
830
format = BranchFormat.find_format(a_bzrdir)
831
assert format.__class__ == self.__class__
832
transport = a_bzrdir.get_branch_transport(None)
833
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
834
result = real_bzrdir.open_branch()
835
# this changes the behaviour of result.clone to create a new reference
836
# rather than a copy of the content of the branch.
837
# I did not use a proxy object because that needs much more extensive
838
# testing, and we are only changing one behaviour at the moment.
839
# If we decide to alter more behaviours - i.e. the implicit nickname
840
# then this should be refactored to introduce a tested proxy branch
841
# and a subclass of that for use in overriding clone() and ....
842
# - RBC 20060210
843
result.clone = self._make_reference_clone_function(result)
844
return result
845
846
847
# formats which have no format string are not discoverable
848
# and not independently creatable, so are not registered.
849
__default_format = BzrBranchFormat5()
850
BranchFormat.register_format(__default_format)
851
BranchFormat.register_format(BranchReferenceFormat())
852
BranchFormat.set_default_format(__default_format)
853
_legacy_formats = [BzrBranchFormat4(),
854
]
855
856
class BzrBranch(Branch):
857
"""A branch stored in the actual filesystem.
858
859
Note that it's "local" in the context of the filesystem; it doesn't
860
really matter if it's on an nfs/smb/afs/coda/... share, as long as
861
it's writable, and can be accessed via the normal filesystem API.
862
"""
863
864
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
865
relax_version_check=DEPRECATED_PARAMETER, _format=None,
866
_control_files=None, a_bzrdir=None, _repository=None):
867
"""Create new branch object at a particular location.
868
869
transport -- A Transport object, defining how to access files.
870
871
init -- If True, create new control files in a previously
872
unversioned directory. If False, the branch must already
873
be versioned.
874
875
relax_version_check -- If true, the usual check for the branch
876
version is not applied. This is intended only for
877
upgrade/recovery type use; it's not guaranteed that
878
all operations will work on old format branches.
879
"""
880
if a_bzrdir is None:
881
self.bzrdir = bzrdir.BzrDir.open(transport.base)
882
else:
883
self.bzrdir = a_bzrdir
884
self._transport = self.bzrdir.transport.clone('..')
885
self._base = self._transport.base
886
self._format = _format
887
if _control_files is None:
888
raise ValueError('BzrBranch _control_files is None')
889
self.control_files = _control_files
890
if deprecated_passed(init):
891
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
892
"deprecated as of bzr 0.8. Please use Branch.create().",
893
DeprecationWarning,
894
stacklevel=2)
895
if init:
896
# this is slower than before deprecation, oh well never mind.
897
# -> its deprecated.
898
self._initialize(transport.base)
899
self._check_format(_format)
900
if deprecated_passed(relax_version_check):
901
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
902
"relax_version_check parameter is deprecated as of bzr 0.8. "
903
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
904
"open() method.",
905
DeprecationWarning,
906
stacklevel=2)
907
if (not relax_version_check
908
and not self._format.is_supported()):
909
raise errors.UnsupportedFormatError(format=fmt)
910
if deprecated_passed(transport):
911
warn("BzrBranch.__init__(transport=XXX...): The transport "
912
"parameter is deprecated as of bzr 0.8. "
913
"Please use Branch.open, or bzrdir.open_branch().",
914
DeprecationWarning,
915
stacklevel=2)
916
self.repository = _repository
917
918
def __str__(self):
919
return '%s(%r)' % (self.__class__.__name__, self.base)
920
921
__repr__ = __str__
963
for f in files:
964
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
965
922
966
923
967
def __del__(self):
924
# TODO: It might be best to do this somewhere else,
925
# but it is nice for a Branch object to automatically
926
# cache it's information.
927
# Alternatively, we could have the Transport objects cache requests
928
# See the earlier discussion about how major objects (like Branch)
929
# should never expect their __del__ function to run.
930
# XXX: cache_root seems to be unused, 2006-01-13 mbp
931
if hasattr(self, 'cache_root') and self.cache_root is not None:
932
try:
933
osutils.rmtree(self.cache_root)
934
except:
935
pass
936
self.cache_root = None
937
938
def _get_base(self):
939
return self._base
940
941
base = property(_get_base, doc="The URL for the root of this branch.")
942
943
def _finish_transaction(self):
944
"""Exit the current transaction."""
945
return self.control_files._finish_transaction()
946
947
def get_transaction(self):
948
"""Return the current active transaction.
949
950
If no transaction is active, this returns a passthrough object
951
for which all data is immediately flushed and no caching happens.
952
"""
953
# this is an explicit function so that we can do tricky stuff
954
# when the storage in rev_storage is elsewhere.
955
# we probably need to hook the two 'lock a location' and
956
# 'have a transaction' together more delicately, so that
957
# we can have two locks (branch and storage) and one transaction
958
# ... and finishing the transaction unlocks both, but unlocking
959
# does not. - RBC 20051121
960
return self.control_files.get_transaction()
961
962
def _set_transaction(self, transaction):
963
"""Set a new active transaction."""
964
return self.control_files._set_transaction(transaction)
965
966
def abspath(self, name):
967
"""See Branch.abspath."""
968
return self.control_files._transport.abspath(name)
969
970
def _check_format(self, format):
971
"""Identify the branch format if needed.
972
973
The format is stored as a reference to the format object in
974
self._format for code that needs to check it later.
975
976
The format parameter is either None or the branch format class
977
used to open this branch.
978
979
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
980
"""
981
if format is None:
982
format = BranchFormat.find_format(self.bzrdir)
983
self._format = format
984
mutter("got branch format %s", self._format)
985
986
@needs_read_lock
987
def get_root_id(self):
988
"""See Branch.get_root_id."""
989
tree = self.repository.revision_tree(self.last_revision())
990
return tree.inventory.root.file_id
991
992
def is_locked(self):
993
return self.control_files.is_locked()
994
995
def lock_write(self):
996
# TODO: test for failed two phase locks. This is known broken.
997
self.control_files.lock_write()
998
self.repository.lock_write()
999
1000
def lock_read(self):
1001
# TODO: test for failed two phase locks. This is known broken.
1002
self.control_files.lock_read()
1003
self.repository.lock_read()
1004
1005
def unlock(self):
1006
# TODO: test for failed two phase locks. This is known broken.
1007
try:
1008
self.repository.unlock()
1009
finally:
1010
self.control_files.unlock()
1011
1012
def peek_lock_mode(self):
1013
if self.control_files._lock_count == 0:
1014
return None
1015
else:
1016
return self.control_files._lock_mode
1017
1018
def get_physical_lock_status(self):
1019
return self.control_files.get_physical_lock_status()
1020
1021
@needs_read_lock
1022
def print_file(self, file, revision_id):
1023
"""See Branch.print_file."""
1024
return self.repository.print_file(file, revision_id)
1025
1026
@needs_write_lock
1027
def append_revision(self, *revision_ids):
1028
"""See Branch.append_revision."""
1029
for revision_id in revision_ids:
1030
mutter("add {%s} to revision-history" % revision_id)
1031
rev_history = self.revision_history()
1032
rev_history.extend(revision_ids)
1033
self.set_revision_history(rev_history)
1034
1035
@needs_write_lock
1036
def set_revision_history(self, rev_history):
1037
"""See Branch.set_revision_history."""
1038
self.control_files.put_utf8(
1039
'revision-history', '\n'.join(rev_history))
1040
transaction = self.get_transaction()
1041
history = transaction.map.find_revision_history()
1042
if history is not None:
1043
# update the revision history in the identity map.
1044
history[:] = list(rev_history)
1045
# this call is disabled because revision_history is
1046
# not really an object yet, and the transaction is for objects.
1047
# transaction.register_dirty(history)
1048
else:
1049
transaction.map.add_revision_history(rev_history)
1050
# this call is disabled because revision_history is
1051
# not really an object yet, and the transaction is for objects.
1052
# transaction.register_clean(history)
1053
1054
@needs_read_lock
1055
def revision_history(self):
1056
"""See Branch.revision_history."""
1057
transaction = self.get_transaction()
1058
history = transaction.map.find_revision_history()
1059
if history is not None:
1060
mutter("cache hit for revision-history in %s", self)
1061
return list(history)
1062
history = [l.rstrip('\r\n') for l in
1063
self.control_files.get_utf8('revision-history').readlines()]
1064
transaction.map.add_revision_history(history)
1065
# this call is disabled because revision_history is
1066
# not really an object yet, and the transaction is for objects.
1067
# transaction.register_clean(history, precious=True)
1068
return list(history)
1069
1070
@needs_write_lock
1071
def generate_revision_history(self, revision_id, last_rev=None,
1072
other_branch=None):
1073
"""Create a new revision history that will finish with revision_id.
1074
1075
:param revision_id: the new tip to use.
1076
:param last_rev: The previous last_revision. If not None, then this
1077
must be a ancestory of revision_id, or DivergedBranches is raised.
1078
:param other_branch: The other branch that DivergedBranches should
1079
raise with respect to.
1080
"""
1081
# stop_revision must be a descendant of last_revision
1082
stop_graph = self.repository.get_revision_graph(revision_id)
1083
if last_rev is not None and last_rev not in stop_graph:
1084
# our previous tip is not merged into stop_revision
1085
raise errors.DivergedBranches(self, other_branch)
1086
# make a new revision history from the graph
1087
current_rev_id = revision_id
1088
new_history = []
1089
while current_rev_id not in (None, revision.NULL_REVISION):
1090
new_history.append(current_rev_id)
1091
current_rev_id_parents = stop_graph[current_rev_id]
1092
try:
1093
current_rev_id = current_rev_id_parents[0]
1094
except IndexError:
1095
current_rev_id = None
1096
new_history.reverse()
1097
self.set_revision_history(new_history)
1098
1099
@needs_write_lock
1100
def update_revisions(self, other, stop_revision=None):
1101
"""See Branch.update_revisions."""
1102
other.lock_read()
1103
try:
1104
if stop_revision is None:
1105
stop_revision = other.last_revision()
1106
if stop_revision is None:
1107
# if there are no commits, we're done.
1108
return
1109
# whats the current last revision, before we fetch [and change it
1110
# possibly]
1111
last_rev = self.last_revision()
1112
# we fetch here regardless of whether we need to so that we pickup
1113
# filled in ghosts.
1114
self.fetch(other, stop_revision)
1115
my_ancestry = self.repository.get_ancestry(last_rev)
1116
if stop_revision in my_ancestry:
1117
# last_revision is a descendant of stop_revision
1118
return
1119
self.generate_revision_history(stop_revision, last_rev=last_rev,
1120
other_branch=other)
1121
finally:
1122
other.unlock()
1123
1124
def basis_tree(self):
1125
"""See Branch.basis_tree."""
1126
return self.repository.revision_tree(self.last_revision())
1127
1128
@deprecated_method(zero_eight)
1129
def working_tree(self):
1130
"""Create a Working tree object for this branch."""
1131
1132
from bzrlib.transport.local import LocalTransport
1133
if (self.base.find('://') != -1 or
1134
not isinstance(self._transport, LocalTransport)):
1135
raise NoWorkingTree(self.base)
1136
return self.bzrdir.open_workingtree()
1137
1138
@needs_write_lock
1139
def pull(self, source, overwrite=False, stop_revision=None):
1140
"""See Branch.pull."""
1141
source.lock_read()
1142
try:
1143
old_count = len(self.revision_history())
1144
try:
1145
self.update_revisions(source,stop_revision)
1146
except DivergedBranches:
1147
if not overwrite:
1148
raise
1149
if overwrite:
1150
self.set_revision_history(source.revision_history())
1151
new_count = len(self.revision_history())
1152
return new_count - old_count
1153
finally:
1154
source.unlock()
1155
1156
def get_parent(self):
1157
"""See Branch.get_parent."""
1158
1159
_locs = ['parent', 'pull', 'x-pull']
1160
assert self.base[-1] == '/'
1161
for l in _locs:
1162
try:
1163
parent = self.control_files.get(l).read().strip('\n')
1164
except NoSuchFile:
1165
continue
1166
# This is an old-format absolute path to a local branch
1167
# turn it into a url
1168
if parent.startswith('/'):
1169
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1170
return urlutils.join(self.base[:-1], parent)
1171
return None
1172
1173
def get_push_location(self):
1174
"""See Branch.get_push_location."""
1175
push_loc = self.get_config().get_user_option('push_location')
1176
return push_loc
1177
1178
def set_push_location(self, location):
1179
"""See Branch.set_push_location."""
1180
self.get_config().set_user_option('push_location', location,
1181
local=True)
1182
1183
@needs_write_lock
1184
def set_parent(self, url):
1185
"""See Branch.set_parent."""
1186
# TODO: Maybe delete old location files?
1187
# URLs should never be unicode, even on the local fs,
1188
# FIXUP this and get_parent in a future branch format bump:
1189
# read and rewrite the file, and have the new format code read
1190
# using .get not .get_utf8. RBC 20060125
1191
if url is None:
1192
self.control_files._transport.delete('parent')
1193
else:
1194
if isinstance(url, unicode):
1195
try:
1196
url = url.encode('ascii')
1197
except UnicodeEncodeError:
1198
raise bzrlib.errors.InvalidURL(url,
1199
"Urls must be 7-bit ascii, "
1200
"use bzrlib.urlutils.escape")
1201
1202
url = urlutils.relative_url(self.base, url)
1203
self.control_files.put('parent', url + '\n')
1204
1205
@deprecated_function(zero_nine)
1206
def tree_config(self):
1207
"""DEPRECATED; call get_config instead.
1208
TreeConfig has become part of BranchConfig."""
1209
return TreeConfig(self)
1210
1211
1212
class BzrBranch5(BzrBranch):
1213
"""A format 5 branch. This supports new features over plan branches.
1214
1215
It has support for a master_branch which is the data for bound branches.
1216
"""
1217
1218
def __init__(self,
1219
_format,
1220
_control_files,
1221
a_bzrdir,
1222
_repository):
1223
super(BzrBranch5, self).__init__(_format=_format,
1224
_control_files=_control_files,
1225
a_bzrdir=a_bzrdir,
1226
_repository=_repository)
1227
1228
@needs_write_lock
1229
def pull(self, source, overwrite=False, stop_revision=None):
1230
"""Updates branch.pull to be bound branch aware."""
1231
bound_location = self.get_bound_location()
1232
if source.base != bound_location:
1233
# not pulling from master, so we need to update master.
1234
master_branch = self.get_master_branch()
1235
if master_branch:
1236
master_branch.pull(source)
1237
source = master_branch
1238
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1239
1240
def get_bound_location(self):
1241
try:
1242
return self.control_files.get_utf8('bound').read()[:-1]
1243
except errors.NoSuchFile:
1244
return None
1245
1246
@needs_read_lock
1247
def get_master_branch(self):
1248
"""Return the branch we are bound to.
1249
1250
:return: Either a Branch, or None
1251
1252
This could memoise the branch, but if thats done
1253
it must be revalidated on each new lock.
1254
So for now we just don't memoise it.
1255
# RBC 20060304 review this decision.
1256
"""
1257
bound_loc = self.get_bound_location()
1258
if not bound_loc:
1259
return None
1260
try:
1261
return Branch.open(bound_loc)
1262
except (errors.NotBranchError, errors.ConnectionError), e:
1263
raise errors.BoundBranchConnectionFailure(
1264
self, bound_loc, e)
1265
1266
@needs_write_lock
1267
def set_bound_location(self, location):
1268
"""Set the target where this branch is bound to.
1269
1270
:param location: URL to the target branch
1271
"""
1272
if location:
1273
self.control_files.put_utf8('bound', location+'\n')
1274
else:
1275
try:
1276
self.control_files._transport.delete('bound')
1277
except NoSuchFile:
1278
return False
968
"""Destroy the test branch, removing the scratch directory."""
969
try:
970
shutil.rmtree(self.base)
971
except OSError:
972
# Work around for shutil.rmtree failing on Windows when
973
# readonly files are encountered
974
for root, dirs, files in os.walk(self.base, topdown=False):
975
for name in files:
976
os.chmod(os.path.join(root, name), 0700)
977
shutil.rmtree(self.base)
978
979
980
981
######################################################################
982
# predicates
983
984
985
def is_control_file(filename):
986
## FIXME: better check
987
filename = os.path.normpath(filename)
988
while filename != '':
989
head, tail = os.path.split(filename)
990
## mutter('check %r for control file' % ((head, tail), ))
991
if tail == bzrlib.BZRDIR:
1279
992
return True
1280
1281
@needs_write_lock
1282
def bind(self, other):
1283
"""Bind the local branch the other branch.
1284
1285
:param other: The branch to bind to
1286
:type other: Branch
1287
"""
1288
# TODO: jam 20051230 Consider checking if the target is bound
1289
# It is debatable whether you should be able to bind to
1290
# a branch which is itself bound.
1291
# Committing is obviously forbidden,
1292
# but binding itself may not be.
1293
# Since we *have* to check at commit time, we don't
1294
# *need* to check here
1295
self.pull(other)
1296
1297
# we are now equal to or a suffix of other.
1298
1299
# Since we have 'pulled' from the remote location,
1300
# now we should try to pull in the opposite direction
1301
# in case the local tree has more revisions than the
1302
# remote one.
1303
# There may be a different check you could do here
1304
# rather than actually trying to install revisions remotely.
1305
# TODO: capture an exception which indicates the remote branch
1306
# is not writable.
1307
# If it is up-to-date, this probably should not be a failure
1308
1309
# lock other for write so the revision-history syncing cannot race
1310
other.lock_write()
1311
try:
1312
other.pull(self)
1313
# if this does not error, other now has the same last rev we do
1314
# it can only error if the pull from other was concurrent with
1315
# a commit to other from someone else.
1316
1317
# until we ditch revision-history, we need to sync them up:
1318
self.set_revision_history(other.revision_history())
1319
# now other and self are up to date with each other and have the
1320
# same revision-history.
1321
finally:
1322
other.unlock()
1323
1324
self.set_bound_location(other.base)
1325
1326
@needs_write_lock
1327
def unbind(self):
1328
"""If bound, unbind"""
1329
return self.set_bound_location(None)
1330
1331
@needs_write_lock
1332
def update(self):
1333
"""Synchronise this branch with the master branch if any.
1334
1335
:return: None or the last_revision that was pivoted out during the
1336
update.
1337
"""
1338
master = self.get_master_branch()
1339
if master is not None:
1340
old_tip = self.last_revision()
1341
self.pull(master, overwrite=True)
1342
if old_tip in self.repository.get_ancestry(self.last_revision()):
1343
return None
1344
return old_tip
1345
return None
1346
1347
1348
class BranchTestProviderAdapter(object):
1349
"""A tool to generate a suite testing multiple branch formats at once.
1350
1351
This is done by copying the test once for each transport and injecting
1352
the transport_server, transport_readonly_server, and branch_format
1353
classes into each copy. Each copy is also given a new id() to make it
1354
easy to identify.
1355
"""
1356
1357
def __init__(self, transport_server, transport_readonly_server, formats):
1358
self._transport_server = transport_server
1359
self._transport_readonly_server = transport_readonly_server
1360
self._formats = formats
1361
1362
def adapt(self, test):
1363
result = TestSuite()
1364
for branch_format, bzrdir_format in self._formats:
1365
new_test = deepcopy(test)
1366
new_test.transport_server = self._transport_server
1367
new_test.transport_readonly_server = self._transport_readonly_server
1368
new_test.bzrdir_format = bzrdir_format
1369
new_test.branch_format = branch_format
1370
def make_new_test_id():
1371
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1372
return lambda: new_id
1373
new_test.id = make_new_test_id()
1374
result.addTest(new_test)
1375
return result
1376
1377
1378
class BranchCheckResult(object):
1379
"""Results of checking branch consistency.
1380
1381
:see: Branch.check
1382
"""
1383
1384
def __init__(self, branch):
1385
self.branch = branch
1386
1387
def report_results(self, verbose):
1388
"""Report the check results via trace.note.
1389
1390
:param verbose: Requests more detailed display of what was checked,
1391
if any.
1392
"""
1393
note('checked branch %s format %s',
1394
self.branch.base,
1395
self.branch._format)
1396
1397
1398
######################################################################
1399
# predicates
1400
1401
1402
@deprecated_function(zero_eight)
1403
def is_control_file(*args, **kwargs):
1404
"""See bzrlib.workingtree.is_control_file."""
1405
return bzrlib.workingtree.is_control_file(*args, **kwargs)
993
if filename == head:
994
break
995
filename = head
996
return False
997
998
999
1000
def _gen_revision_id(when):
1001
"""Return new revision-id."""
1002
s = '%s-%s-' % (user_email(), compact_date(when))
1003
s += hexlify(rand_bytes(8))
1004
return s
1005
1006
1007
def gen_file_id(name):
1008
"""Return new file id.
1009
1010
This should probably generate proper UUIDs, but for the moment we
1011
cope with just randomness because running uuidgen every time is
1012
slow."""
1013
idx = name.rfind('/')
1014
if idx != -1:
1015
name = name[idx+1 : ]
1016
idx = name.rfind('\\')
1017
if idx != -1:
1018
name = name[idx+1 : ]
1019
1020
name = name.lstrip('.')
1021
1022
s = hexlify(rand_bytes(8))
1023
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1