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