« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1801.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1801.1.1
- Committer: Jelmer Vernooij
- Date: 2006-06-21 13:54:14 UTC
- mto: (1558.14.8 Aaron's integration)
- mto: This revision was merged to the branch mainline in revision 1803.
- Revision ID: jelmer@samba.org-20060621135414-11a3a70e53adbb99
Install benchmarks.
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- bzrlib/store
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/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
- contrib/emacs
- tools/doc_generate
- files removed:
- bzrlib/mdiff.py
- notes
- patches
- plugins/changeset
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
import sys, os
18
from copy import deepcopy
19
from cStringIO import StringIO
20
from unittest import TestSuite
21
from warnings import warn
19
22
20
23
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
)
21
45
from bzrlib.trace import mutter, note
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
25
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
## TODO: Maybe include checks for common corruption of newlines, etc?
28
29
30
31
def find_branch(f, **args):
32
if f and (f.startswith('http://') or f.startswith('https://')):
33
import remotebranch
34
return remotebranch.RemoteBranch(f, **args)
35
else:
36
return Branch(f, **args)
37
38
39
def find_cached_branch(f, cache_root, **args):
40
from remotebranch import RemoteBranch
41
br = find_branch(f, **args)
42
def cacheify(br, store_name):
43
from meta_store import CachedStore
44
cache_path = os.path.join(cache_root, store_name)
45
os.mkdir(cache_path)
46
new_store = CachedStore(getattr(br, store_name), cache_path)
47
setattr(br, store_name, new_store)
48
49
if isinstance(br, RemoteBranch):
50
cacheify(br, 'inventory_store')
51
cacheify(br, 'text_store')
52
cacheify(br, 'revision_store')
53
return br
54
55
56
def _relpath(base, path):
57
"""Return path relative to base, or raise exception.
58
59
The path may be either an absolute path or a path relative to the
60
current working directory.
61
62
Lifted out of Branch.relpath for ease of testing.
63
64
os.path.commonprefix (python2.4) has a bad bug that it works just
65
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
66
avoids that problem."""
67
rp = os.path.abspath(path)
68
69
s = []
70
head = rp
71
while len(head) >= len(base):
72
if head == base:
73
break
74
head, tail = os.path.split(head)
75
if tail:
76
s.insert(0, tail)
77
else:
78
from errors import NotBranchError
79
raise NotBranchError("path %r is not within branch %r" % (rp, base))
80
81
return os.sep.join(s)
82
83
84
def find_branch_root(f=None):
85
"""Find the branch root enclosing f, or pwd.
86
87
f may be a filename or a URL.
88
89
It is not necessary that f exists.
90
91
Basically we keep looking up until we find the control directory or
92
run into the root."""
93
if f == None:
94
f = os.getcwd()
95
elif hasattr(os.path, 'realpath'):
96
f = os.path.realpath(f)
97
else:
98
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
101
102
103
orig_f = f
104
105
while True:
106
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
107
return f
108
head, tail = os.path.split(f)
109
if head == f:
110
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
112
f = head
113
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
Exception.__init__(self, "These branches have diverged.")
119
120
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
123
self.branch = branch
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
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
127
60
128
61
129
62
######################################################################
133
66
"""Branch holding a history of revisions.
134
67
135
68
base
136
Base directory of the branch.
137
138
_lock_mode
139
None, or 'r' or 'w'
140
141
_lock_count
142
If _lock_mode is true, a positive count of the number of times the
143
lock has been taken.
144
145
_lock
146
Lock object from bzrlib.lock.
69
Base directory/url of the branch.
147
70
"""
71
# this is really an instance variable - FIXME move it there
72
# - RBC 20060112
148
73
base = None
149
_lock_mode = None
150
_lock_count = None
151
_lock = None
152
153
# Map some sort of prefix into a namespace
154
# stuff like "revno:10", "revid:", etc.
155
# This should match a prefix with a function which accepts
156
REVISION_NAMESPACES = {}
157
158
def __init__(self, base, init=False, find_root=True):
159
"""Create new branch object at a particular location.
160
161
base -- Base directory for the branch.
162
163
init -- If True, create new control files in a previously
164
unversioned directory. If False, the branch must already
165
be versioned.
166
167
find_root -- If true and init is false, find the root of the
168
existing branch containing base.
169
170
In the test suite, creation of new trees is tested using the
171
`ScratchBranch` class.
172
"""
173
from bzrlib.store import ImmutableStore
174
if init:
175
self.base = os.path.realpath(base)
176
self._make_control()
177
elif find_root:
178
self.base = find_branch_root(base)
179
else:
180
self.base = os.path.realpath(base)
181
if not isdir(self.controlfilename('.')):
182
from errors import NotBranchError
183
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
184
['use "bzr init" to initialize a new working tree',
185
'current bzr can only operate from top-of-tree'])
186
self._check_format()
187
188
self.text_store = ImmutableStore(self.controlfilename('text-store'))
189
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
190
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
191
192
193
def __str__(self):
194
return '%s(%r)' % (self.__class__.__name__, self.base)
195
196
197
__repr__ = __str__
198
199
200
def __del__(self):
201
if self._lock_mode or self._lock:
202
from warnings import warn
203
warn("branch %r was not explicitly unlocked" % self)
204
self._lock.unlock()
205
206
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')
207
154
208
155
def lock_write(self):
209
if self._lock_mode:
210
if self._lock_mode != 'w':
211
from errors import LockError
212
raise LockError("can't upgrade to a write lock from %r" %
213
self._lock_mode)
214
self._lock_count += 1
215
else:
216
from bzrlib.lock import WriteLock
217
218
self._lock = WriteLock(self.controlfilename('branch-lock'))
219
self._lock_mode = 'w'
220
self._lock_count = 1
221
222
156
raise NotImplementedError('lock_write is abstract')
223
157
224
158
def lock_read(self):
225
if self._lock_mode:
226
assert self._lock_mode in ('r', 'w'), \
227
"invalid lock mode %r" % self._lock_mode
228
self._lock_count += 1
229
else:
230
from bzrlib.lock import ReadLock
231
232
self._lock = ReadLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'r'
234
self._lock_count = 1
235
236
237
159
raise NotImplementedError('lock_read is abstract')
160
238
161
def unlock(self):
239
if not self._lock_mode:
240
from errors import LockError
241
raise LockError('branch %r is not locked' % (self))
242
243
if self._lock_count > 1:
244
self._lock_count -= 1
245
else:
246
self._lock.unlock()
247
self._lock = None
248
self._lock_mode = self._lock_count = None
249
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')
250
170
251
171
def abspath(self, name):
252
"""Return absolute filename for something in the branch"""
253
return os.path.join(self.base, name)
254
255
256
def relpath(self, path):
257
"""Return path relative to this branch of something inside it.
258
259
Raises an error if path is not in this branch."""
260
return _relpath(self.base, path)
261
262
263
def controlfilename(self, file_or_path):
264
"""Return location relative to branch."""
265
if isinstance(file_or_path, basestring):
266
file_or_path = [file_or_path]
267
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
268
269
270
def controlfile(self, file_or_path, mode='r'):
271
"""Open a control file for this branch.
272
273
There are two classes of file in the control directory: text
274
and binary. binary files are untranslated byte streams. Text
275
control files are stored with Unix newlines and in UTF-8, even
276
if the platform or locale defaults are different.
277
278
Controlfiles should almost never be opened in write mode but
279
rather should be atomically copied and replaced using atomicfile.
280
"""
281
282
fn = self.controlfilename(file_or_path)
283
284
if mode == 'rb' or mode == 'wb':
285
return file(fn, mode)
286
elif mode == 'r' or mode == 'w':
287
# open in binary mode anyhow so there's no newline translation;
288
# codecs uses line buffering by default; don't want that.
289
import codecs
290
return codecs.open(fn, mode + 'b', 'utf-8',
291
buffering=60000)
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
292
204
else:
293
raise BzrError("invalid controlfile mode %r" % mode)
294
295
296
297
def _make_control(self):
298
from bzrlib.inventory import Inventory
299
from bzrlib.xml import pack_xml
300
301
os.mkdir(self.controlfilename([]))
302
self.controlfile('README', 'w').write(
303
"This is a Bazaar-NG control directory.\n"
304
"Do not change any files in this directory.\n")
305
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
306
for d in ('text-store', 'inventory-store', 'revision-store'):
307
os.mkdir(self.controlfilename(d))
308
for f in ('revision-history', 'merged-patches',
309
'pending-merged-patches', 'branch-name',
310
'branch-lock',
311
'pending-merges'):
312
self.controlfile(f, 'w').write('')
313
mutter('created control directory in ' + self.base)
314
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
316
317
318
def _check_format(self):
319
"""Check this branch format is supported.
320
321
The current tool only supports the current unstable format.
322
323
In the future, we might need different in-memory Branch
324
classes to support downlevel branches. But not yet.
325
"""
326
# This ignores newlines so that we can open branches created
327
# on Windows from Linux and so on. I think it might be better
328
# to always make all internal files in unix format.
329
fmt = self.controlfile('branch-format', 'r').read()
330
fmt.replace('\r\n', '')
331
if fmt != BZR_BRANCH_FORMAT:
332
raise BzrError('sorry, branch format %r not supported' % fmt,
333
['use a different bzr version',
334
'or remove the .bzr directory and "bzr init" again'])
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)
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])
335
271
336
272
def get_root_id(self):
337
273
"""Return the id of this branches root"""
338
inv = self.read_working_inventory()
339
return inv.root.file_id
340
341
def set_root_id(self, file_id):
342
inv = self.read_working_inventory()
343
orig_root_id = inv.root.file_id
344
del inv._byid[inv.root.file_id]
345
inv.root.file_id = file_id
346
inv._byid[inv.root.file_id] = inv.root
347
for fid in inv:
348
entry = inv[fid]
349
if entry.parent_id in (None, orig_root_id):
350
entry.parent_id = inv.root.file_id
351
self._write_inventory(inv)
352
353
def read_working_inventory(self):
354
"""Read the working inventory."""
355
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
358
before = time()
359
self.lock_read()
360
try:
361
# ElementTree does its own conversion from UTF-8, so open in
362
# binary.
363
inv = unpack_xml(Inventory,
364
self.controlfile('inventory', 'rb'))
365
mutter("loaded inventory of %d items in %f"
366
% (len(inv), time() - before))
367
return inv
368
finally:
369
self.unlock()
370
371
372
def _write_inventory(self, inv):
373
"""Update the working inventory.
374
375
That is to say, the inventory describing changes underway, that
376
will be committed to the next revision.
377
"""
378
from bzrlib.atomicfile import AtomicFile
379
from bzrlib.xml import pack_xml
380
381
self.lock_write()
382
try:
383
f = AtomicFile(self.controlfilename('inventory'), 'wb')
384
try:
385
pack_xml(inv, f)
386
f.commit()
387
finally:
388
f.close()
389
finally:
390
self.unlock()
391
392
mutter('wrote working inventory')
393
394
395
inventory = property(read_working_inventory, _write_inventory, None,
396
"""Inventory for the working copy.""")
397
398
399
def add(self, files, verbose=False, ids=None):
400
"""Make files versioned.
401
402
Note that the command line normally calls smart_add instead.
403
404
This puts the files in the Added state, so that they will be
405
recorded by the next commit.
406
407
files
408
List of paths to add, relative to the base of the tree.
409
410
ids
411
If set, use these instead of automatically generated ids.
412
Must be the same length as the list of files, but may
413
contain None for ids that are to be autogenerated.
414
415
TODO: Perhaps have an option to add the ids even if the files do
416
not (yet) exist.
417
418
TODO: Perhaps return the ids of the files? But then again it
419
is easy to retrieve them if they're needed.
420
421
TODO: Adding a directory should optionally recurse down and
422
add all non-ignored children. Perhaps do that in a
423
higher-level method.
424
"""
425
from bzrlib.textui import show_status
426
# TODO: Re-adding a file that is removed in the working copy
427
# should probably put it back with the previous ID.
428
if isinstance(files, basestring):
429
assert(ids is None or isinstance(ids, basestring))
430
files = [files]
431
if ids is not None:
432
ids = [ids]
433
434
if ids is None:
435
ids = [None] * len(files)
436
else:
437
assert(len(ids) == len(files))
438
439
self.lock_write()
440
try:
441
inv = self.read_working_inventory()
442
for f,file_id in zip(files, ids):
443
if is_control_file(f):
444
raise BzrError("cannot add control file %s" % quotefn(f))
445
446
fp = splitpath(f)
447
448
if len(fp) == 0:
449
raise BzrError("cannot add top-level %r" % f)
450
451
fullpath = os.path.normpath(self.abspath(f))
452
453
try:
454
kind = file_kind(fullpath)
455
except OSError:
456
# maybe something better?
457
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
458
459
if kind != 'file' and kind != 'directory':
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if file_id is None:
463
file_id = gen_file_id(f)
464
inv.add_path(f, kind=kind, file_id=file_id)
465
466
if verbose:
467
print 'added', quotefn(f)
468
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
470
471
self._write_inventory(inv)
472
finally:
473
self.unlock()
474
475
476
def print_file(self, file, revno):
274
raise NotImplementedError('get_root_id is abstract')
275
276
def print_file(self, file, revision_id):
477
277
"""Print `file` to stdout."""
478
self.lock_read()
479
try:
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
483
if not file_id:
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
486
finally:
487
self.unlock()
488
489
490
def remove(self, files, verbose=False):
491
"""Mark nominated files for removal from the inventory.
492
493
This does not remove their text. This does not run on
494
495
TODO: Refuse to remove modified files unless --force is given?
496
497
TODO: Do something useful with directories.
498
499
TODO: Should this remove the text or not? Tough call; not
500
removing may be useful and the user can just use use rm, and
501
is the opposite of add. Removing it is consistent with most
502
other tools. Maybe an option.
503
"""
504
from bzrlib.textui import show_status
505
## TODO: Normalize names
506
## TODO: Remove nested loops; better scalability
507
if isinstance(files, basestring):
508
files = [files]
509
510
self.lock_write()
511
512
try:
513
tree = self.working_tree()
514
inv = tree.inventory
515
516
# do this before any modifications
517
for f in files:
518
fid = inv.path2id(f)
519
if not fid:
520
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
521
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
522
if verbose:
523
# having remove it, it must be either ignored or unknown
524
if tree.is_ignored(f):
525
new_status = 'I'
526
else:
527
new_status = '?'
528
show_status(new_status, inv[fid].kind, quotefn(f))
529
del inv[fid]
530
531
self._write_inventory(inv)
532
finally:
533
self.unlock()
534
535
536
# FIXME: this doesn't need to be a branch method
537
def set_inventory(self, new_inventory_list):
538
from bzrlib.inventory import Inventory, InventoryEntry
539
inv = Inventory(self.get_root_id())
540
for path, file_id, parent, kind in new_inventory_list:
541
name = os.path.basename(path)
542
if name == "":
543
continue
544
inv.add(InventoryEntry(file_id, name, kind, parent))
545
self._write_inventory(inv)
546
547
548
def unknowns(self):
549
"""Return all unknown files.
550
551
These are files in the working directory that are not versioned or
552
control files or ignored.
553
554
>>> b = ScratchBranch(files=['foo', 'foo~'])
555
>>> list(b.unknowns())
556
['foo']
557
>>> b.add('foo')
558
>>> list(b.unknowns())
559
[]
560
>>> b.remove('foo')
561
>>> list(b.unknowns())
562
['foo']
563
"""
564
return self.working_tree().unknowns()
565
278
raise NotImplementedError('print_file is abstract')
566
279
567
280
def append_revision(self, *revision_ids):
568
from bzrlib.atomicfile import AtomicFile
569
570
for revision_id in revision_ids:
571
mutter("add {%s} to revision-history" % revision_id)
572
573
rev_history = self.revision_history()
574
rev_history.extend(revision_ids)
575
576
f = AtomicFile(self.controlfilename('revision-history'))
577
try:
578
for rev_id in rev_history:
579
print >>f, rev_id
580
f.commit()
581
finally:
582
f.close()
583
584
585
def get_revision(self, revision_id):
586
"""Return the Revision object for a named revision"""
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
589
590
self.lock_read()
591
try:
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise ValueError('invalid revision-id: %r' % revision_id)
594
r = unpack_xml(Revision, self.revision_store[revision_id])
595
finally:
596
self.unlock()
597
598
assert r.revision_id == revision_id
599
return r
600
601
602
def get_revision_sha1(self, revision_id):
603
"""Hash the stored value of a revision, and return it."""
604
# In the future, revision entries will be signed. At that
605
# point, it is probably best *not* to include the signature
606
# in the revision hash. Because that lets you re-sign
607
# the revision, (add signatures/remove signatures) and still
608
# have all hash pointers stay consistent.
609
# But for now, just hash the contents.
610
return sha_file(self.revision_store[revision_id])
611
612
613
def get_inventory(self, inventory_id):
614
"""Get Inventory object by hash.
615
616
TODO: Perhaps for this and similar methods, take a revision
617
parameter which can be either an integer revno or a
618
string hash."""
619
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
621
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
623
624
625
def get_inventory_sha1(self, inventory_id):
626
"""Return the sha1 hash of the inventory entry
627
"""
628
return sha_file(self.inventory_store[inventory_id])
629
630
631
def get_revision_inventory(self, revision_id):
632
"""Return inventory of a past revision."""
633
# bzr 0.0.6 imposes the constraint that the inventory_id
634
# must be the same as its revision, so this is trivial.
635
if revision_id == None:
636
from bzrlib.inventory import Inventory
637
return Inventory(self.get_root_id())
638
else:
639
return self.get_inventory(revision_id)
640
281
raise NotImplementedError('append_revision is abstract')
282
283
def set_revision_history(self, rev_history):
284
raise NotImplementedError('set_revision_history is abstract')
641
285
642
286
def revision_history(self):
643
"""Return sequence of revision hashes on to this branch.
644
645
>>> ScratchBranch().revision_history()
646
[]
647
"""
648
self.lock_read()
649
try:
650
return [l.rstrip('\r\n') for l in
651
self.controlfile('revision-history', 'r').readlines()]
652
finally:
653
self.unlock()
654
655
656
def common_ancestor(self, other, self_revno=None, other_revno=None):
657
"""
658
>>> import commit
659
>>> sb = ScratchBranch(files=['foo', 'foo~'])
660
>>> sb.common_ancestor(sb) == (None, None)
661
True
662
>>> commit.commit(sb, "Committing first revision", verbose=False)
663
>>> sb.common_ancestor(sb)[0]
664
1
665
>>> clone = sb.clone()
666
>>> commit.commit(sb, "Committing second revision", verbose=False)
667
>>> sb.common_ancestor(sb)[0]
668
2
669
>>> sb.common_ancestor(clone)[0]
670
1
671
>>> commit.commit(clone, "Committing divergent second revision",
672
... verbose=False)
673
>>> sb.common_ancestor(clone)[0]
674
1
675
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
676
True
677
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
678
True
679
>>> clone2 = sb.clone()
680
>>> sb.common_ancestor(clone2)[0]
681
2
682
>>> sb.common_ancestor(clone2, self_revno=1)[0]
683
1
684
>>> sb.common_ancestor(clone2, other_revno=1)[0]
685
1
686
"""
687
my_history = self.revision_history()
688
other_history = other.revision_history()
689
if self_revno is None:
690
self_revno = len(my_history)
691
if other_revno is None:
692
other_revno = len(other_history)
693
indices = range(min((self_revno, other_revno)))
694
indices.reverse()
695
for r in indices:
696
if my_history[r] == other_history[r]:
697
return r+1, my_history[r]
698
return None, None
699
700
def enum_history(self, direction):
701
"""Return (revno, revision_id) for history of branch.
702
703
direction
704
'forward' is from earliest to latest
705
'reverse' is from latest to earliest
706
"""
707
rh = self.revision_history()
708
if direction == 'forward':
709
i = 1
710
for rid in rh:
711
yield i, rid
712
i += 1
713
elif direction == 'reverse':
714
i = len(rh)
715
while i > 0:
716
yield i, rh[i-1]
717
i -= 1
718
else:
719
raise ValueError('invalid history direction', direction)
720
287
"""Return sequence of revision hashes on to this branch."""
288
raise NotImplementedError('revision_history is abstract')
721
289
722
290
def revno(self):
723
291
"""Return current revision number for this branch.
727
295
"""
728
296
return len(self.revision_history())
729
297
298
def unbind(self):
299
"""Older format branches cannot bind or unbind."""
300
raise errors.UpgradeRequired(self.base)
730
301
731
def last_patch(self):
732
"""Return last patch hash, or None if no history.
733
"""
302
def last_revision(self):
303
"""Return last patch hash, or None if no history."""
734
304
ph = self.revision_history()
735
305
if ph:
736
306
return ph[-1]
737
307
else:
738
308
return None
739
309
740
741
310
def missing_revisions(self, other, stop_revision=None):
742
"""
311
"""Return a list of new revisions that would perfectly fit.
312
743
313
If self and other have not diverged, return a list of the revisions
744
314
present in other, but missing from self.
745
746
>>> from bzrlib.commit import commit
747
>>> bzrlib.trace.silent = True
748
>>> br1 = ScratchBranch()
749
>>> br2 = ScratchBranch()
750
>>> br1.missing_revisions(br2)
751
[]
752
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
753
>>> br1.missing_revisions(br2)
754
[u'REVISION-ID-1']
755
>>> br2.missing_revisions(br1)
756
[]
757
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
758
>>> br1.missing_revisions(br2)
759
[]
760
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
761
>>> br1.missing_revisions(br2)
762
[u'REVISION-ID-2A']
763
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
764
>>> br1.missing_revisions(br2)
765
Traceback (most recent call last):
766
DivergedBranches: These branches have diverged.
767
315
"""
768
316
self_history = self.revision_history()
769
317
self_len = len(self_history)
776
324
777
325
if stop_revision is None:
778
326
stop_revision = other_len
779
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
781
327
else:
328
assert isinstance(stop_revision, int)
329
if stop_revision > other_len:
330
raise errors.NoSuchRevision(self, stop_revision)
782
331
return other_history[self_len:stop_revision]
783
332
784
785
333
def update_revisions(self, other, stop_revision=None):
786
"""Pull in all new revisions from other branch.
787
788
>>> from bzrlib.commit import commit
789
>>> bzrlib.trace.silent = True
790
>>> br1 = ScratchBranch(files=['foo', 'bar'])
791
>>> br1.add('foo')
792
>>> br1.add('bar')
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
794
>>> br2 = ScratchBranch()
795
>>> br2.update_revisions(br1)
796
Added 2 texts.
797
Added 1 inventories.
798
Added 1 revisions.
799
>>> br2.revision_history()
800
[u'REVISION-ID-1']
801
>>> br2.update_revisions(br1)
802
Added 0 texts.
803
Added 0 inventories.
804
Added 0 revisions.
805
>>> br1.text_store.total_size() == br2.text_store.total_size()
806
True
807
"""
808
from bzrlib.progress import ProgressBar
809
810
pb = ProgressBar()
811
812
pb.update('comparing histories')
813
revision_ids = self.missing_revisions(other, stop_revision)
814
815
if hasattr(other.revision_store, "prefetch"):
816
other.revision_store.prefetch(revision_ids)
817
if hasattr(other.inventory_store, "prefetch"):
818
inventory_ids = [other.get_revision(r).inventory_id
819
for r in revision_ids]
820
other.inventory_store.prefetch(inventory_ids)
821
822
revisions = []
823
needed_texts = set()
824
i = 0
825
for rev_id in revision_ids:
826
i += 1
827
pb.update('fetching revision', i, len(revision_ids))
828
rev = other.get_revision(rev_id)
829
revisions.append(rev)
830
inv = other.get_inventory(str(rev.inventory_id))
831
for key, entry in inv.iter_entries():
832
if entry.text_id is None:
833
continue
834
if entry.text_id not in self.text_store:
835
needed_texts.add(entry.text_id)
836
837
pb.clear()
838
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
841
inventory_ids = [ f.inventory_id for f in revisions ]
842
count = self.inventory_store.copy_multi(other.inventory_store,
843
inventory_ids)
844
print "Added %d inventories." % count
845
revision_ids = [ f.revision_id for f in revisions]
846
count = self.revision_store.copy_multi(other.revision_store,
847
revision_ids)
848
for revision_id in revision_ids:
849
self.append_revision(revision_id)
850
print "Added %d revisions." % count
851
852
853
def commit(self, *args, **kw):
854
from bzrlib.commit import commit
855
commit(self, *args, **kw)
856
857
858
def lookup_revision(self, revision):
859
"""Return the revision identifier for a given revision information."""
860
revno, info = self.get_revision_info(revision)
861
return info
862
863
def get_revision_info(self, revision):
864
"""Return (revno, revision id) for revision identifier.
865
866
revision can be an integer, in which case it is assumed to be revno (though
867
this will translate negative values into positive ones)
868
revision can also be a string, in which case it is parsed for something like
869
'date:' or 'revid:' etc.
870
"""
871
if revision is None:
872
return 0, None
873
revno = None
874
try:# Convert to int if possible
875
revision = int(revision)
876
except ValueError:
877
pass
878
revs = self.revision_history()
879
if isinstance(revision, int):
880
if revision == 0:
881
return 0, None
882
# Mabye we should do this first, but we don't need it if revision == 0
883
if revision < 0:
884
revno = len(revs) + revision + 1
885
else:
886
revno = revision
887
elif isinstance(revision, basestring):
888
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
889
if revision.startswith(prefix):
890
revno = func(self, revs, revision)
891
break
892
else:
893
raise BzrError('No namespace registered for string: %r' % revision)
894
895
if revno is None or revno <= 0 or revno > len(revs):
896
raise BzrError("no such revision %s" % revision)
897
return revno, revs[revno-1]
898
899
def _namespace_revno(self, revs, revision):
900
"""Lookup a revision by revision number"""
901
assert revision.startswith('revno:')
902
try:
903
return int(revision[6:])
904
except ValueError:
905
return None
906
REVISION_NAMESPACES['revno:'] = _namespace_revno
907
908
def _namespace_revid(self, revs, revision):
909
assert revision.startswith('revid:')
910
try:
911
return revs.index(revision[6:]) + 1
912
except ValueError:
913
return None
914
REVISION_NAMESPACES['revid:'] = _namespace_revid
915
916
def _namespace_last(self, revs, revision):
917
assert revision.startswith('last:')
918
try:
919
offset = int(revision[5:])
920
except ValueError:
921
return None
922
else:
923
if offset <= 0:
924
raise BzrError('You must supply a positive value for --revision last:XXX')
925
return len(revs) - offset + 1
926
REVISION_NAMESPACES['last:'] = _namespace_last
927
928
def _namespace_tag(self, revs, revision):
929
assert revision.startswith('tag:')
930
raise BzrError('tag: namespace registered, but not implemented.')
931
REVISION_NAMESPACES['tag:'] = _namespace_tag
932
933
def _namespace_date(self, revs, revision):
934
assert revision.startswith('date:')
935
import datetime
936
# Spec for date revisions:
937
# date:value
938
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
939
# it can also start with a '+/-/='. '+' says match the first
940
# entry after the given date. '-' is match the first entry before the date
941
# '=' is match the first entry after, but still on the given date.
942
#
943
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
944
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
945
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
946
# May 13th, 2005 at 0:00
947
#
948
# So the proper way of saying 'give me all entries for today' is:
949
# -r {date:+today}:{date:-tomorrow}
950
# The default is '=' when not supplied
951
val = revision[5:]
952
match_style = '='
953
if val[:1] in ('+', '-', '='):
954
match_style = val[:1]
955
val = val[1:]
956
957
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
958
if val.lower() == 'yesterday':
959
dt = today - datetime.timedelta(days=1)
960
elif val.lower() == 'today':
961
dt = today
962
elif val.lower() == 'tomorrow':
963
dt = today + datetime.timedelta(days=1)
964
else:
965
import re
966
# This should be done outside the function to avoid recompiling it.
967
_date_re = re.compile(
968
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
969
r'(,|T)?\s*'
970
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
971
)
972
m = _date_re.match(val)
973
if not m or (not m.group('date') and not m.group('time')):
974
raise BzrError('Invalid revision date %r' % revision)
975
976
if m.group('date'):
977
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
978
else:
979
year, month, day = today.year, today.month, today.day
980
if m.group('time'):
981
hour = int(m.group('hour'))
982
minute = int(m.group('minute'))
983
if m.group('second'):
984
second = int(m.group('second'))
985
else:
986
second = 0
987
else:
988
hour, minute, second = 0,0,0
989
990
dt = datetime.datetime(year=year, month=month, day=day,
991
hour=hour, minute=minute, second=second)
992
first = dt
993
last = None
994
reversed = False
995
if match_style == '-':
996
reversed = True
997
elif match_style == '=':
998
last = dt + datetime.timedelta(days=1)
999
1000
if reversed:
1001
for i in range(len(revs)-1, -1, -1):
1002
r = self.get_revision(revs[i])
1003
# TODO: Handle timezone.
1004
dt = datetime.datetime.fromtimestamp(r.timestamp)
1005
if first >= dt and (last is None or dt >= last):
1006
return i+1
1007
else:
1008
for i in range(len(revs)):
1009
r = self.get_revision(revs[i])
1010
# TODO: Handle timezone.
1011
dt = datetime.datetime.fromtimestamp(r.timestamp)
1012
if first <= dt and (last is None or dt <= last):
1013
return i+1
1014
REVISION_NAMESPACES['date:'] = _namespace_date
1015
1016
def revision_tree(self, revision_id):
1017
"""Return Tree for a revision on this branch.
1018
1019
`revision_id` may be None for the null revision, in which case
1020
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1022
# TODO: refactor this to use an existing revision object
1023
# so we don't need to read it in twice.
1024
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1026
else:
1027
inv = self.get_revision_inventory(revision_id)
1028
return RevisionTree(self.text_store, inv)
1029
1030
1031
def working_tree(self):
1032
"""Return a `Tree` for the working copy."""
1033
from workingtree import WorkingTree
1034
return WorkingTree(self.base, self.read_working_inventory())
1035
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."""
354
if revno == 0:
355
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')
1036
364
1037
365
def basis_tree(self):
1038
366
"""Return `Tree` object for last revision.
1039
367
1040
368
If there are no revisions yet, return an `EmptyTree`.
1041
369
"""
1042
from bzrlib.tree import EmptyTree, RevisionTree
1043
r = self.last_patch()
1044
if r == None:
1045
return EmptyTree(self.get_root_id())
1046
else:
1047
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1048
1049
370
return self.repository.revision_tree(self.last_revision())
1050
371
1051
372
def rename_one(self, from_rel, to_rel):
1052
373
"""Rename one file.
1053
374
1054
375
This can change the directory or the filename or both.
1055
376
"""
1056
self.lock_write()
1057
try:
1058
tree = self.working_tree()
1059
inv = tree.inventory
1060
if not tree.has_filename(from_rel):
1061
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1062
if tree.has_filename(to_rel):
1063
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1064
1065
file_id = inv.path2id(from_rel)
1066
if file_id == None:
1067
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1068
1069
if inv.path2id(to_rel):
1070
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1071
1072
to_dir, to_tail = os.path.split(to_rel)
1073
to_dir_id = inv.path2id(to_dir)
1074
if to_dir_id == None and to_dir != '':
1075
raise BzrError("can't determine destination directory id for %r" % to_dir)
1076
1077
mutter("rename_one:")
1078
mutter(" file_id {%s}" % file_id)
1079
mutter(" from_rel %r" % from_rel)
1080
mutter(" to_rel %r" % to_rel)
1081
mutter(" to_dir %r" % to_dir)
1082
mutter(" to_dir_id {%s}" % to_dir_id)
1083
1084
inv.rename(file_id, to_dir_id, to_tail)
1085
1086
print "%s => %s" % (from_rel, to_rel)
1087
1088
from_abs = self.abspath(from_rel)
1089
to_abs = self.abspath(to_rel)
1090
try:
1091
os.rename(from_abs, to_abs)
1092
except OSError, e:
1093
raise BzrError("failed to rename %r to %r: %s"
1094
% (from_abs, to_abs, e[1]),
1095
["rename rolled back"])
1096
1097
self._write_inventory(inv)
1098
finally:
1099
self.unlock()
1100
377
raise NotImplementedError('rename_one is abstract')
1101
378
1102
379
def move(self, from_paths, to_name):
1103
380
"""Rename files.
1109
386
1110
387
Note that to_name is only the last component of the new name;
1111
388
this doesn't change the directory.
1112
"""
1113
self.lock_write()
1114
try:
1115
## TODO: Option to move IDs only
1116
assert not isinstance(from_paths, basestring)
1117
tree = self.working_tree()
1118
inv = tree.inventory
1119
to_abs = self.abspath(to_name)
1120
if not isdir(to_abs):
1121
raise BzrError("destination %r is not a directory" % to_abs)
1122
if not tree.has_filename(to_name):
1123
raise BzrError("destination %r not in working directory" % to_abs)
1124
to_dir_id = inv.path2id(to_name)
1125
if to_dir_id == None and to_name != '':
1126
raise BzrError("destination %r is not a versioned directory" % to_name)
1127
to_dir_ie = inv[to_dir_id]
1128
if to_dir_ie.kind not in ('directory', 'root_directory'):
1129
raise BzrError("destination %r is not a directory" % to_abs)
1130
1131
to_idpath = inv.get_idpath(to_dir_id)
1132
1133
for f in from_paths:
1134
if not tree.has_filename(f):
1135
raise BzrError("%r does not exist in working tree" % f)
1136
f_id = inv.path2id(f)
1137
if f_id == None:
1138
raise BzrError("%r is not versioned" % f)
1139
name_tail = splitpath(f)[-1]
1140
dest_path = appendpath(to_name, name_tail)
1141
if tree.has_filename(dest_path):
1142
raise BzrError("destination %r already exists" % dest_path)
1143
if f_id in to_idpath:
1144
raise BzrError("can't move %r to a subdirectory of itself" % f)
1145
1146
# OK, so there's a race here, it's possible that someone will
1147
# create a file in this interval and then the rename might be
1148
# left half-done. But we should have caught most problems.
1149
1150
for f in from_paths:
1151
name_tail = splitpath(f)[-1]
1152
dest_path = appendpath(to_name, name_tail)
1153
print "%s => %s" % (f, dest_path)
1154
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1155
try:
1156
os.rename(self.abspath(f), self.abspath(dest_path))
1157
except OSError, e:
1158
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1159
["rename rolled back"])
1160
1161
self._write_inventory(inv)
1162
finally:
1163
self.unlock()
1164
1165
1166
def revert(self, filenames, old_tree=None, backups=True):
1167
"""Restore selected files to the versions from a previous tree.
1168
1169
backups
1170
If true (default) backups are made of files before
1171
they're renamed.
1172
"""
1173
from bzrlib.errors import NotVersionedError, BzrError
1174
from bzrlib.atomicfile import AtomicFile
1175
from bzrlib.osutils import backup_file
1176
1177
inv = self.read_working_inventory()
1178
if old_tree is None:
1179
old_tree = self.basis_tree()
1180
old_inv = old_tree.inventory
1181
1182
nids = []
1183
for fn in filenames:
1184
file_id = inv.path2id(fn)
1185
if not file_id:
1186
raise NotVersionedError("not a versioned file", fn)
1187
if not old_inv.has_id(file_id):
1188
raise BzrError("file not present in old tree", fn, file_id)
1189
nids.append((fn, file_id))
1190
1191
# TODO: Rename back if it was previously at a different location
1192
1193
# TODO: If given a directory, restore the entire contents from
1194
# the previous version.
1195
1196
# TODO: Make a backup to a temporary file.
1197
1198
# TODO: If the file previously didn't exist, delete it?
1199
for fn, file_id in nids:
1200
backup_file(fn)
1201
1202
f = AtomicFile(fn, 'wb')
1203
try:
1204
f.write(old_tree.get_file(file_id).read())
1205
f.commit()
1206
finally:
1207
f.close()
1208
1209
1210
def pending_merges(self):
1211
"""Return a list of pending merges.
1212
1213
These are revisions that have been merged into the working
1214
directory but not yet committed.
1215
"""
1216
cfn = self.controlfilename('pending-merges')
1217
if not os.path.exists(cfn):
1218
return []
1219
p = []
1220
for l in self.controlfile('pending-merges', 'r').readlines():
1221
p.append(l.rstrip('\n'))
1222
return p
1223
1224
1225
def add_pending_merge(self, revision_id):
1226
from bzrlib.revision import validate_revision_id
1227
1228
validate_revision_id(revision_id)
1229
1230
p = self.pending_merges()
1231
if revision_id in p:
1232
return
1233
p.append(revision_id)
1234
self.set_pending_merges(p)
1235
1236
1237
def set_pending_merges(self, rev_list):
1238
from bzrlib.atomicfile import AtomicFile
1239
self.lock_write()
1240
try:
1241
f = AtomicFile(self.controlfilename('pending-merges'))
1242
try:
1243
for l in rev_list:
1244
print >>f, l
1245
f.commit()
1246
finally:
1247
f.close()
1248
finally:
1249
self.unlock()
1250
1251
1252
1253
class ScratchBranch(Branch):
1254
"""Special test class: a branch that cleans up after itself.
1255
1256
>>> b = ScratchBranch()
1257
>>> isdir(b.base)
1258
True
1259
>>> bd = b.base
1260
>>> b.destroy()
1261
>>> isdir(bd)
1262
False
1263
"""
1264
def __init__(self, files=[], dirs=[], base=None):
1265
"""Make a test branch.
1266
1267
This creates a temporary directory and runs init-tree in it.
1268
1269
If any files are listed, they are created in the working copy.
1270
"""
1271
from tempfile import mkdtemp
1272
init = False
1273
if base is None:
1274
base = mkdtemp()
1275
init = True
1276
Branch.__init__(self, base, init=init)
1277
for d in dirs:
1278
os.mkdir(self.abspath(d))
1279
1280
for f in files:
1281
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1282
1283
1284
def clone(self):
1285
"""
1286
>>> orig = ScratchBranch(files=["file1", "file2"])
1287
>>> clone = orig.clone()
1288
>>> os.path.samefile(orig.base, clone.base)
1289
False
1290
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1291
True
1292
"""
1293
from shutil import copytree
1294
from tempfile import mkdtemp
1295
base = mkdtemp()
1296
os.rmdir(base)
1297
copytree(self.base, base, symlinks=True)
1298
return ScratchBranch(base=base)
1299
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)
430
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__
904
1300
905
def __del__(self):
1301
self.destroy()
1302
1303
def destroy(self):
1304
"""Destroy the test branch, removing the scratch directory."""
1305
from shutil import rmtree
1306
try:
1307
if self.base:
1308
mutter("delete ScratchBranch %s" % self.base)
1309
rmtree(self.base)
1310
except OSError, e:
1311
# Work around for shutil.rmtree failing on Windows when
1312
# readonly files are encountered
1313
mutter("hit exception in destroying ScratchBranch: %s" % e)
1314
for root, dirs, files in os.walk(self.base, topdown=False):
1315
for name in files:
1316
os.chmod(os.path.join(root, name), 0700)
1317
rmtree(self.base)
1318
self.base = None
1319
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
1259
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
1320
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
1321
1377
1322
1378
######################################################################
1323
1379
# predicates
1324
1380
1325
1381
1326
def is_control_file(filename):
1327
## FIXME: better check
1328
filename = os.path.normpath(filename)
1329
while filename != '':
1330
head, tail = os.path.split(filename)
1331
## mutter('check %r for control file' % ((head, tail), ))
1332
if tail == bzrlib.BZRDIR:
1333
return True
1334
if filename == head:
1335
break
1336
filename = head
1337
return False
1338
1339
1340
1341
def gen_file_id(name):
1342
"""Return new file id.
1343
1344
This should probably generate proper UUIDs, but for the moment we
1345
cope with just randomness because running uuidgen every time is
1346
slow."""
1347
import re
1348
from binascii import hexlify
1349
from time import time
1350
1351
# get last component
1352
idx = name.rfind('/')
1353
if idx != -1:
1354
name = name[idx+1 : ]
1355
idx = name.rfind('\\')
1356
if idx != -1:
1357
name = name[idx+1 : ]
1358
1359
# make it not a hidden file
1360
name = name.lstrip('.')
1361
1362
# remove any wierd characters; we don't escape them but rather
1363
# just pull them out
1364
name = re.sub(r'[^\w.]', '', name)
1365
1366
s = hexlify(rand_bytes(8))
1367
return '-'.join((name, compact_date(time()), s))
1368
1369
1370
def gen_root_id():
1371
"""Return a new tree-root file id."""
1372
return gen_file_id('TREE_ROOT')
1373
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)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1