« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1092.2.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1092.2.1
- Committer: Robert Collins
- Date: 2005-09-06 15:19:44 UTC
- mto: (1092.3.1)
- mto: This revision was merged to the branch mainline in revision 1397.
- Revision ID: robertc@robertcollins.net-20050906151944-04320f095a2abc31
minor refactors to store, create an ImmutableMemoryStore for testing or other such operations
- files added:
- bzrlib/mdiff.py
- notes
- patches
- files removed:
- 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/intertree_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/tree_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- tools/doc_generate
- files renamed:
- tools/doc_generate/autodoc_man.py => bzr-man.py
- bzrlib/bundle/__init__.py => bzrlib/changeset.py
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/tests/ => bzrlib/selftest/
- bzrlib/tests/blackbox/test_too_much.py => bzrlib/selftest/blackbox.py
- bzrlib/tests/test_plugins.py => bzrlib/selftest/plugins.py
- bzrlib/tests/branch_implementations/test_parent.py => bzrlib/selftest/test_parent.py
- bzrlib/tests/branch_implementations/test_branch.py => bzrlib/selftest/testbranch.py
- bzrlib/tests/test_diff.py => bzrlib/selftest/testdiff.py
- bzrlib/tests/test_fetch.py => bzrlib/selftest/testfetch.py
- bzrlib/tests/test_hashcache.py => bzrlib/selftest/testhashcache.py
- bzrlib/tests/test_inv.py => bzrlib/selftest/testinv.py
- bzrlib/tests/test_log.py => bzrlib/selftest/testlog.py
- bzrlib/tests/test_merge3.py => bzrlib/selftest/testmerge3.py
- bzrlib/tests/test_revision.py => bzrlib/selftest/testrevision.py
- bzrlib/tests/test_revisionnamespaces.py => bzrlib/selftest/testrevisionnamespaces.py
- bzrlib/tests/blackbox/test_status.py => bzrlib/selftest/teststatus.py
- bzrlib/tests/test_store.py => bzrlib/selftest/teststore.py
- bzrlib/tests/blackbox/test_versioning.py => bzrlib/selftest/versioning.py
- bzrlib/tests/test_whitebox.py => bzrlib/selftest/whitebox.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/ui/__init__.py => bzrlib/ui.py
- bzrlib/xml_serializer.py => bzrlib/xml.py
- bzrlib/upgrade.py => tools/history2weaves.py
- bzrlib/tests/test_weave.py => tools/testweave.py
- doc/tutorial.txt => tutorial.txt
- 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
import sys
19
import os
22
20
23
21
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
22
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?
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
28
import bzrlib.errors
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.xml import unpack_xml
32
from bzrlib.delta import compare_trees
33
from bzrlib.tree import EmptyTree, RevisionTree
34
import bzrlib.ui
35
36
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
54
41
55
42
# TODO: Some operations like log might retrieve the same revisions
56
43
# 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
44
# cache in memory to make this faster.
45
46
# TODO: please move the revision-string syntax stuff out of the branch
47
# object; it's clutter
48
49
50
def find_branch(f, **args):
51
if f and (f.startswith('http://') or f.startswith('https://')):
52
import remotebranch
53
return remotebranch.RemoteBranch(f, **args)
54
else:
55
return Branch(f, **args)
56
57
58
def find_cached_branch(f, cache_root, **args):
59
from remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from meta_store import CachedStore
63
cache_path = os.path.join(cache_root, store_name)
64
os.mkdir(cache_path)
65
new_store = CachedStore(getattr(br, store_name), cache_path)
66
setattr(br, store_name, new_store)
67
68
if isinstance(br, RemoteBranch):
69
cacheify(br, 'inventory_store')
70
cacheify(br, 'text_store')
71
cacheify(br, 'revision_store')
72
return br
73
74
75
def _relpath(base, path):
76
"""Return path relative to base, or raise exception.
77
78
The path may be either an absolute path or a path relative to the
79
current working directory.
80
81
Lifted out of Branch.relpath for ease of testing.
82
83
os.path.commonprefix (python2.4) has a bad bug that it works just
84
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
85
avoids that problem."""
86
rp = os.path.abspath(path)
87
88
s = []
89
head = rp
90
while len(head) >= len(base):
91
if head == base:
92
break
93
head, tail = os.path.split(head)
94
if tail:
95
s.insert(0, tail)
96
else:
97
from errors import NotBranchError
98
raise NotBranchError("path %r is not within branch %r" % (rp, base))
99
100
return os.sep.join(s)
101
102
103
def find_branch_root(f=None):
104
"""Find the branch root enclosing f, or pwd.
105
106
f may be a filename or a URL.
107
108
It is not necessary that f exists.
109
110
Basically we keep looking up until we find the control directory or
111
run into the root. If there isn't one, raises NotBranchError.
112
"""
113
if f == None:
114
f = os.getcwd()
115
elif hasattr(os.path, 'realpath'):
116
f = os.path.realpath(f)
117
else:
118
f = os.path.abspath(f)
119
if not os.path.exists(f):
120
raise BzrError('%r does not exist' % f)
121
122
123
orig_f = f
124
125
while True:
126
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
127
return f
128
head, tail = os.path.split(f)
129
if head == f:
130
# reached the root, whatever that may be
131
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
132
f = head
133
134
135
136
# XXX: move into bzrlib.errors; subclass BzrError
137
class DivergedBranches(Exception):
138
def __init__(self, branch1, branch2):
139
self.branch1 = branch1
140
self.branch2 = branch2
141
Exception.__init__(self, "These branches have diverged.")
60
142
61
143
62
144
######################################################################
66
148
"""Branch holding a history of revisions.
67
149
68
150
base
69
Base directory/url of the branch.
151
Base directory of the branch.
152
153
_lock_mode
154
None, or 'r' or 'w'
155
156
_lock_count
157
If _lock_mode is true, a positive count of the number of times the
158
lock has been taken.
159
160
_lock
161
Lock object from bzrlib.lock.
70
162
"""
71
# this is really an instance variable - FIXME move it there
72
# - RBC 20060112
73
163
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')
164
_lock_mode = None
165
_lock_count = None
166
_lock = None
167
168
# Map some sort of prefix into a namespace
169
# stuff like "revno:10", "revid:", etc.
170
# This should match a prefix with a function which accepts
171
REVISION_NAMESPACES = {}
172
173
def __init__(self, base, init=False, find_root=True):
174
"""Create new branch object at a particular location.
175
176
base -- Base directory for the branch. May be a file:// url.
177
178
init -- If True, create new control files in a previously
179
unversioned directory. If False, the branch must already
180
be versioned.
181
182
find_root -- If true and init is false, find the root of the
183
existing branch containing base.
184
185
In the test suite, creation of new trees is tested using the
186
`ScratchBranch` class.
187
"""
188
from bzrlib.store import ImmutableStore
189
if init:
190
self.base = os.path.realpath(base)
191
self._make_control()
192
elif find_root:
193
self.base = find_branch_root(base)
194
else:
195
if base.startswith("file://"):
196
base = base[7:]
197
self.base = os.path.realpath(base)
198
if not isdir(self.controlfilename('.')):
199
from errors import NotBranchError
200
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
201
['use "bzr init" to initialize a new working tree',
202
'current bzr can only operate from top-of-tree'])
203
self._check_format()
204
205
self.text_store = ImmutableStore(self.controlfilename('text-store'))
206
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
207
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
208
209
210
def __str__(self):
211
return '%s(%r)' % (self.__class__.__name__, self.base)
212
213
214
__repr__ = __str__
215
216
217
def __del__(self):
218
if self._lock_mode or self._lock:
219
from warnings import warn
220
warn("branch %r was not explicitly unlocked" % self)
221
self._lock.unlock()
154
222
155
223
def lock_write(self):
156
raise NotImplementedError('lock_write is abstract')
224
if self._lock_mode:
225
if self._lock_mode != 'w':
226
from errors import LockError
227
raise LockError("can't upgrade to a write lock from %r" %
228
self._lock_mode)
229
self._lock_count += 1
230
else:
231
from bzrlib.lock import WriteLock
232
233
self._lock = WriteLock(self.controlfilename('branch-lock'))
234
self._lock_mode = 'w'
235
self._lock_count = 1
236
157
237
158
238
def lock_read(self):
159
raise NotImplementedError('lock_read is abstract')
239
if self._lock_mode:
240
assert self._lock_mode in ('r', 'w'), \
241
"invalid lock mode %r" % self._lock_mode
242
self._lock_count += 1
243
else:
244
from bzrlib.lock import ReadLock
160
245
246
self._lock = ReadLock(self.controlfilename('branch-lock'))
247
self._lock_mode = 'r'
248
self._lock_count = 1
249
161
250
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')
251
if not self._lock_mode:
252
from errors import LockError
253
raise LockError('branch %r is not locked' % (self))
254
255
if self._lock_count > 1:
256
self._lock_count -= 1
257
else:
258
self._lock.unlock()
259
self._lock = None
260
self._lock_mode = self._lock_count = None
170
261
171
262
def abspath(self, name):
172
"""Return absolute filename for something in the branch
173
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
176
"""
177
raise NotImplementedError('abspath is abstract')
178
179
def bind(self, other):
180
"""Bind the local branch the other branch.
181
182
:param other: The branch to bind to
183
:type other: Branch
184
"""
185
raise errors.UpgradeRequired(self.base)
186
187
@needs_write_lock
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
190
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
193
of the branch.
194
:param pb: An optional progress bar to use.
195
196
Returns the copied revision count and the failed revisions in a tuple:
197
(copied, failures).
198
"""
199
if self.base == from_branch.base:
200
return (0, [])
201
if pb is None:
202
nested_pb = ui.ui_factory.nested_progress_bar()
203
pb = nested_pb
204
else:
205
nested_pb = None
206
207
from_branch.lock_read()
208
try:
209
if last_revision is None:
210
pb.update('get source history')
211
from_history = from_branch.revision_history()
212
if from_history:
213
last_revision = from_history[-1]
214
else:
215
# no history in the source branch
216
last_revision = revision.NULL_REVISION
217
return self.repository.fetch(from_branch.repository,
218
revision_id=last_revision,
219
pb=nested_pb)
220
finally:
221
if nested_pb is not None:
222
nested_pb.finished()
223
from_branch.unlock()
224
225
def get_bound_location(self):
226
"""Return the URL of the branch we are bound to.
227
228
Older format branches cannot bind, please be sure to use a metadir
229
branch.
230
"""
231
return None
232
233
def get_commit_builder(self, parents, config=None, timestamp=None,
234
timezone=None, committer=None, revprops=None,
235
revision_id=None):
236
"""Obtain a CommitBuilder for this branch.
237
238
:param parents: Revision ids of the parents of the new revision.
239
:param config: Optional configuration to use.
240
:param timestamp: Optional timestamp recorded for commit.
241
:param timezone: Optional timezone for timestamp.
242
:param committer: Optional committer to set for commit.
243
:param revprops: Optional dictionary of revision properties.
244
:param revision_id: Optional revision id.
245
"""
246
247
if config is None:
248
config = 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
263
"""Return absolute filename for something in the branch"""
264
return os.path.join(self.base, name)
265
266
def relpath(self, path):
267
"""Return path relative to this branch of something inside it.
268
269
Raises an error if path is not in this branch."""
270
return _relpath(self.base, path)
271
272
def controlfilename(self, file_or_path):
273
"""Return location relative to branch."""
274
if isinstance(file_or_path, basestring):
275
file_or_path = [file_or_path]
276
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
277
278
279
def controlfile(self, file_or_path, mode='r'):
280
"""Open a control file for this branch.
281
282
There are two classes of file in the control directory: text
283
and binary. binary files are untranslated byte streams. Text
284
control files are stored with Unix newlines and in UTF-8, even
285
if the platform or locale defaults are different.
286
287
Controlfiles should almost never be opened in write mode but
288
rather should be atomically copied and replaced using atomicfile.
289
"""
290
291
fn = self.controlfilename(file_or_path)
292
293
if mode == 'rb' or mode == 'wb':
294
return file(fn, mode)
295
elif mode == 'r' or mode == 'w':
296
# open in binary mode anyhow so there's no newline translation;
297
# codecs uses line buffering by default; don't want that.
298
import codecs
299
return codecs.open(fn, mode + 'b', 'utf-8',
300
buffering=60000)
301
else:
302
raise BzrError("invalid controlfile mode %r" % mode)
303
304
def _make_control(self):
305
from bzrlib.inventory import Inventory
306
from bzrlib.xml import pack_xml
307
308
os.mkdir(self.controlfilename([]))
309
self.controlfile('README', 'w').write(
310
"This is a Bazaar-NG control directory.\n"
311
"Do not change any files in this directory.\n")
312
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
313
for d in ('text-store', 'inventory-store', 'revision-store'):
314
os.mkdir(self.controlfilename(d))
315
for f in ('revision-history', 'merged-patches',
316
'pending-merged-patches', 'branch-name',
317
'branch-lock',
318
'pending-merges'):
319
self.controlfile(f, 'w').write('')
320
mutter('created control directory in ' + self.base)
321
322
# if we want per-tree root ids then this is the place to set
323
# them; they're not needed for now and so ommitted for
324
# simplicity.
325
pack_xml(Inventory(), self.controlfile('inventory','w'))
326
327
def _check_format(self):
328
"""Check this branch format is supported.
329
330
The current tool only supports the current unstable format.
331
332
In the future, we might need different in-memory Branch
333
classes to support downlevel branches. But not yet.
334
"""
335
# This ignores newlines so that we can open branches created
336
# on Windows from Linux and so on. I think it might be better
337
# to always make all internal files in unix format.
338
fmt = self.controlfile('branch-format', 'r').read()
339
fmt.replace('\r\n', '')
340
if fmt != BZR_BRANCH_FORMAT:
341
raise BzrError('sorry, branch format %r not supported' % fmt,
342
['use a different bzr version',
343
'or remove the .bzr directory and "bzr init" again'])
344
345
def get_root_id(self):
346
"""Return the id of this branches root"""
347
inv = self.read_working_inventory()
348
return inv.root.file_id
349
350
def set_root_id(self, file_id):
351
inv = self.read_working_inventory()
352
orig_root_id = inv.root.file_id
353
del inv._byid[inv.root.file_id]
354
inv.root.file_id = file_id
355
inv._byid[inv.root.file_id] = inv.root
356
for fid in inv:
357
entry = inv[fid]
358
if entry.parent_id in (None, orig_root_id):
359
entry.parent_id = inv.root.file_id
360
self._write_inventory(inv)
361
362
def read_working_inventory(self):
363
"""Read the working inventory."""
364
from bzrlib.inventory import Inventory
365
from bzrlib.xml import unpack_xml
366
from time import time
367
before = time()
368
self.lock_read()
369
try:
370
# ElementTree does its own conversion from UTF-8, so open in
371
# binary.
372
inv = unpack_xml(Inventory,
373
self.controlfile('inventory', 'rb'))
374
mutter("loaded inventory of %d items in %f"
375
% (len(inv), time() - before))
376
return inv
377
finally:
378
self.unlock()
379
380
381
def _write_inventory(self, inv):
382
"""Update the working inventory.
383
384
That is to say, the inventory describing changes underway, that
385
will be committed to the next revision.
386
"""
387
from bzrlib.atomicfile import AtomicFile
388
from bzrlib.xml import pack_xml
389
390
self.lock_write()
391
try:
392
f = AtomicFile(self.controlfilename('inventory'), 'wb')
393
try:
394
pack_xml(inv, f)
395
f.commit()
396
finally:
397
f.close()
398
finally:
399
self.unlock()
400
401
mutter('wrote working inventory')
402
403
404
inventory = property(read_working_inventory, _write_inventory, None,
405
"""Inventory for the working copy.""")
406
407
408
def add(self, files, ids=None):
409
"""Make files versioned.
410
411
Note that the command line normally calls smart_add instead,
412
which can automatically recurse.
413
414
This puts the files in the Added state, so that they will be
415
recorded by the next commit.
416
417
files
418
List of paths to add, relative to the base of the tree.
419
420
ids
421
If set, use these instead of automatically generated ids.
422
Must be the same length as the list of files, but may
423
contain None for ids that are to be autogenerated.
424
425
TODO: Perhaps have an option to add the ids even if the files do
426
not (yet) exist.
427
428
TODO: Perhaps yield the ids and paths as they're added.
429
"""
430
# TODO: Re-adding a file that is removed in the working copy
431
# should probably put it back with the previous ID.
432
if isinstance(files, basestring):
433
assert(ids is None or isinstance(ids, basestring))
434
files = [files]
435
if ids is not None:
436
ids = [ids]
437
438
if ids is None:
439
ids = [None] * len(files)
440
else:
441
assert(len(ids) == len(files))
442
443
self.lock_write()
444
try:
445
inv = self.read_working_inventory()
446
for f,file_id in zip(files, ids):
447
if is_control_file(f):
448
raise BzrError("cannot add control file %s" % quotefn(f))
449
450
fp = splitpath(f)
451
452
if len(fp) == 0:
453
raise BzrError("cannot add top-level %r" % f)
454
455
fullpath = os.path.normpath(self.abspath(f))
456
457
try:
458
kind = file_kind(fullpath)
459
except OSError:
460
# maybe something better?
461
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
463
if kind != 'file' and kind != 'directory':
464
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
465
466
if file_id is None:
467
file_id = gen_file_id(f)
468
inv.add_path(f, kind=kind, file_id=file_id)
469
470
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
471
472
self._write_inventory(inv)
473
finally:
474
self.unlock()
475
476
477
def print_file(self, file, revno):
478
"""Print `file` to stdout."""
479
self.lock_read()
480
try:
481
tree = self.revision_tree(self.lookup_revision(revno))
482
# use inventory as it was in that revision
483
file_id = tree.inventory.path2id(file)
484
if not file_id:
485
raise BzrError("%r is not present in revision %s" % (file, revno))
486
tree.print_file(file_id)
487
finally:
488
self.unlock()
489
490
491
def remove(self, files, verbose=False):
492
"""Mark nominated files for removal from the inventory.
493
494
This does not remove their text. This does not run on
495
496
TODO: Refuse to remove modified files unless --force is given?
497
498
TODO: Do something useful with directories.
499
500
TODO: Should this remove the text or not? Tough call; not
501
removing may be useful and the user can just use use rm, and
502
is the opposite of add. Removing it is consistent with most
503
other tools. Maybe an option.
504
"""
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
566
567
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
def get_revision_xml(self, revision_id):
585
"""Return XML file object for revision object."""
586
if not revision_id or not isinstance(revision_id, basestring):
587
raise InvalidRevisionId(revision_id)
588
589
self.lock_read()
590
try:
591
try:
592
return self.revision_store[revision_id]
593
except IndexError:
594
raise bzrlib.errors.NoSuchRevision(self, revision_id)
595
finally:
596
self.unlock()
597
598
def get_revision(self, revision_id):
599
"""Return the Revision object for a named revision"""
600
xml_file = self.get_revision_xml(revision_id)
601
602
try:
603
r = unpack_xml(Revision, xml_file)
604
except SyntaxError, e:
605
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
606
[revision_id,
607
str(e)])
608
609
assert r.revision_id == revision_id
610
return r
259
611
260
612
def get_revision_delta(self, revno):
261
613
"""Return the delta for one revision.
267
619
rh = self.revision_history()
268
620
if not (1 <= revno <= len(rh)):
269
621
raise InvalidRevisionNumber(revno)
270
return self.repository.get_revision_delta(rh[revno-1])
271
272
def get_root_id(self):
273
"""Return the id of this branches root"""
274
raise NotImplementedError('get_root_id is abstract')
275
276
def print_file(self, file, revision_id):
277
"""Print `file` to stdout."""
278
raise NotImplementedError('print_file is abstract')
279
280
def append_revision(self, *revision_ids):
281
raise NotImplementedError('append_revision is abstract')
282
283
def set_revision_history(self, rev_history):
284
raise NotImplementedError('set_revision_history is abstract')
622
623
# revno is 1-based; list is 0-based
624
625
new_tree = self.revision_tree(rh[revno-1])
626
if revno == 1:
627
old_tree = EmptyTree()
628
else:
629
old_tree = self.revision_tree(rh[revno-2])
630
631
return compare_trees(old_tree, new_tree)
632
633
634
635
def get_revision_sha1(self, revision_id):
636
"""Hash the stored value of a revision, and return it."""
637
# In the future, revision entries will be signed. At that
638
# point, it is probably best *not* to include the signature
639
# in the revision hash. Because that lets you re-sign
640
# the revision, (add signatures/remove signatures) and still
641
# have all hash pointers stay consistent.
642
# But for now, just hash the contents.
643
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
644
645
646
def get_inventory(self, inventory_id):
647
"""Get Inventory object by hash.
648
649
TODO: Perhaps for this and similar methods, take a revision
650
parameter which can be either an integer revno or a
651
string hash."""
652
from bzrlib.inventory import Inventory
653
from bzrlib.xml import unpack_xml
654
655
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
656
657
658
def get_inventory_xml(self, inventory_id):
659
"""Get inventory XML as a file object."""
660
return self.inventory_store[inventory_id]
661
662
663
def get_inventory_sha1(self, inventory_id):
664
"""Return the sha1 hash of the inventory entry
665
"""
666
return sha_file(self.get_inventory_xml(inventory_id))
667
668
669
def get_revision_inventory(self, revision_id):
670
"""Return inventory of a past revision."""
671
# bzr 0.0.6 imposes the constraint that the inventory_id
672
# must be the same as its revision, so this is trivial.
673
if revision_id == None:
674
from bzrlib.inventory import Inventory
675
return Inventory(self.get_root_id())
676
else:
677
return self.get_inventory(revision_id)
678
285
679
286
680
def revision_history(self):
287
"""Return sequence of revision hashes on to this branch."""
288
raise NotImplementedError('revision_history is abstract')
681
"""Return sequence of revision hashes on to this branch.
682
683
>>> ScratchBranch().revision_history()
684
[]
685
"""
686
self.lock_read()
687
try:
688
return [l.rstrip('\r\n') for l in
689
self.controlfile('revision-history', 'r').readlines()]
690
finally:
691
self.unlock()
692
693
694
def common_ancestor(self, other, self_revno=None, other_revno=None):
695
"""
696
>>> import commit
697
>>> sb = ScratchBranch(files=['foo', 'foo~'])
698
>>> sb.common_ancestor(sb) == (None, None)
699
True
700
>>> commit.commit(sb, "Committing first revision", verbose=False)
701
>>> sb.common_ancestor(sb)[0]
702
1
703
>>> clone = sb.clone()
704
>>> commit.commit(sb, "Committing second revision", verbose=False)
705
>>> sb.common_ancestor(sb)[0]
706
2
707
>>> sb.common_ancestor(clone)[0]
708
1
709
>>> commit.commit(clone, "Committing divergent second revision",
710
... verbose=False)
711
>>> sb.common_ancestor(clone)[0]
712
1
713
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
714
True
715
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
716
True
717
>>> clone2 = sb.clone()
718
>>> sb.common_ancestor(clone2)[0]
719
2
720
>>> sb.common_ancestor(clone2, self_revno=1)[0]
721
1
722
>>> sb.common_ancestor(clone2, other_revno=1)[0]
723
1
724
"""
725
my_history = self.revision_history()
726
other_history = other.revision_history()
727
if self_revno is None:
728
self_revno = len(my_history)
729
if other_revno is None:
730
other_revno = len(other_history)
731
indices = range(min((self_revno, other_revno)))
732
indices.reverse()
733
for r in indices:
734
if my_history[r] == other_history[r]:
735
return r+1, my_history[r]
736
return None, None
737
289
738
290
739
def revno(self):
291
740
"""Return current revision number for this branch.
295
744
"""
296
745
return len(self.revision_history())
297
746
298
def unbind(self):
299
"""Older format branches cannot bind or unbind."""
300
raise errors.UpgradeRequired(self.base)
301
747
302
def last_revision(self):
303
"""Return last patch hash, or None if no history."""
748
def last_patch(self):
749
"""Return last patch hash, or None if no history.
750
"""
304
751
ph = self.revision_history()
305
752
if ph:
306
753
return ph[-1]
307
754
else:
308
755
return None
309
756
310
def missing_revisions(self, other, stop_revision=None):
311
"""Return a list of new revisions that would perfectly fit.
312
757
758
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
759
"""
313
760
If self and other have not diverged, return a list of the revisions
314
761
present in other, but missing from self.
762
763
>>> from bzrlib.commit import commit
764
>>> bzrlib.trace.silent = True
765
>>> br1 = ScratchBranch()
766
>>> br2 = ScratchBranch()
767
>>> br1.missing_revisions(br2)
768
[]
769
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
770
>>> br1.missing_revisions(br2)
771
[u'REVISION-ID-1']
772
>>> br2.missing_revisions(br1)
773
[]
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
775
>>> br1.missing_revisions(br2)
776
[]
777
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
778
>>> br1.missing_revisions(br2)
779
[u'REVISION-ID-2A']
780
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
781
>>> br1.missing_revisions(br2)
782
Traceback (most recent call last):
783
DivergedBranches: These branches have diverged.
315
784
"""
316
785
self_history = self.revision_history()
317
786
self_len = len(self_history)
324
793
325
794
if stop_revision is None:
326
795
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)
796
elif stop_revision > other_len:
797
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
798
331
799
return other_history[self_len:stop_revision]
332
800
801
333
802
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
803
"""Pull in all new revisions from other branch.
339
804
"""
340
raise NotImplementedError('update_revisions is abstract')
805
from bzrlib.fetch import greedy_fetch
806
807
pb = bzrlib.ui.ui_factory.progress_bar()
808
pb.update('comparing histories')
809
810
revision_ids = self.missing_revisions(other, stop_revision)
811
812
if len(revision_ids) > 0:
813
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
814
else:
815
count = 0
816
self.append_revision(*revision_ids)
817
## note("Added %d revisions." % count)
818
pb.clear()
819
820
def install_revisions(self, other, revision_ids, pb):
821
if hasattr(other.revision_store, "prefetch"):
822
other.revision_store.prefetch(revision_ids)
823
if hasattr(other.inventory_store, "prefetch"):
824
inventory_ids = [other.get_revision(r).inventory_id
825
for r in revision_ids]
826
other.inventory_store.prefetch(inventory_ids)
827
828
if pb is None:
829
pb = bzrlib.ui.ui_factory.progress_bar()
830
831
revisions = []
832
needed_texts = set()
833
i = 0
834
835
failures = set()
836
for i, rev_id in enumerate(revision_ids):
837
pb.update('fetching revision', i+1, len(revision_ids))
838
try:
839
rev = other.get_revision(rev_id)
840
except bzrlib.errors.NoSuchRevision:
841
failures.add(rev_id)
842
continue
843
844
revisions.append(rev)
845
inv = other.get_inventory(str(rev.inventory_id))
846
for key, entry in inv.iter_entries():
847
if entry.text_id is None:
848
continue
849
if entry.text_id not in self.text_store:
850
needed_texts.add(entry.text_id)
851
852
pb.clear()
853
854
count, cp_fail = self.text_store.copy_multi(other.text_store,
855
needed_texts)
856
#print "Added %d texts." % count
857
inventory_ids = [ f.inventory_id for f in revisions ]
858
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
859
inventory_ids)
860
#print "Added %d inventories." % count
861
revision_ids = [ f.revision_id for f in revisions]
862
863
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
864
revision_ids,
865
permit_failure=True)
866
assert len(cp_fail) == 0
867
return count, failures
868
869
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
873
874
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self._get_revision_info(revision)
878
return info
879
341
880
342
881
def revision_id_to_revno(self, revision_id):
343
882
"""Given a revision id, return its revno"""
344
if revision_id is None:
345
return 0
346
883
history = self.revision_history()
347
884
try:
348
885
return history.index(revision_id) + 1
349
886
except ValueError:
350
887
raise bzrlib.errors.NoSuchRevision(self, revision_id)
351
888
889
890
def get_revision_info(self, revision):
891
"""Return (revno, revision id) for revision identifier.
892
893
revision can be an integer, in which case it is assumed to be revno (though
894
this will translate negative values into positive ones)
895
revision can also be a string, in which case it is parsed for something like
896
'date:' or 'revid:' etc.
897
"""
898
revno, rev_id = self._get_revision_info(revision)
899
if revno is None:
900
raise bzrlib.errors.NoSuchRevision(self, revision)
901
return revno, rev_id
902
352
903
def get_rev_id(self, revno, history=None):
353
904
"""Find the revision id of the specified revno."""
354
905
if revno == 0:
359
910
raise bzrlib.errors.NoSuchRevision(self, revno)
360
911
return history[revno - 1]
361
912
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
913
def _get_revision_info(self, revision):
914
"""Return (revno, revision id) for revision specifier.
915
916
revision can be an integer, in which case it is assumed to be revno
917
(though this will translate negative values into positive ones)
918
revision can also be a string, in which case it is parsed for something
919
like 'date:' or 'revid:' etc.
920
921
A revid is always returned. If it is None, the specifier referred to
922
the null revision. If the revid does not occur in the revision
923
history, revno will be None.
924
"""
925
926
if revision is None:
927
return 0, None
928
revno = None
929
try:# Convert to int if possible
930
revision = int(revision)
931
except ValueError:
932
pass
933
revs = self.revision_history()
934
if isinstance(revision, int):
935
if revision < 0:
936
revno = len(revs) + revision + 1
937
else:
938
revno = revision
939
rev_id = self.get_rev_id(revno, revs)
940
elif isinstance(revision, basestring):
941
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
942
if revision.startswith(prefix):
943
result = func(self, revs, revision)
944
if len(result) > 1:
945
revno, rev_id = result
946
else:
947
revno = result[0]
948
rev_id = self.get_rev_id(revno, revs)
949
break
950
else:
951
raise BzrError('No namespace registered for string: %r' %
952
revision)
953
else:
954
raise TypeError('Unhandled revision type %s' % revision)
955
956
if revno is None:
957
if rev_id is None:
958
raise bzrlib.errors.NoSuchRevision(self, revision)
959
return revno, rev_id
960
961
def _namespace_revno(self, revs, revision):
962
"""Lookup a revision by revision number"""
963
assert revision.startswith('revno:')
964
try:
965
return (int(revision[6:]),)
966
except ValueError:
967
return None
968
REVISION_NAMESPACES['revno:'] = _namespace_revno
969
970
def _namespace_revid(self, revs, revision):
971
assert revision.startswith('revid:')
972
rev_id = revision[len('revid:'):]
973
try:
974
return revs.index(rev_id) + 1, rev_id
975
except ValueError:
976
return None, rev_id
977
REVISION_NAMESPACES['revid:'] = _namespace_revid
978
979
def _namespace_last(self, revs, revision):
980
assert revision.startswith('last:')
981
try:
982
offset = int(revision[5:])
983
except ValueError:
984
return (None,)
985
else:
986
if offset <= 0:
987
raise BzrError('You must supply a positive value for --revision last:XXX')
988
return (len(revs) - offset + 1,)
989
REVISION_NAMESPACES['last:'] = _namespace_last
990
991
def _namespace_tag(self, revs, revision):
992
assert revision.startswith('tag:')
993
raise BzrError('tag: namespace registered, but not implemented.')
994
REVISION_NAMESPACES['tag:'] = _namespace_tag
995
996
def _namespace_date(self, revs, revision):
997
assert revision.startswith('date:')
998
import datetime
999
# Spec for date revisions:
1000
# date:value
1001
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1002
# it can also start with a '+/-/='. '+' says match the first
1003
# entry after the given date. '-' is match the first entry before the date
1004
# '=' is match the first entry after, but still on the given date.
1005
#
1006
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1007
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1008
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1009
# May 13th, 2005 at 0:00
1010
#
1011
# So the proper way of saying 'give me all entries for today' is:
1012
# -r {date:+today}:{date:-tomorrow}
1013
# The default is '=' when not supplied
1014
val = revision[5:]
1015
match_style = '='
1016
if val[:1] in ('+', '-', '='):
1017
match_style = val[:1]
1018
val = val[1:]
1019
1020
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1021
if val.lower() == 'yesterday':
1022
dt = today - datetime.timedelta(days=1)
1023
elif val.lower() == 'today':
1024
dt = today
1025
elif val.lower() == 'tomorrow':
1026
dt = today + datetime.timedelta(days=1)
1027
else:
1028
import re
1029
# This should be done outside the function to avoid recompiling it.
1030
_date_re = re.compile(
1031
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1032
r'(,|T)?\s*'
1033
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1034
)
1035
m = _date_re.match(val)
1036
if not m or (not m.group('date') and not m.group('time')):
1037
raise BzrError('Invalid revision date %r' % revision)
1038
1039
if m.group('date'):
1040
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1041
else:
1042
year, month, day = today.year, today.month, today.day
1043
if m.group('time'):
1044
hour = int(m.group('hour'))
1045
minute = int(m.group('minute'))
1046
if m.group('second'):
1047
second = int(m.group('second'))
1048
else:
1049
second = 0
1050
else:
1051
hour, minute, second = 0,0,0
1052
1053
dt = datetime.datetime(year=year, month=month, day=day,
1054
hour=hour, minute=minute, second=second)
1055
first = dt
1056
last = None
1057
reversed = False
1058
if match_style == '-':
1059
reversed = True
1060
elif match_style == '=':
1061
last = dt + datetime.timedelta(days=1)
1062
1063
if reversed:
1064
for i in range(len(revs)-1, -1, -1):
1065
r = self.get_revision(revs[i])
1066
# TODO: Handle timezone.
1067
dt = datetime.datetime.fromtimestamp(r.timestamp)
1068
if first >= dt and (last is None or dt >= last):
1069
return (i+1,)
1070
else:
1071
for i in range(len(revs)):
1072
r = self.get_revision(revs[i])
1073
# TODO: Handle timezone.
1074
dt = datetime.datetime.fromtimestamp(r.timestamp)
1075
if first <= dt and (last is None or dt <= last):
1076
return (i+1,)
1077
REVISION_NAMESPACES['date:'] = _namespace_date
1078
1079
def revision_tree(self, revision_id):
1080
"""Return Tree for a revision on this branch.
1081
1082
`revision_id` may be None for the null revision, in which case
1083
an `EmptyTree` is returned."""
1084
# TODO: refactor this to use an existing revision object
1085
# so we don't need to read it in twice.
1086
if revision_id == None:
1087
return EmptyTree()
1088
else:
1089
inv = self.get_revision_inventory(revision_id)
1090
return RevisionTree(self.text_store, inv)
1091
1092
1093
def working_tree(self):
1094
"""Return a `Tree` for the working copy."""
1095
from workingtree import WorkingTree
1096
return WorkingTree(self.base, self.read_working_inventory())
1097
364
1098
365
1099
def basis_tree(self):
366
"""Return `Tree` object for last revision."""
367
return self.repository.revision_tree(self.last_revision())
1100
"""Return `Tree` object for last revision.
1101
1102
If there are no revisions yet, return an `EmptyTree`.
1103
"""
1104
r = self.last_patch()
1105
if r == None:
1106
return EmptyTree()
1107
else:
1108
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1109
1110
368
1111
369
1112
def rename_one(self, from_rel, to_rel):
370
1113
"""Rename one file.
371
1114
372
1115
This can change the directory or the filename or both.
373
1116
"""
374
raise NotImplementedError('rename_one is abstract')
1117
self.lock_write()
1118
try:
1119
tree = self.working_tree()
1120
inv = tree.inventory
1121
if not tree.has_filename(from_rel):
1122
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1123
if tree.has_filename(to_rel):
1124
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1125
1126
file_id = inv.path2id(from_rel)
1127
if file_id == None:
1128
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1129
1130
if inv.path2id(to_rel):
1131
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1132
1133
to_dir, to_tail = os.path.split(to_rel)
1134
to_dir_id = inv.path2id(to_dir)
1135
if to_dir_id == None and to_dir != '':
1136
raise BzrError("can't determine destination directory id for %r" % to_dir)
1137
1138
mutter("rename_one:")
1139
mutter(" file_id {%s}" % file_id)
1140
mutter(" from_rel %r" % from_rel)
1141
mutter(" to_rel %r" % to_rel)
1142
mutter(" to_dir %r" % to_dir)
1143
mutter(" to_dir_id {%s}" % to_dir_id)
1144
1145
inv.rename(file_id, to_dir_id, to_tail)
1146
1147
from_abs = self.abspath(from_rel)
1148
to_abs = self.abspath(to_rel)
1149
try:
1150
os.rename(from_abs, to_abs)
1151
except OSError, e:
1152
raise BzrError("failed to rename %r to %r: %s"
1153
% (from_abs, to_abs, e[1]),
1154
["rename rolled back"])
1155
1156
self._write_inventory(inv)
1157
finally:
1158
self.unlock()
1159
375
1160
376
1161
def move(self, from_paths, to_name):
377
1162
"""Rename files.
387
1172
This returns a list of (from_path, to_path) pairs for each
388
1173
entry that is moved.
389
1174
"""
390
raise NotImplementedError('move is abstract')
1175
result = []
1176
self.lock_write()
1177
try:
1178
## TODO: Option to move IDs only
1179
assert not isinstance(from_paths, basestring)
1180
tree = self.working_tree()
1181
inv = tree.inventory
1182
to_abs = self.abspath(to_name)
1183
if not isdir(to_abs):
1184
raise BzrError("destination %r is not a directory" % to_abs)
1185
if not tree.has_filename(to_name):
1186
raise BzrError("destination %r not in working directory" % to_abs)
1187
to_dir_id = inv.path2id(to_name)
1188
if to_dir_id == None and to_name != '':
1189
raise BzrError("destination %r is not a versioned directory" % to_name)
1190
to_dir_ie = inv[to_dir_id]
1191
if to_dir_ie.kind not in ('directory', 'root_directory'):
1192
raise BzrError("destination %r is not a directory" % to_abs)
1193
1194
to_idpath = inv.get_idpath(to_dir_id)
1195
1196
for f in from_paths:
1197
if not tree.has_filename(f):
1198
raise BzrError("%r does not exist in working tree" % f)
1199
f_id = inv.path2id(f)
1200
if f_id == None:
1201
raise BzrError("%r is not versioned" % f)
1202
name_tail = splitpath(f)[-1]
1203
dest_path = appendpath(to_name, name_tail)
1204
if tree.has_filename(dest_path):
1205
raise BzrError("destination %r already exists" % dest_path)
1206
if f_id in to_idpath:
1207
raise BzrError("can't move %r to a subdirectory of itself" % f)
1208
1209
# OK, so there's a race here, it's possible that someone will
1210
# create a file in this interval and then the rename might be
1211
# left half-done. But we should have caught most problems.
1212
1213
for f in from_paths:
1214
name_tail = splitpath(f)[-1]
1215
dest_path = appendpath(to_name, name_tail)
1216
result.append((f, dest_path))
1217
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1218
try:
1219
os.rename(self.abspath(f), self.abspath(dest_path))
1220
except OSError, e:
1221
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1222
["rename rolled back"])
1223
1224
self._write_inventory(inv)
1225
finally:
1226
self.unlock()
1227
1228
return result
1229
1230
1231
def revert(self, filenames, old_tree=None, backups=True):
1232
"""Restore selected files to the versions from a previous tree.
1233
1234
backups
1235
If true (default) backups are made of files before
1236
they're renamed.
1237
"""
1238
from bzrlib.errors import NotVersionedError, BzrError
1239
from bzrlib.atomicfile import AtomicFile
1240
from bzrlib.osutils import backup_file
1241
1242
inv = self.read_working_inventory()
1243
if old_tree is None:
1244
old_tree = self.basis_tree()
1245
old_inv = old_tree.inventory
1246
1247
nids = []
1248
for fn in filenames:
1249
file_id = inv.path2id(fn)
1250
if not file_id:
1251
raise NotVersionedError("not a versioned file", fn)
1252
if not old_inv.has_id(file_id):
1253
raise BzrError("file not present in old tree", fn, file_id)
1254
nids.append((fn, file_id))
1255
1256
# TODO: Rename back if it was previously at a different location
1257
1258
# TODO: If given a directory, restore the entire contents from
1259
# the previous version.
1260
1261
# TODO: Make a backup to a temporary file.
1262
1263
# TODO: If the file previously didn't exist, delete it?
1264
for fn, file_id in nids:
1265
backup_file(fn)
1266
1267
f = AtomicFile(fn, 'wb')
1268
try:
1269
f.write(old_tree.get_file(file_id).read())
1270
f.commit()
1271
finally:
1272
f.close()
1273
1274
1275
def pending_merges(self):
1276
"""Return a list of pending merges.
1277
1278
These are revisions that have been merged into the working
1279
directory but not yet committed.
1280
"""
1281
cfn = self.controlfilename('pending-merges')
1282
if not os.path.exists(cfn):
1283
return []
1284
p = []
1285
for l in self.controlfile('pending-merges', 'r').readlines():
1286
p.append(l.rstrip('\n'))
1287
return p
1288
1289
1290
def add_pending_merge(self, revision_id):
1291
from bzrlib.revision import validate_revision_id
1292
1293
validate_revision_id(revision_id)
1294
1295
p = self.pending_merges()
1296
if revision_id in p:
1297
return
1298
p.append(revision_id)
1299
self.set_pending_merges(p)
1300
1301
1302
def set_pending_merges(self, rev_list):
1303
from bzrlib.atomicfile import AtomicFile
1304
self.lock_write()
1305
try:
1306
f = AtomicFile(self.controlfilename('pending-merges'))
1307
try:
1308
for l in rev_list:
1309
print >>f, l
1310
f.commit()
1311
finally:
1312
f.close()
1313
finally:
1314
self.unlock()
1315
391
1316
392
1317
def get_parent(self):
393
1318
"""Return the parent location of the branch.
396
1321
pattern is that the user can override it by specifying a
397
1322
location.
398
1323
"""
399
raise NotImplementedError('get_parent is abstract')
400
401
def get_submit_branch(self):
402
"""Return the submit location of the branch.
403
404
This is the default location for bundle. The usual
405
pattern is that the user can override it by specifying a
406
location.
407
"""
408
return self.get_config().get_user_option('submit_branch')
409
410
def set_submit_branch(self, location):
411
"""Return the submit location of the branch.
412
413
This is the default location for bundle. The usual
414
pattern is that the user can override it by specifying a
415
location.
416
"""
417
self.get_config().set_user_option('submit_branch', location)
418
419
def get_push_location(self):
420
"""Return the None or the location to push this branch to."""
421
raise NotImplementedError('get_push_location is abstract')
422
423
def set_push_location(self, location):
424
"""Set a new push location for this branch."""
425
raise NotImplementedError('set_push_location is abstract')
1324
import errno
1325
_locs = ['parent', 'pull', 'x-pull']
1326
for l in _locs:
1327
try:
1328
return self.controlfile(l, 'r').read().strip('\n')
1329
except IOError, e:
1330
if e.errno != errno.ENOENT:
1331
raise
1332
return None
1333
426
1334
427
1335
def set_parent(self, url):
428
raise NotImplementedError('set_parent is abstract')
429
430
@needs_write_lock
431
def update(self):
432
"""Synchronise this branch with the master branch if any.
433
434
:return: None or the last_revision pivoted out during the update.
435
"""
436
return None
1336
# TODO: Maybe delete old location files?
1337
from bzrlib.atomicfile import AtomicFile
1338
self.lock_write()
1339
try:
1340
f = AtomicFile(self.controlfilename('parent'))
1341
try:
1342
f.write(url + '\n')
1343
f.commit()
1344
finally:
1345
f.close()
1346
finally:
1347
self.unlock()
437
1348
438
1349
def check_revno(self, revno):
439
1350
"""\
450
1361
"""
451
1362
if revno < 1 or revno > self.revno():
452
1363
raise InvalidRevisionNumber(revno)
453
454
@needs_read_lock
455
def clone(self, *args, **kwargs):
456
"""Clone this branch into to_bzrdir preserving all semantic values.
457
458
revision_id: if not None, the revision history in the new branch will
459
be truncated to end with revision_id.
460
"""
461
# for API compatibility, until 0.8 releases we provide the old api:
462
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
463
# after 0.8 releases, the *args and **kwargs should be changed:
464
# def clone(self, to_bzrdir, revision_id=None):
465
if (kwargs.get('to_location', None) or
466
kwargs.get('revision', None) or
467
kwargs.get('basis_branch', None) or
468
(len(args) and isinstance(args[0], basestring))):
469
# backwards compatibility api:
470
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
471
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
472
# get basis_branch
473
if len(args) > 2:
474
basis_branch = args[2]
475
else:
476
basis_branch = kwargs.get('basis_branch', None)
477
if basis_branch:
478
basis = basis_branch.bzrdir
479
else:
480
basis = None
481
# get revision
482
if len(args) > 1:
483
revision_id = args[1]
484
else:
485
revision_id = kwargs.get('revision', None)
486
# get location
487
if len(args):
488
url = args[0]
489
else:
490
# no default to raise if not provided.
491
url = kwargs.get('to_location')
492
return self.bzrdir.clone(url,
493
revision_id=revision_id,
494
basis=basis).open_branch()
495
# new cleaner api.
496
# generate args by hand
497
if len(args) > 1:
498
revision_id = args[1]
499
else:
500
revision_id = kwargs.get('revision_id', None)
501
if len(args):
502
to_bzrdir = args[0]
503
else:
504
# no default to raise if not provided.
505
to_bzrdir = kwargs.get('to_bzrdir')
506
result = self._format.initialize(to_bzrdir)
507
self.copy_content_into(result, revision_id=revision_id)
508
return result
509
510
@needs_read_lock
511
def sprout(self, to_bzrdir, revision_id=None):
512
"""Create a new line of development from the branch, into to_bzrdir.
513
514
revision_id: if not None, the revision history in the new branch will
515
be truncated to end with revision_id.
516
"""
517
result = self._format.initialize(to_bzrdir)
518
self.copy_content_into(result, revision_id=revision_id)
519
result.set_parent(self.bzrdir.root_transport.base)
520
return result
521
522
@needs_read_lock
523
def copy_content_into(self, destination, revision_id=None):
524
"""Copy the content of self into destination.
525
526
revision_id: if not None, the revision history in the new branch will
527
be truncated to end with revision_id.
528
"""
529
new_history = self.revision_history()
530
if revision_id is not None:
531
try:
532
new_history = new_history[:new_history.index(revision_id) + 1]
533
except ValueError:
534
rev = self.repository.get_revision(revision_id)
535
new_history = rev.get_history(self.repository)[1:]
536
destination.set_revision_history(new_history)
537
parent = self.get_parent()
538
if parent:
539
destination.set_parent(parent)
540
541
@needs_read_lock
542
def check(self):
543
"""Check consistency of the branch.
544
545
In particular this checks that revisions given in the revision-history
546
do actually match up in the revision graph, and that they're all
547
present in the repository.
548
549
Callers will typically also want to check the repository.
550
551
:return: A BranchCheckResult.
552
"""
553
mainline_parent_id = None
554
for revision_id in self.revision_history():
555
try:
556
revision = self.repository.get_revision(revision_id)
557
except errors.NoSuchRevision, e:
558
raise errors.BzrCheckError("mainline revision {%s} not in repository"
559
% revision_id)
560
# In general the first entry on the revision history has no parents.
561
# But it's not illegal for it to have parents listed; this can happen
562
# in imports from Arch when the parents weren't reachable.
563
if mainline_parent_id is not None:
564
if mainline_parent_id not in revision.parent_ids:
565
raise errors.BzrCheckError("previous revision {%s} not listed among "
566
"parents of {%s}"
567
% (mainline_parent_id, revision_id))
568
mainline_parent_id = revision_id
569
return BranchCheckResult(self)
570
571
572
class BranchFormat(object):
573
"""An encapsulation of the initialization and open routines for a format.
574
575
Formats provide three things:
576
* An initialization routine,
577
* a format string,
578
* an open routine.
579
580
Formats are placed in an dict by their format string for reference
581
during branch opening. Its not required that these be instances, they
582
can be classes themselves with class methods - it simply depends on
583
whether state is needed for a given format or not.
584
585
Once a format is deprecated, just deprecate the initialize and open
586
methods on the format class. Do not deprecate the object, as the
587
object will be created every time regardless.
588
"""
589
590
_default_format = None
591
"""The default format used for new branches."""
592
593
_formats = {}
594
"""The known formats."""
595
596
@classmethod
597
def find_format(klass, a_bzrdir):
598
"""Return the format for the branch object in a_bzrdir."""
599
try:
600
transport = a_bzrdir.get_branch_transport(None)
601
format_string = transport.get("format").read()
602
return klass._formats[format_string]
603
except NoSuchFile:
604
raise NotBranchError(path=transport.base)
605
except KeyError:
606
raise errors.UnknownFormatError(format=format_string)
607
608
@classmethod
609
def get_default_format(klass):
610
"""Return the current default format."""
611
return klass._default_format
612
613
def get_format_string(self):
614
"""Return the ASCII format string that identifies this format."""
615
raise NotImplementedError(self.get_format_string)
616
617
def get_format_description(self):
618
"""Return the short format description for this format."""
619
raise NotImplementedError(self.get_format_string)
620
621
def initialize(self, a_bzrdir):
622
"""Create a branch of this format in a_bzrdir."""
623
raise NotImplementedError(self.initialize)
624
625
def is_supported(self):
626
"""Is this format supported?
627
628
Supported formats can be initialized and opened.
629
Unsupported formats may not support initialization or committing or
630
some other features depending on the reason for not being supported.
631
"""
632
return True
633
634
def open(self, a_bzrdir, _found=False):
635
"""Return the branch object for a_bzrdir
636
637
_found is a private parameter, do not use it. It is used to indicate
638
if format probing has already be done.
639
"""
640
raise NotImplementedError(self.open)
641
642
@classmethod
643
def register_format(klass, format):
644
klass._formats[format.get_format_string()] = format
645
646
@classmethod
647
def set_default_format(klass, format):
648
klass._default_format = format
649
650
@classmethod
651
def unregister_format(klass, format):
652
assert klass._formats[format.get_format_string()] is format
653
del klass._formats[format.get_format_string()]
654
655
def __str__(self):
656
return self.get_format_string().rstrip()
657
658
659
class BzrBranchFormat4(BranchFormat):
660
"""Bzr branch format 4.
661
662
This format has:
663
- a revision-history file.
664
- a branch-lock lock file [ to be shared with the bzrdir ]
665
"""
666
667
def get_format_description(self):
668
"""See BranchFormat.get_format_description()."""
669
return "Branch format 4"
670
671
def initialize(self, a_bzrdir):
672
"""Create a branch of this format in a_bzrdir."""
673
mutter('creating branch in %s', a_bzrdir.transport.base)
674
branch_transport = a_bzrdir.get_branch_transport(self)
675
utf8_files = [('revision-history', ''),
676
('branch-name', ''),
677
]
678
control_files = LockableFiles(branch_transport, 'branch-lock',
679
TransportLock)
680
control_files.create_lock()
681
control_files.lock_write()
682
try:
683
for file, content in utf8_files:
684
control_files.put_utf8(file, content)
685
finally:
686
control_files.unlock()
687
return self.open(a_bzrdir, _found=True)
688
689
def __init__(self):
690
super(BzrBranchFormat4, self).__init__()
691
self._matchingbzrdir = bzrdir.BzrDirFormat6()
692
693
def open(self, a_bzrdir, _found=False):
694
"""Return the branch object for a_bzrdir
695
696
_found is a private parameter, do not use it. It is used to indicate
697
if format probing has already be done.
698
"""
699
if not _found:
700
# we are being called directly and must probe.
701
raise NotImplementedError
702
return BzrBranch(_format=self,
703
_control_files=a_bzrdir._control_files,
704
a_bzrdir=a_bzrdir,
705
_repository=a_bzrdir.open_repository())
706
707
def __str__(self):
708
return "Bazaar-NG branch format 4"
709
710
711
class BzrBranchFormat5(BranchFormat):
712
"""Bzr branch format 5.
713
714
This format has:
715
- a revision-history file.
716
- a format string
717
- a lock dir guarding the branch itself
718
- all of this stored in a branch/ subdirectory
719
- works with shared repositories.
720
721
This format is new in bzr 0.8.
722
"""
723
724
def get_format_string(self):
725
"""See BranchFormat.get_format_string()."""
726
return "Bazaar-NG branch format 5\n"
727
728
def get_format_description(self):
729
"""See BranchFormat.get_format_description()."""
730
return "Branch format 5"
731
732
def initialize(self, a_bzrdir):
733
"""Create a branch of this format in a_bzrdir."""
734
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
735
branch_transport = a_bzrdir.get_branch_transport(self)
736
utf8_files = [('revision-history', ''),
737
('branch-name', ''),
738
]
739
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
740
control_files.create_lock()
741
control_files.lock_write()
742
control_files.put_utf8('format', self.get_format_string())
743
try:
744
for file, content in utf8_files:
745
control_files.put_utf8(file, content)
746
finally:
747
control_files.unlock()
748
return self.open(a_bzrdir, _found=True, )
749
750
def __init__(self):
751
super(BzrBranchFormat5, self).__init__()
752
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
753
754
def open(self, a_bzrdir, _found=False):
755
"""Return the branch object for a_bzrdir
756
757
_found is a private parameter, do not use it. It is used to indicate
758
if format probing has already be done.
759
"""
760
if not _found:
761
format = BranchFormat.find_format(a_bzrdir)
762
assert format.__class__ == self.__class__
763
transport = a_bzrdir.get_branch_transport(None)
764
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
765
return BzrBranch5(_format=self,
766
_control_files=control_files,
767
a_bzrdir=a_bzrdir,
768
_repository=a_bzrdir.find_repository())
769
770
def __str__(self):
771
return "Bazaar-NG Metadir branch format 5"
772
773
774
class BranchReferenceFormat(BranchFormat):
775
"""Bzr branch reference format.
776
777
Branch references are used in implementing checkouts, they
778
act as an alias to the real branch which is at some other url.
779
780
This format has:
781
- A location file
782
- a format string
783
"""
784
785
def get_format_string(self):
786
"""See BranchFormat.get_format_string()."""
787
return "Bazaar-NG Branch Reference Format 1\n"
788
789
def get_format_description(self):
790
"""See BranchFormat.get_format_description()."""
791
return "Checkout reference format 1"
792
793
def initialize(self, a_bzrdir, target_branch=None):
794
"""Create a branch of this format in a_bzrdir."""
795
if target_branch is None:
796
# this format does not implement branch itself, thus the implicit
797
# creation contract must see it as uninitializable
798
raise errors.UninitializableFormat(self)
799
mutter('creating branch reference in %s', a_bzrdir.transport.base)
800
branch_transport = a_bzrdir.get_branch_transport(self)
801
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
802
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
803
branch_transport.put('format', StringIO(self.get_format_string()))
804
return self.open(a_bzrdir, _found=True)
805
806
def __init__(self):
807
super(BranchReferenceFormat, self).__init__()
808
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
809
810
def _make_reference_clone_function(format, a_branch):
811
"""Create a clone() routine for a branch dynamically."""
812
def clone(to_bzrdir, revision_id=None):
813
"""See Branch.clone()."""
814
return format.initialize(to_bzrdir, a_branch)
815
# cannot obey revision_id limits when cloning a reference ...
816
# FIXME RBC 20060210 either nuke revision_id for clone, or
817
# emit some sort of warning/error to the caller ?!
818
return clone
819
820
def open(self, a_bzrdir, _found=False):
821
"""Return the branch that the branch reference in a_bzrdir points at.
822
823
_found is a private parameter, do not use it. It is used to indicate
824
if format probing has already be done.
825
"""
826
if not _found:
827
format = BranchFormat.find_format(a_bzrdir)
828
assert format.__class__ == self.__class__
829
transport = a_bzrdir.get_branch_transport(None)
830
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
831
result = real_bzrdir.open_branch()
832
# this changes the behaviour of result.clone to create a new reference
833
# rather than a copy of the content of the branch.
834
# I did not use a proxy object because that needs much more extensive
835
# testing, and we are only changing one behaviour at the moment.
836
# If we decide to alter more behaviours - i.e. the implicit nickname
837
# then this should be refactored to introduce a tested proxy branch
838
# and a subclass of that for use in overriding clone() and ....
839
# - RBC 20060210
840
result.clone = self._make_reference_clone_function(result)
841
return result
842
843
844
# formats which have no format string are not discoverable
845
# and not independently creatable, so are not registered.
846
__default_format = BzrBranchFormat5()
847
BranchFormat.register_format(__default_format)
848
BranchFormat.register_format(BranchReferenceFormat())
849
BranchFormat.set_default_format(__default_format)
850
_legacy_formats = [BzrBranchFormat4(),
851
]
852
853
class BzrBranch(Branch):
854
"""A branch stored in the actual filesystem.
855
856
Note that it's "local" in the context of the filesystem; it doesn't
857
really matter if it's on an nfs/smb/afs/coda/... share, as long as
858
it's writable, and can be accessed via the normal filesystem API.
859
"""
1364
1365
1366
1367
1368
class ScratchBranch(Branch):
1369
"""Special test class: a branch that cleans up after itself.
1370
1371
>>> b = ScratchBranch()
1372
>>> isdir(b.base)
1373
True
1374
>>> bd = b.base
1375
>>> b.destroy()
1376
>>> isdir(bd)
1377
False
1378
"""
1379
def __init__(self, files=[], dirs=[], base=None):
1380
"""Make a test branch.
1381
1382
This creates a temporary directory and runs init-tree in it.
1383
1384
If any files are listed, they are created in the working copy.
1385
"""
1386
from tempfile import mkdtemp
1387
init = False
1388
if base is None:
1389
base = mkdtemp()
1390
init = True
1391
Branch.__init__(self, base, init=init)
1392
for d in dirs:
1393
os.mkdir(self.abspath(d))
1394
1395
for f in files:
1396
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1397
1398
1399
def clone(self):
1400
"""
1401
>>> orig = ScratchBranch(files=["file1", "file2"])
1402
>>> clone = orig.clone()
1403
>>> os.path.samefile(orig.base, clone.base)
1404
False
1405
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1406
True
1407
"""
1408
from shutil import copytree
1409
from tempfile import mkdtemp
1410
base = mkdtemp()
1411
os.rmdir(base)
1412
copytree(self.base, base, symlinks=True)
1413
return ScratchBranch(base=base)
1414
1415
1416
1417
def __del__(self):
1418
self.destroy()
1419
1420
def destroy(self):
1421
"""Destroy the test branch, removing the scratch directory."""
1422
from shutil import rmtree
1423
try:
1424
if self.base:
1425
mutter("delete ScratchBranch %s" % self.base)
1426
rmtree(self.base)
1427
except OSError, e:
1428
# Work around for shutil.rmtree failing on Windows when
1429
# readonly files are encountered
1430
mutter("hit exception in destroying ScratchBranch: %s" % e)
1431
for root, dirs, files in os.walk(self.base, topdown=False):
1432
for name in files:
1433
os.chmod(os.path.join(root, name), 0700)
1434
rmtree(self.base)
1435
self.base = None
1436
860
1437
861
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
862
relax_version_check=DEPRECATED_PARAMETER, _format=None,
863
_control_files=None, a_bzrdir=None, _repository=None):
864
"""Create new branch object at a particular location.
865
866
transport -- A Transport object, defining how to access files.
867
868
init -- If True, create new control files in a previously
869
unversioned directory. If False, the branch must already
870
be versioned.
871
872
relax_version_check -- If true, the usual check for the branch
873
version is not applied. This is intended only for
874
upgrade/recovery type use; it's not guaranteed that
875
all operations will work on old format branches.
876
"""
877
if a_bzrdir is None:
878
self.bzrdir = bzrdir.BzrDir.open(transport.base)
879
else:
880
self.bzrdir = a_bzrdir
881
self._transport = self.bzrdir.transport.clone('..')
882
self._base = self._transport.base
883
self._format = _format
884
if _control_files is None:
885
raise ValueError('BzrBranch _control_files is None')
886
self.control_files = _control_files
887
if deprecated_passed(init):
888
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
889
"deprecated as of bzr 0.8. Please use Branch.create().",
890
DeprecationWarning,
891
stacklevel=2)
892
if init:
893
# this is slower than before deprecation, oh well never mind.
894
# -> its deprecated.
895
self._initialize(transport.base)
896
self._check_format(_format)
897
if deprecated_passed(relax_version_check):
898
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
899
"relax_version_check parameter is deprecated as of bzr 0.8. "
900
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
901
"open() method.",
902
DeprecationWarning,
903
stacklevel=2)
904
if (not relax_version_check
905
and not self._format.is_supported()):
906
raise errors.UnsupportedFormatError(format=fmt)
907
if deprecated_passed(transport):
908
warn("BzrBranch.__init__(transport=XXX...): The transport "
909
"parameter is deprecated as of bzr 0.8. "
910
"Please use Branch.open, or bzrdir.open_branch().",
911
DeprecationWarning,
912
stacklevel=2)
913
self.repository = _repository
914
915
def __str__(self):
916
return '%s(%r)' % (self.__class__.__name__, self.base)
917
918
__repr__ = __str__
919
920
def __del__(self):
921
# TODO: It might be best to do this somewhere else,
922
# but it is nice for a Branch object to automatically
923
# cache it's information.
924
# Alternatively, we could have the Transport objects cache requests
925
# See the earlier discussion about how major objects (like Branch)
926
# should never expect their __del__ function to run.
927
# XXX: cache_root seems to be unused, 2006-01-13 mbp
928
if hasattr(self, 'cache_root') and self.cache_root is not None:
929
try:
930
osutils.rmtree(self.cache_root)
931
except:
932
pass
933
self.cache_root = None
934
935
def _get_base(self):
936
return self._base
937
938
base = property(_get_base, doc="The URL for the root of this branch.")
939
940
def _finish_transaction(self):
941
"""Exit the current transaction."""
942
return self.control_files._finish_transaction()
943
944
def get_transaction(self):
945
"""Return the current active transaction.
946
947
If no transaction is active, this returns a passthrough object
948
for which all data is immediately flushed and no caching happens.
949
"""
950
# this is an explicit function so that we can do tricky stuff
951
# when the storage in rev_storage is elsewhere.
952
# we probably need to hook the two 'lock a location' and
953
# 'have a transaction' together more delicately, so that
954
# we can have two locks (branch and storage) and one transaction
955
# ... and finishing the transaction unlocks both, but unlocking
956
# does not. - RBC 20051121
957
return self.control_files.get_transaction()
958
959
def _set_transaction(self, transaction):
960
"""Set a new active transaction."""
961
return self.control_files._set_transaction(transaction)
962
963
def abspath(self, name):
964
"""See Branch.abspath."""
965
return self.control_files._transport.abspath(name)
966
967
def _check_format(self, format):
968
"""Identify the branch format if needed.
969
970
The format is stored as a reference to the format object in
971
self._format for code that needs to check it later.
972
973
The format parameter is either None or the branch format class
974
used to open this branch.
975
976
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
977
"""
978
if format is None:
979
format = BranchFormat.find_format(self.bzrdir)
980
self._format = format
981
mutter("got branch format %s", self._format)
982
983
@needs_read_lock
984
def get_root_id(self):
985
"""See Branch.get_root_id."""
986
tree = self.repository.revision_tree(self.last_revision())
987
return tree.inventory.root.file_id
988
989
def is_locked(self):
990
return self.control_files.is_locked()
991
992
def lock_write(self):
993
self.repository.lock_write()
994
try:
995
self.control_files.lock_write()
996
except:
997
self.repository.unlock()
998
raise
999
1000
def lock_read(self):
1001
self.repository.lock_read()
1002
try:
1003
self.control_files.lock_read()
1004
except:
1005
self.repository.unlock()
1006
raise
1007
1008
def unlock(self):
1009
# TODO: test for failed two phase locks. This is known broken.
1010
try:
1011
self.control_files.unlock()
1012
finally:
1013
self.repository.unlock()
1014
1015
def peek_lock_mode(self):
1016
if self.control_files._lock_count == 0:
1017
return None
1018
else:
1019
return self.control_files._lock_mode
1020
1021
def get_physical_lock_status(self):
1022
return self.control_files.get_physical_lock_status()
1023
1024
@needs_read_lock
1025
def print_file(self, file, revision_id):
1026
"""See Branch.print_file."""
1027
return self.repository.print_file(file, revision_id)
1028
1029
@needs_write_lock
1030
def append_revision(self, *revision_ids):
1031
"""See Branch.append_revision."""
1032
for revision_id in revision_ids:
1033
mutter("add {%s} to revision-history" % revision_id)
1034
rev_history = self.revision_history()
1035
rev_history.extend(revision_ids)
1036
self.set_revision_history(rev_history)
1037
1038
@needs_write_lock
1039
def set_revision_history(self, rev_history):
1040
"""See Branch.set_revision_history."""
1041
self.control_files.put_utf8(
1042
'revision-history', '\n'.join(rev_history))
1043
transaction = self.get_transaction()
1044
history = transaction.map.find_revision_history()
1045
if history is not None:
1046
# update the revision history in the identity map.
1047
history[:] = list(rev_history)
1048
# this call is disabled because revision_history is
1049
# not really an object yet, and the transaction is for objects.
1050
# transaction.register_dirty(history)
1051
else:
1052
transaction.map.add_revision_history(rev_history)
1053
# this call is disabled because revision_history is
1054
# not really an object yet, and the transaction is for objects.
1055
# transaction.register_clean(history)
1056
1057
@needs_read_lock
1058
def revision_history(self):
1059
"""See Branch.revision_history."""
1060
transaction = self.get_transaction()
1061
history = transaction.map.find_revision_history()
1062
if history is not None:
1063
mutter("cache hit for revision-history in %s", self)
1064
return list(history)
1065
history = [l.rstrip('\r\n') for l in
1066
self.control_files.get_utf8('revision-history').readlines()]
1067
transaction.map.add_revision_history(history)
1068
# this call is disabled because revision_history is
1069
# not really an object yet, and the transaction is for objects.
1070
# transaction.register_clean(history, precious=True)
1071
return list(history)
1072
1073
@needs_write_lock
1074
def generate_revision_history(self, revision_id, last_rev=None,
1075
other_branch=None):
1076
"""Create a new revision history that will finish with revision_id.
1077
1078
:param revision_id: the new tip to use.
1079
:param last_rev: The previous last_revision. If not None, then this
1080
must be a ancestory of revision_id, or DivergedBranches is raised.
1081
:param other_branch: The other branch that DivergedBranches should
1082
raise with respect to.
1083
"""
1084
# stop_revision must be a descendant of last_revision
1085
stop_graph = self.repository.get_revision_graph(revision_id)
1086
if last_rev is not None and last_rev not in stop_graph:
1087
# our previous tip is not merged into stop_revision
1088
raise errors.DivergedBranches(self, other_branch)
1089
# make a new revision history from the graph
1090
current_rev_id = revision_id
1091
new_history = []
1092
while current_rev_id not in (None, revision.NULL_REVISION):
1093
new_history.append(current_rev_id)
1094
current_rev_id_parents = stop_graph[current_rev_id]
1095
try:
1096
current_rev_id = current_rev_id_parents[0]
1097
except IndexError:
1098
current_rev_id = None
1099
new_history.reverse()
1100
self.set_revision_history(new_history)
1101
1102
@needs_write_lock
1103
def update_revisions(self, other, stop_revision=None):
1104
"""See Branch.update_revisions."""
1105
other.lock_read()
1106
try:
1107
if stop_revision is None:
1108
stop_revision = other.last_revision()
1109
if stop_revision is None:
1110
# if there are no commits, we're done.
1111
return
1112
# whats the current last revision, before we fetch [and change it
1113
# possibly]
1114
last_rev = self.last_revision()
1115
# we fetch here regardless of whether we need to so that we pickup
1116
# filled in ghosts.
1117
self.fetch(other, stop_revision)
1118
my_ancestry = self.repository.get_ancestry(last_rev)
1119
if stop_revision in my_ancestry:
1120
# last_revision is a descendant of stop_revision
1121
return
1122
self.generate_revision_history(stop_revision, last_rev=last_rev,
1123
other_branch=other)
1124
finally:
1125
other.unlock()
1126
1127
def basis_tree(self):
1128
"""See Branch.basis_tree."""
1129
return self.repository.revision_tree(self.last_revision())
1130
1131
@deprecated_method(zero_eight)
1132
def working_tree(self):
1133
"""Create a Working tree object for this branch."""
1134
1135
from bzrlib.transport.local import LocalTransport
1136
if (self.base.find('://') != -1 or
1137
not isinstance(self._transport, LocalTransport)):
1138
raise NoWorkingTree(self.base)
1139
return self.bzrdir.open_workingtree()
1140
1141
@needs_write_lock
1142
def pull(self, source, overwrite=False, stop_revision=None):
1143
"""See Branch.pull."""
1144
source.lock_read()
1145
try:
1146
old_count = len(self.revision_history())
1147
try:
1148
self.update_revisions(source,stop_revision)
1149
except DivergedBranches:
1150
if not overwrite:
1151
raise
1152
if overwrite:
1153
self.set_revision_history(source.revision_history())
1154
new_count = len(self.revision_history())
1155
return new_count - old_count
1156
finally:
1157
source.unlock()
1158
1159
def get_parent(self):
1160
"""See Branch.get_parent."""
1161
1162
_locs = ['parent', 'pull', 'x-pull']
1163
assert self.base[-1] == '/'
1164
for l in _locs:
1165
try:
1166
parent = self.control_files.get(l).read().strip('\n')
1167
except NoSuchFile:
1168
continue
1169
# This is an old-format absolute path to a local branch
1170
# turn it into a url
1171
if parent.startswith('/'):
1172
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1173
return urlutils.join(self.base[:-1], parent)
1174
return None
1175
1176
def get_push_location(self):
1177
"""See Branch.get_push_location."""
1178
push_loc = self.get_config().get_user_option('push_location')
1179
return push_loc
1180
1181
def set_push_location(self, location):
1182
"""See Branch.set_push_location."""
1183
self.get_config().set_user_option('push_location', location,
1184
local=True)
1185
1186
@needs_write_lock
1187
def set_parent(self, url):
1188
"""See Branch.set_parent."""
1189
# TODO: Maybe delete old location files?
1190
# URLs should never be unicode, even on the local fs,
1191
# FIXUP this and get_parent in a future branch format bump:
1192
# read and rewrite the file, and have the new format code read
1193
# using .get not .get_utf8. RBC 20060125
1194
if url is None:
1195
self.control_files._transport.delete('parent')
1196
else:
1197
if isinstance(url, unicode):
1198
try:
1199
url = url.encode('ascii')
1200
except UnicodeEncodeError:
1201
raise bzrlib.errors.InvalidURL(url,
1202
"Urls must be 7-bit ascii, "
1203
"use bzrlib.urlutils.escape")
1204
1205
url = urlutils.relative_url(self.base, url)
1206
self.control_files.put('parent', url + '\n')
1207
1208
@deprecated_function(zero_nine)
1209
def tree_config(self):
1210
"""DEPRECATED; call get_config instead.
1211
TreeConfig has become part of BranchConfig."""
1212
return TreeConfig(self)
1213
1214
1215
class BzrBranch5(BzrBranch):
1216
"""A format 5 branch. This supports new features over plan branches.
1217
1218
It has support for a master_branch which is the data for bound branches.
1219
"""
1220
1221
def __init__(self,
1222
_format,
1223
_control_files,
1224
a_bzrdir,
1225
_repository):
1226
super(BzrBranch5, self).__init__(_format=_format,
1227
_control_files=_control_files,
1228
a_bzrdir=a_bzrdir,
1229
_repository=_repository)
1230
1231
@needs_write_lock
1232
def pull(self, source, overwrite=False, stop_revision=None):
1233
"""Updates branch.pull to be bound branch aware."""
1234
bound_location = self.get_bound_location()
1235
if source.base != bound_location:
1236
# not pulling from master, so we need to update master.
1237
master_branch = self.get_master_branch()
1238
if master_branch:
1239
master_branch.pull(source)
1240
source = master_branch
1241
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1242
1243
def get_bound_location(self):
1244
try:
1245
return self.control_files.get_utf8('bound').read()[:-1]
1246
except errors.NoSuchFile:
1247
return None
1248
1249
@needs_read_lock
1250
def get_master_branch(self):
1251
"""Return the branch we are bound to.
1252
1253
:return: Either a Branch, or None
1254
1255
This could memoise the branch, but if thats done
1256
it must be revalidated on each new lock.
1257
So for now we just don't memoise it.
1258
# RBC 20060304 review this decision.
1259
"""
1260
bound_loc = self.get_bound_location()
1261
if not bound_loc:
1262
return None
1263
try:
1264
return Branch.open(bound_loc)
1265
except (errors.NotBranchError, errors.ConnectionError), e:
1266
raise errors.BoundBranchConnectionFailure(
1267
self, bound_loc, e)
1268
1269
@needs_write_lock
1270
def set_bound_location(self, location):
1271
"""Set the target where this branch is bound to.
1272
1273
:param location: URL to the target branch
1274
"""
1275
if location:
1276
self.control_files.put_utf8('bound', location+'\n')
1277
else:
1278
try:
1279
self.control_files._transport.delete('bound')
1280
except NoSuchFile:
1281
return False
1438
1439
######################################################################
1440
# predicates
1441
1442
1443
def is_control_file(filename):
1444
## FIXME: better check
1445
filename = os.path.normpath(filename)
1446
while filename != '':
1447
head, tail = os.path.split(filename)
1448
## mutter('check %r for control file' % ((head, tail), ))
1449
if tail == bzrlib.BZRDIR:
1282
1450
return True
1283
1284
@needs_write_lock
1285
def bind(self, other):
1286
"""Bind the local branch the other branch.
1287
1288
:param other: The branch to bind to
1289
:type other: Branch
1290
"""
1291
# TODO: jam 20051230 Consider checking if the target is bound
1292
# It is debatable whether you should be able to bind to
1293
# a branch which is itself bound.
1294
# Committing is obviously forbidden,
1295
# but binding itself may not be.
1296
# Since we *have* to check at commit time, we don't
1297
# *need* to check here
1298
self.pull(other)
1299
1300
# we are now equal to or a suffix of other.
1301
1302
# Since we have 'pulled' from the remote location,
1303
# now we should try to pull in the opposite direction
1304
# in case the local tree has more revisions than the
1305
# remote one.
1306
# There may be a different check you could do here
1307
# rather than actually trying to install revisions remotely.
1308
# TODO: capture an exception which indicates the remote branch
1309
# is not writable.
1310
# If it is up-to-date, this probably should not be a failure
1311
1312
# lock other for write so the revision-history syncing cannot race
1313
other.lock_write()
1314
try:
1315
other.pull(self)
1316
# if this does not error, other now has the same last rev we do
1317
# it can only error if the pull from other was concurrent with
1318
# a commit to other from someone else.
1319
1320
# until we ditch revision-history, we need to sync them up:
1321
self.set_revision_history(other.revision_history())
1322
# now other and self are up to date with each other and have the
1323
# same revision-history.
1324
finally:
1325
other.unlock()
1326
1327
self.set_bound_location(other.base)
1328
1329
@needs_write_lock
1330
def unbind(self):
1331
"""If bound, unbind"""
1332
return self.set_bound_location(None)
1333
1334
@needs_write_lock
1335
def update(self):
1336
"""Synchronise this branch with the master branch if any.
1337
1338
:return: None or the last_revision that was pivoted out during the
1339
update.
1340
"""
1341
master = self.get_master_branch()
1342
if master is not None:
1343
old_tip = self.last_revision()
1344
self.pull(master, overwrite=True)
1345
if old_tip in self.repository.get_ancestry(self.last_revision()):
1346
return None
1347
return old_tip
1348
return None
1349
1350
1351
class BranchTestProviderAdapter(object):
1352
"""A tool to generate a suite testing multiple branch formats at once.
1353
1354
This is done by copying the test once for each transport and injecting
1355
the transport_server, transport_readonly_server, and branch_format
1356
classes into each copy. Each copy is also given a new id() to make it
1357
easy to identify.
1358
"""
1359
1360
def __init__(self, transport_server, transport_readonly_server, formats):
1361
self._transport_server = transport_server
1362
self._transport_readonly_server = transport_readonly_server
1363
self._formats = formats
1364
1365
def adapt(self, test):
1366
result = TestSuite()
1367
for branch_format, bzrdir_format in self._formats:
1368
new_test = deepcopy(test)
1369
new_test.transport_server = self._transport_server
1370
new_test.transport_readonly_server = self._transport_readonly_server
1371
new_test.bzrdir_format = bzrdir_format
1372
new_test.branch_format = branch_format
1373
def make_new_test_id():
1374
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1375
return lambda: new_id
1376
new_test.id = make_new_test_id()
1377
result.addTest(new_test)
1378
return result
1379
1380
1381
class BranchCheckResult(object):
1382
"""Results of checking branch consistency.
1383
1384
:see: Branch.check
1385
"""
1386
1387
def __init__(self, branch):
1388
self.branch = branch
1389
1390
def report_results(self, verbose):
1391
"""Report the check results via trace.note.
1392
1393
:param verbose: Requests more detailed display of what was checked,
1394
if any.
1395
"""
1396
note('checked branch %s format %s',
1397
self.branch.base,
1398
self.branch._format)
1399
1400
1401
######################################################################
1402
# predicates
1403
1404
1405
@deprecated_function(zero_eight)
1406
def is_control_file(*args, **kwargs):
1407
"""See bzrlib.workingtree.is_control_file."""
1408
return bzrlib.workingtree.is_control_file(*args, **kwargs)
1451
if filename == head:
1452
break
1453
filename = head
1454
return False
1455
1456
1457
1458
def gen_file_id(name):
1459
"""Return new file id.
1460
1461
This should probably generate proper UUIDs, but for the moment we
1462
cope with just randomness because running uuidgen every time is
1463
slow."""
1464
import re
1465
from binascii import hexlify
1466
from time import time
1467
1468
# get last component
1469
idx = name.rfind('/')
1470
if idx != -1:
1471
name = name[idx+1 : ]
1472
idx = name.rfind('\\')
1473
if idx != -1:
1474
name = name[idx+1 : ]
1475
1476
# make it not a hidden file
1477
name = name.lstrip('.')
1478
1479
# remove any wierd characters; we don't escape them but rather
1480
# just pull them out
1481
name = re.sub(r'[^\w.]', '', name)
1482
1483
s = hexlify(rand_bytes(8))
1484
return '-'.join((name, compact_date(time()), s))
1485
1486
1487
def gen_root_id():
1488
"""Return a new tree-root file id."""
1489
return gen_file_id('TREE_ROOT')
1490
1491
1492
def pull_loc(branch):
1493
# TODO: Should perhaps just make attribute be 'base' in
1494
# RemoteBranch and Branch?
1495
if hasattr(branch, "baseurl"):
1496
return branch.baseurl
1497
else:
1498
return branch.base
1499
1500
1501
def copy_branch(branch_from, to_location, revision=None):
1502
"""Copy branch_from into the existing directory to_location.
1503
1504
revision
1505
If not None, only revisions up to this point will be copied.
1506
The head of the new branch will be that revision.
1507
1508
to_location
1509
The name of a local directory that exists but is empty.
1510
"""
1511
from bzrlib.merge import merge
1512
from bzrlib.branch import Branch
1513
1514
assert isinstance(branch_from, Branch)
1515
assert isinstance(to_location, basestring)
1516
1517
br_to = Branch(to_location, init=True)
1518
br_to.set_root_id(branch_from.get_root_id())
1519
if revision is None:
1520
revno = branch_from.revno()
1521
else:
1522
revno, rev_id = branch_from.get_revision_info(revision)
1523
br_to.update_revisions(branch_from, stop_revision=revno)
1524
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1525
check_clean=False, ignore_zero=True)
1526
1527
from_location = pull_loc(branch_from)
1528
br_to.set_parent(pull_loc(branch_from))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1