To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 2255.2.152
- compare with another revision
- download diff
- download tarball
- view history from revision 2255.2.152
- Committer: Martin Pool
- Date: 2007-02-26 02:56:24 UTC
- mfrom: (2255.6.9 dirstate)
- mto: (2255.13.2 subtree) (2321.1.1 integration)
- mto: This revision was merged to the branch mainline in revision 2322.
- Revision ID: mbp@sourcefrog.net-20070226025624-4cfvc1r2it0oxxt2
(broken) merge aaron's workingtree format changes
- 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/repofmt
- 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
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/version_info_formats
- tools/doc_generate
- tools/win32
- files removed:
- bzrlib/mdiff.py
- notes
- patches
- plugins/changeset
- urlgrabber
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.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
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.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, 2007 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 cStringIO import StringIO
19
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
20
25
21
26
import bzrlib
27
from bzrlib import (
28
bzrdir,
29
cache_utf8,
30
config as _mod_config,
31
errors,
32
lockdir,
33
lockable_files,
34
osutils,
35
revision as _mod_revision,
36
transport,
37
tree,
38
ui,
39
urlutils,
40
)
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
""")
44
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
52
)
53
from bzrlib.symbol_versioning import (deprecated_function,
54
deprecated_method,
55
DEPRECATED_PARAMETER,
56
deprecated_passed,
57
zero_eight, zero_nine,
58
)
22
59
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
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
import bzrlib.errors
28
from bzrlib.textui import show_status
29
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
35
## TODO: Maybe include checks for common corruption of newlines, etc?
36
60
61
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
65
66
67
# TODO: Maybe include checks for common corruption of newlines, etc?
37
68
38
69
# TODO: Some operations like log might retrieve the same revisions
39
70
# repeatedly to calculate deltas. We could perhaps have a weakref
40
# cache in memory to make this faster.
41
42
43
def find_branch(f, **args):
44
if f and (f.startswith('http://') or f.startswith('https://')):
45
import remotebranch
46
return remotebranch.RemoteBranch(f, **args)
47
else:
48
return Branch(f, **args)
49
50
51
def find_cached_branch(f, cache_root, **args):
52
from remotebranch import RemoteBranch
53
br = find_branch(f, **args)
54
def cacheify(br, store_name):
55
from meta_store import CachedStore
56
cache_path = os.path.join(cache_root, store_name)
57
os.mkdir(cache_path)
58
new_store = CachedStore(getattr(br, store_name), cache_path)
59
setattr(br, store_name, new_store)
60
61
if isinstance(br, RemoteBranch):
62
cacheify(br, 'inventory_store')
63
cacheify(br, 'text_store')
64
cacheify(br, 'revision_store')
65
return br
66
67
68
def _relpath(base, path):
69
"""Return path relative to base, or raise exception.
70
71
The path may be either an absolute path or a path relative to the
72
current working directory.
73
74
Lifted out of Branch.relpath for ease of testing.
75
76
os.path.commonprefix (python2.4) has a bad bug that it works just
77
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
78
avoids that problem."""
79
rp = os.path.abspath(path)
80
81
s = []
82
head = rp
83
while len(head) >= len(base):
84
if head == base:
85
break
86
head, tail = os.path.split(head)
87
if tail:
88
s.insert(0, tail)
89
else:
90
from errors import NotBranchError
91
raise NotBranchError("path %r is not within branch %r" % (rp, base))
92
93
return os.sep.join(s)
94
95
96
def find_branch_root(f=None):
97
"""Find the branch root enclosing f, or pwd.
98
99
f may be a filename or a URL.
100
101
It is not necessary that f exists.
102
103
Basically we keep looking up until we find the control directory or
104
run into the root."""
105
if f == None:
106
f = os.getcwd()
107
elif hasattr(os.path, 'realpath'):
108
f = os.path.realpath(f)
109
else:
110
f = os.path.abspath(f)
111
if not os.path.exists(f):
112
raise BzrError('%r does not exist' % f)
113
114
115
orig_f = f
116
117
while True:
118
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
119
return f
120
head, tail = os.path.split(f)
121
if head == f:
122
# reached the root, whatever that may be
123
raise BzrError('%r is not in a branch' % orig_f)
124
f = head
125
126
class DivergedBranches(Exception):
127
def __init__(self, branch1, branch2):
128
self.branch1 = branch1
129
self.branch2 = branch2
130
Exception.__init__(self, "These branches have diverged.")
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
131
74
132
75
133
76
######################################################################
137
80
"""Branch holding a history of revisions.
138
81
139
82
base
140
Base directory of the branch.
141
142
_lock_mode
143
None, or 'r' or 'w'
144
145
_lock_count
146
If _lock_mode is true, a positive count of the number of times the
147
lock has been taken.
148
149
_lock
150
Lock object from bzrlib.lock.
83
Base directory/url of the branch.
84
85
hooks: An instance of BranchHooks.
151
86
"""
87
# this is really an instance variable - FIXME move it there
88
# - RBC 20060112
152
89
base = None
153
_lock_mode = None
154
_lock_count = None
155
_lock = None
156
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
161
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
164
165
base -- Base directory for the branch.
166
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
169
be versioned.
170
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
173
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
176
"""
177
from bzrlib.store import ImmutableStore
178
if init:
179
self.base = os.path.realpath(base)
180
self._make_control()
181
elif find_root:
182
self.base = find_branch_root(base)
183
else:
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
190
self._check_format()
191
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
195
196
197
def __str__(self):
198
return '%s(%r)' % (self.__class__.__name__, self.base)
199
200
201
__repr__ = __str__
202
203
204
def __del__(self):
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
208
self._lock.unlock()
209
210
90
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
93
94
def break_lock(self):
95
"""Break a lock if one is present from another instance.
96
97
Uses the ui factory to ask for confirmation if the lock may be from
98
an active process.
99
100
This will probe the repository for its lock as well.
101
"""
102
self.control_files.break_lock()
103
self.repository.break_lock()
104
master = self.get_master_branch()
105
if master is not None:
106
master.break_lock()
107
108
@staticmethod
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
113
114
@staticmethod
115
def open(base, _unsupported=False):
116
"""Open the branch rooted at base.
117
118
For instance, if the branch is at URL/.bzr/branch,
119
Branch.open(URL) -> a Branch instance.
120
"""
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
123
124
@staticmethod
125
def open_containing(url):
126
"""Open an existing branch which contains url.
127
128
This probes for a branch at url, and searches upwards from there.
129
130
Basically we keep looking up until we find the control directory or
131
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
133
format, UnknownFormatError or UnsupportedFormatError are raised.
134
If there is one, it is returned, along with the unused portion of url.
135
"""
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
138
139
@staticmethod
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
143
144
NOTE: This will soon be deprecated in favour of creation
145
through a BzrDir.
146
"""
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
148
149
@deprecated_function(zero_eight)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
153
154
NOTE: This is unused.
155
"""
156
pass
157
158
def get_config(self):
159
return BranchConfig(self)
160
161
def _get_nick(self):
162
return self.get_config().get_nickname()
163
164
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
166
167
nick = property(_get_nick, _set_nick)
168
169
def is_locked(self):
170
raise NotImplementedError(self.is_locked)
211
171
212
172
def lock_write(self):
213
if self._lock_mode:
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
217
self._lock_mode)
218
self._lock_count += 1
219
else:
220
from bzrlib.lock import WriteLock
221
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
224
self._lock_count = 1
225
226
173
raise NotImplementedError(self.lock_write)
227
174
228
175
def lock_read(self):
229
if self._lock_mode:
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
233
else:
234
from bzrlib.lock import ReadLock
235
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
238
self._lock_count = 1
239
240
241
176
raise NotImplementedError(self.lock_read)
177
242
178
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
246
247
if self._lock_count > 1:
248
self._lock_count -= 1
249
else:
250
self._lock.unlock()
251
self._lock = None
252
self._lock_mode = self._lock_count = None
253
179
raise NotImplementedError(self.unlock)
180
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
184
185
def get_physical_lock_status(self):
186
raise NotImplementedError(self.get_physical_lock_status)
254
187
255
188
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
258
259
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
262
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
265
266
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
272
273
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
276
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
281
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
284
"""
285
286
fn = self.controlfilename(file_or_path)
287
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
293
import codecs
294
return codecs.open(fn, mode + 'b', 'utf-8',
295
buffering=60000)
296
else:
297
raise BzrError("invalid controlfile mode %r" % mode)
298
299
300
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
304
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
314
'branch-lock',
315
'pending-merges'):
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
318
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
320
321
322
def _check_format(self):
323
"""Check this branch format is supported.
324
325
The current tool only supports the current unstable format.
326
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
329
"""
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
339
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
344
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
351
for fid in inv:
352
entry = inv[fid]
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
356
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
362
before = time()
363
self.lock_read()
364
try:
365
# ElementTree does its own conversion from UTF-8, so open in
366
# binary.
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
371
return inv
372
finally:
373
self.unlock()
374
375
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
378
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
381
"""
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
384
385
self.lock_write()
386
try:
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
try:
389
pack_xml(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, verbose=False, ids=None):
404
"""Make files versioned.
405
406
Note that the command line normally calls smart_add instead.
407
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
410
411
files
412
List of paths to add, relative to the base of the tree.
413
414
ids
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
418
419
TODO: Perhaps have an option to add the ids even if the files do
420
not (yet) exist.
421
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
424
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
427
higher-level method.
428
"""
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
433
files = [files]
434
if ids is not None:
435
ids = [ids]
436
437
if ids is None:
438
ids = [None] * len(files)
439
else:
440
assert(len(ids) == len(files))
441
442
self.lock_write()
443
try:
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
448
449
fp = splitpath(f)
450
451
if len(fp) == 0:
452
raise BzrError("cannot add top-level %r" % f)
453
454
fullpath = os.path.normpath(self.abspath(f))
455
456
try:
457
kind = file_kind(fullpath)
458
except OSError:
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
465
if file_id is None:
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
468
469
if verbose:
470
print 'added', quotefn(f)
471
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
474
self._write_inventory(inv)
475
finally:
476
self.unlock()
477
478
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
481
self.lock_read()
482
try:
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
486
if not file_id:
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
489
finally:
490
self.unlock()
491
492
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
495
496
This does not remove their text. This does not run on
497
498
TODO: Refuse to remove modified files unless --force is given?
499
500
TODO: Do something useful with directories.
501
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
506
"""
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
510
files = [files]
511
512
self.lock_write()
513
514
try:
515
tree = self.working_tree()
516
inv = tree.inventory
517
518
# do this before any modifications
519
for f in files:
520
fid = inv.path2id(f)
521
if not fid:
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
524
if verbose:
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
527
new_status = 'I'
528
else:
529
new_status = '?'
530
show_status(new_status, inv[fid].kind, quotefn(f))
531
del inv[fid]
532
533
self._write_inventory(inv)
534
finally:
535
self.unlock()
536
537
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
544
if name == "":
545
continue
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
548
549
550
def unknowns(self):
551
"""Return all unknown files.
552
553
These are files in the working directory that are not versioned or
554
control files or ignored.
555
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
558
['foo']
559
>>> b.add('foo')
560
>>> list(b.unknowns())
561
[]
562
>>> b.remove('foo')
563
>>> list(b.unknowns())
564
['foo']
565
"""
566
return self.working_tree().unknowns()
567
568
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
571
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
574
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
577
578
f = AtomicFile(self.controlfilename('revision-history'))
579
try:
580
for rev_id in rev_history:
581
print >>f, rev_id
582
f.commit()
583
finally:
584
f.close()
585
586
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
591
592
self.lock_read()
593
try:
594
try:
595
return self.revision_store[revision_id]
596
except IndexError:
597
raise bzrlib.errors.NoSuchRevision(revision_id)
598
finally:
599
self.unlock()
600
601
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
605
606
try:
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
[revision_id,
611
str(e)])
612
613
assert r.revision_id == revision_id
614
return r
615
189
"""Return absolute filename for something in the branch
190
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
193
"""
194
raise NotImplementedError(self.abspath)
195
196
def bind(self, other):
197
"""Bind the local branch the other branch.
198
199
:param other: The branch to bind to
200
:type other: Branch
201
"""
202
raise errors.UpgradeRequired(self.base)
203
204
@needs_write_lock
205
def fetch(self, from_branch, last_revision=None, pb=None):
206
"""Copy revisions from from_branch into this branch.
207
208
:param from_branch: Where to copy from.
209
:param last_revision: What revision to stop at (None for at the end
210
of the branch.
211
:param pb: An optional progress bar to use.
212
213
Returns the copied revision count and the failed revisions in a tuple:
214
(copied, failures).
215
"""
216
if self.base == from_branch.base:
217
return (0, [])
218
if pb is None:
219
nested_pb = ui.ui_factory.nested_progress_bar()
220
pb = nested_pb
221
else:
222
nested_pb = None
223
224
from_branch.lock_read()
225
try:
226
if last_revision is None:
227
pb.update('get source history')
228
last_revision = from_branch.last_revision()
229
if last_revision is None:
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
233
pb=nested_pb)
234
finally:
235
if nested_pb is not None:
236
nested_pb.finished()
237
from_branch.unlock()
238
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
241
242
Older format branches cannot bind, please be sure to use a metadir
243
branch.
244
"""
245
return None
246
247
def get_old_bound_location(self):
248
"""Return the URL of the branch we used to be bound to
249
"""
250
raise errors.UpgradeRequired(self.base)
251
252
def get_commit_builder(self, parents, config=None, timestamp=None,
253
timezone=None, committer=None, revprops=None,
254
revision_id=None):
255
"""Obtain a CommitBuilder for this branch.
256
257
:param parents: Revision ids of the parents of the new revision.
258
:param config: Optional configuration to use.
259
:param timestamp: Optional timestamp recorded for commit.
260
:param timezone: Optional timezone for timestamp.
261
:param committer: Optional committer to set for commit.
262
:param revprops: Optional dictionary of revision properties.
263
:param revision_id: Optional revision id.
264
"""
265
266
if config is None:
267
config = self.get_config()
268
269
return self.repository.get_commit_builder(self, parents, config,
270
timestamp, timezone, committer, revprops, revision_id)
271
272
def get_master_branch(self):
273
"""Return the branch we are bound to.
274
275
:return: Either a Branch, or None
276
"""
277
return None
616
278
617
279
def get_revision_delta(self, revno):
618
280
"""Return the delta for one revision.
624
286
rh = self.revision_history()
625
287
if not (1 <= revno <= len(rh)):
626
288
raise InvalidRevisionNumber(revno)
627
628
# revno is 1-based; list is 0-based
629
630
new_tree = self.revision_tree(rh[revno-1])
631
if revno == 1:
632
old_tree = EmptyTree()
633
else:
634
old_tree = self.revision_tree(rh[revno-2])
635
636
return compare_trees(old_tree, new_tree)
637
638
639
640
def get_revision_sha1(self, revision_id):
641
"""Hash the stored value of a revision, and return it."""
642
# In the future, revision entries will be signed. At that
643
# point, it is probably best *not* to include the signature
644
# in the revision hash. Because that lets you re-sign
645
# the revision, (add signatures/remove signatures) and still
646
# have all hash pointers stay consistent.
647
# But for now, just hash the contents.
648
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
649
650
651
def get_inventory(self, inventory_id):
652
"""Get Inventory object by hash.
653
654
TODO: Perhaps for this and similar methods, take a revision
655
parameter which can be either an integer revno or a
656
string hash."""
657
from bzrlib.inventory import Inventory
658
from bzrlib.xml import unpack_xml
659
660
return unpack_xml(Inventory, self.inventory_store[inventory_id])
661
662
663
def get_inventory_sha1(self, inventory_id):
664
"""Return the sha1 hash of the inventory entry
665
"""
666
return sha_file(self.inventory_store[inventory_id])
667
668
669
def get_revision_inventory(self, revision_id):
670
"""Return inventory of a past revision."""
671
# bzr 0.0.6 imposes the constraint that the inventory_id
672
# must be the same as its revision, so this is trivial.
673
if revision_id == None:
674
from bzrlib.inventory import Inventory
675
return Inventory(self.get_root_id())
676
else:
677
return self.get_inventory(revision_id)
678
289
return self.repository.get_revision_delta(rh[revno-1])
290
291
def get_root_id(self):
292
"""Return the id of this branches root"""
293
raise NotImplementedError(self.get_root_id)
294
295
def print_file(self, file, revision_id):
296
"""Print `file` to stdout."""
297
raise NotImplementedError(self.print_file)
298
299
def append_revision(self, *revision_ids):
300
raise NotImplementedError(self.append_revision)
301
302
def set_revision_history(self, rev_history):
303
raise NotImplementedError(self.set_revision_history)
679
304
680
305
def revision_history(self):
681
"""Return sequence of revision hashes on to this branch.
682
683
>>> ScratchBranch().revision_history()
684
[]
685
"""
686
self.lock_read()
687
try:
688
return [l.rstrip('\r\n') for l in
689
self.controlfile('revision-history', 'r').readlines()]
690
finally:
691
self.unlock()
692
693
694
def common_ancestor(self, other, self_revno=None, other_revno=None):
695
"""
696
>>> import commit
697
>>> sb = ScratchBranch(files=['foo', 'foo~'])
698
>>> sb.common_ancestor(sb) == (None, None)
699
True
700
>>> commit.commit(sb, "Committing first revision", verbose=False)
701
>>> sb.common_ancestor(sb)[0]
702
1
703
>>> clone = sb.clone()
704
>>> commit.commit(sb, "Committing second revision", verbose=False)
705
>>> sb.common_ancestor(sb)[0]
706
2
707
>>> sb.common_ancestor(clone)[0]
708
1
709
>>> commit.commit(clone, "Committing divergent second revision",
710
... verbose=False)
711
>>> sb.common_ancestor(clone)[0]
712
1
713
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
714
True
715
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
716
True
717
>>> clone2 = sb.clone()
718
>>> sb.common_ancestor(clone2)[0]
719
2
720
>>> sb.common_ancestor(clone2, self_revno=1)[0]
721
1
722
>>> sb.common_ancestor(clone2, other_revno=1)[0]
723
1
724
"""
725
my_history = self.revision_history()
726
other_history = other.revision_history()
727
if self_revno is None:
728
self_revno = len(my_history)
729
if other_revno is None:
730
other_revno = len(other_history)
731
indices = range(min((self_revno, other_revno)))
732
indices.reverse()
733
for r in indices:
734
if my_history[r] == other_history[r]:
735
return r+1, my_history[r]
736
return None, None
737
306
"""Return sequence of revision hashes on to this branch."""
307
raise NotImplementedError(self.revision_history)
738
308
739
309
def revno(self):
740
310
"""Return current revision number for this branch.
744
314
"""
745
315
return len(self.revision_history())
746
316
747
748
def last_patch(self):
749
"""Return last patch hash, or None if no history.
750
"""
317
def unbind(self):
318
"""Older format branches cannot bind or unbind."""
319
raise errors.UpgradeRequired(self.base)
320
321
def set_append_revisions_only(self, enabled):
322
"""Older format branches are never restricted to append-only"""
323
raise errors.UpgradeRequired(self.base)
324
325
def last_revision(self):
326
"""Return last revision id, or None"""
751
327
ph = self.revision_history()
752
328
if ph:
753
329
return ph[-1]
754
330
else:
755
331
return None
756
332
333
def last_revision_info(self):
334
"""Return information about the last revision.
335
336
:return: A tuple (revno, last_revision_id).
337
"""
338
rh = self.revision_history()
339
revno = len(rh)
340
if revno:
341
return (revno, rh[-1])
342
else:
343
return (0, _mod_revision.NULL_REVISION)
757
344
758
345
def missing_revisions(self, other, stop_revision=None):
759
"""
346
"""Return a list of new revisions that would perfectly fit.
347
760
348
If self and other have not diverged, return a list of the revisions
761
349
present in other, but missing from self.
762
763
>>> from bzrlib.commit import commit
764
>>> bzrlib.trace.silent = True
765
>>> br1 = ScratchBranch()
766
>>> br2 = ScratchBranch()
767
>>> br1.missing_revisions(br2)
768
[]
769
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
770
>>> br1.missing_revisions(br2)
771
[u'REVISION-ID-1']
772
>>> br2.missing_revisions(br1)
773
[]
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
775
>>> br1.missing_revisions(br2)
776
[]
777
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
778
>>> br1.missing_revisions(br2)
779
[u'REVISION-ID-2A']
780
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
781
>>> br1.missing_revisions(br2)
782
Traceback (most recent call last):
783
DivergedBranches: These branches have diverged.
784
350
"""
785
351
self_history = self.revision_history()
786
352
self_len = len(self_history)
793
359
794
360
if stop_revision is None:
795
361
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
798
362
else:
363
assert isinstance(stop_revision, int)
364
if stop_revision > other_len:
365
raise errors.NoSuchRevision(self, stop_revision)
799
366
return other_history[self_len:stop_revision]
800
367
801
802
368
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
804
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
808
>>> br1.add('foo')
809
>>> br1.add('bar')
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
813
Added 2 texts.
814
Added 1 inventories.
815
Added 1 revisions.
816
>>> br2.revision_history()
817
[u'REVISION-ID-1']
818
>>> br2.update_revisions(br1)
819
Added 0 texts.
820
Added 0 inventories.
821
Added 0 revisions.
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
823
True
824
"""
825
from bzrlib.progress import ProgressBar
826
827
pb = ProgressBar()
828
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
831
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
838
839
revisions = []
840
needed_texts = set()
841
i = 0
842
for rev_id in revision_ids:
843
i += 1
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
850
continue
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
853
854
pb.clear()
855
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
860
inventory_ids)
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
864
revision_ids)
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
868
869
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
873
874
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
878
return info
879
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
882
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
887
"""
888
if revision is None:
889
return 0, None
890
revno = None
891
try:# Convert to int if possible
892
revision = int(revision)
893
except ValueError:
894
pass
895
revs = self.revision_history()
896
if isinstance(revision, int):
897
if revision == 0:
898
return 0, None
899
# Mabye we should do this first, but we don't need it if revision == 0
900
if revision < 0:
901
revno = len(revs) + revision + 1
902
else:
903
revno = revision
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
908
break
909
else:
910
raise BzrError('No namespace registered for string: %r' % revision)
911
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
915
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
919
try:
920
return int(revision[6:])
921
except ValueError:
922
return None
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
924
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
927
try:
928
return revs.index(revision[6:]) + 1
929
except ValueError:
930
return None
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
932
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
935
try:
936
offset = int(revision[5:])
937
except ValueError:
938
return None
939
else:
940
if offset <= 0:
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
944
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
949
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
952
import datetime
953
# Spec for date revisions:
954
# date:value
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
959
#
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
964
#
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
968
val = revision[5:]
969
match_style = '='
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
972
val = val[1:]
973
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
978
dt = today
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
981
else:
982
import re
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
986
r'(,|T)?\s*'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
988
)
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
992
993
if m.group('date'):
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
995
else:
996
year, month, day = today.year, today.month, today.day
997
if m.group('time'):
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1002
else:
1003
second = 0
1004
else:
1005
hour, minute, second = 0,0,0
1006
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1009
first = dt
1010
last = None
1011
reversed = False
1012
if match_style == '-':
1013
reversed = True
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1016
1017
if reversed:
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1023
return i+1
1024
else:
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1030
return i+1
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1032
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1035
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1041
return EmptyTree()
1042
else:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1045
1046
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
1051
369
"""Pull in new perfect-fit revisions.
370
371
:param other: Another Branch to pull from
372
:param stop_revision: Updated until the given revision
373
:return: None
374
"""
375
raise NotImplementedError(self.update_revisions)
376
377
def revision_id_to_revno(self, revision_id):
378
"""Given a revision id, return its revno"""
379
if revision_id is None:
380
return 0
381
revision_id = osutils.safe_revision_id(revision_id)
382
history = self.revision_history()
383
try:
384
return history.index(revision_id) + 1
385
except ValueError:
386
raise bzrlib.errors.NoSuchRevision(self, revision_id)
387
388
def get_rev_id(self, revno, history=None):
389
"""Find the revision id of the specified revno."""
390
if revno == 0:
391
return None
392
if history is None:
393
history = self.revision_history()
394
if revno <= 0 or revno > len(history):
395
raise bzrlib.errors.NoSuchRevision(self, revno)
396
return history[revno - 1]
397
398
def pull(self, source, overwrite=False, stop_revision=None):
399
"""Mirror source into this branch.
400
401
This branch is considered to be 'local', having low latency.
402
"""
403
raise NotImplementedError(self.pull)
404
405
def push(self, target, overwrite=False, stop_revision=None):
406
"""Mirror this branch into target.
407
408
This branch is considered to be 'local', having low latency.
409
"""
410
raise NotImplementedError(self.push)
1052
411
1053
412
def basis_tree(self):
1054
"""Return `Tree` object for last revision.
1055
1056
If there are no revisions yet, return an `EmptyTree`.
1057
"""
1058
r = self.last_patch()
1059
if r == None:
1060
return EmptyTree()
1061
else:
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1063
1064
413
"""Return `Tree` object for last revision."""
414
return self.repository.revision_tree(self.last_revision())
1065
415
1066
416
def rename_one(self, from_rel, to_rel):
1067
417
"""Rename one file.
1068
418
1069
419
This can change the directory or the filename or both.
1070
420
"""
1071
self.lock_write()
1072
try:
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1079
1080
file_id = inv.path2id(from_rel)
1081
if file_id == None:
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1083
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1086
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1091
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1098
1099
inv.rename(file_id, to_dir_id, to_tail)
1100
1101
print "%s => %s" % (from_rel, to_rel)
1102
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1105
try:
1106
os.rename(from_abs, to_abs)
1107
except OSError, e:
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1111
1112
self._write_inventory(inv)
1113
finally:
1114
self.unlock()
1115
421
raise NotImplementedError(self.rename_one)
1116
422
1117
423
def move(self, from_paths, to_name):
1118
424
"""Rename files.
1124
430
1125
431
Note that to_name is only the last component of the new name;
1126
432
this doesn't change the directory.
1127
"""
1128
self.lock_write()
1129
try:
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1145
1146
to_idpath = inv.get_idpath(to_dir_id)
1147
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1152
if f_id == None:
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1160
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1164
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1170
try:
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1172
except OSError, e:
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1175
1176
self._write_inventory(inv)
1177
finally:
1178
self.unlock()
1179
1180
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1183
1184
backups
1185
If true (default) backups are made of files before
1186
they're renamed.
1187
"""
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1191
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1196
1197
nids = []
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1200
if not file_id:
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1205
1206
# TODO: Rename back if it was previously at a different location
1207
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1210
1211
# TODO: Make a backup to a temporary file.
1212
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1215
backup_file(fn)
1216
1217
f = AtomicFile(fn, 'wb')
1218
try:
1219
f.write(old_tree.get_file(file_id).read())
1220
f.commit()
1221
finally:
1222
f.close()
1223
1224
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1227
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1230
"""
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1233
return []
1234
p = []
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1237
return p
1238
1239
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1242
1243
validate_revision_id(revision_id)
1244
1245
p = self.pending_merges()
1246
if revision_id in p:
1247
return
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1250
1251
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1254
self.lock_write()
1255
try:
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1257
try:
1258
for l in rev_list:
1259
print >>f, l
1260
f.commit()
1261
finally:
1262
f.close()
1263
finally:
1264
self.unlock()
1265
1266
1267
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1270
1271
>>> b = ScratchBranch()
1272
>>> isdir(b.base)
1273
True
1274
>>> bd = b.base
1275
>>> b.destroy()
1276
>>> isdir(bd)
1277
False
1278
"""
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1281
1282
This creates a temporary directory and runs init-tree in it.
1283
1284
If any files are listed, they are created in the working copy.
1285
"""
1286
from tempfile import mkdtemp
1287
init = False
1288
if base is None:
1289
base = mkdtemp()
1290
init = True
1291
Branch.__init__(self, base, init=init)
1292
for d in dirs:
1293
os.mkdir(self.abspath(d))
1294
1295
for f in files:
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1297
1298
1299
def clone(self):
1300
"""
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1304
False
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
True
1307
"""
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1310
base = mkdtemp()
1311
os.rmdir(base)
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1314
1315
def __del__(self):
1316
self.destroy()
1317
1318
def destroy(self):
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1321
try:
1322
if self.base:
1323
mutter("delete ScratchBranch %s" % self.base)
1324
rmtree(self.base)
1325
except OSError, e:
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1330
for name in files:
1331
os.chmod(os.path.join(root, name), 0700)
1332
rmtree(self.base)
1333
self.base = None
1334
1335
433
434
This returns a list of (from_path, to_path) pairs for each
435
entry that is moved.
436
"""
437
raise NotImplementedError(self.move)
438
439
def get_parent(self):
440
"""Return the parent location of the branch.
441
442
This is the default location for push/pull/missing. The usual
443
pattern is that the user can override it by specifying a
444
location.
445
"""
446
raise NotImplementedError(self.get_parent)
447
448
def get_submit_branch(self):
449
"""Return the submit location of the branch.
450
451
This is the default location for bundle. The usual
452
pattern is that the user can override it by specifying a
453
location.
454
"""
455
return self.get_config().get_user_option('submit_branch')
456
457
def set_submit_branch(self, location):
458
"""Return the submit location of the branch.
459
460
This is the default location for bundle. The usual
461
pattern is that the user can override it by specifying a
462
location.
463
"""
464
self.get_config().set_user_option('submit_branch', location)
465
466
def get_push_location(self):
467
"""Return the None or the location to push this branch to."""
468
raise NotImplementedError(self.get_push_location)
469
470
def set_push_location(self, location):
471
"""Set a new push location for this branch."""
472
raise NotImplementedError(self.set_push_location)
473
474
def set_parent(self, url):
475
raise NotImplementedError(self.set_parent)
476
477
@needs_write_lock
478
def update(self):
479
"""Synchronise this branch with the master branch if any.
480
481
:return: None or the last_revision pivoted out during the update.
482
"""
483
return None
484
485
def check_revno(self, revno):
486
"""\
487
Check whether a revno corresponds to any revision.
488
Zero (the NULL revision) is considered valid.
489
"""
490
if revno != 0:
491
self.check_real_revno(revno)
492
493
def check_real_revno(self, revno):
494
"""\
495
Check whether a revno corresponds to a real revision.
496
Zero (the NULL revision) is considered invalid
497
"""
498
if revno < 1 or revno > self.revno():
499
raise InvalidRevisionNumber(revno)
500
501
@needs_read_lock
502
def clone(self, *args, **kwargs):
503
"""Clone this branch into to_bzrdir preserving all semantic values.
504
505
revision_id: if not None, the revision history in the new branch will
506
be truncated to end with revision_id.
507
"""
508
# for API compatibility, until 0.8 releases we provide the old api:
509
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
510
# after 0.8 releases, the *args and **kwargs should be changed:
511
# def clone(self, to_bzrdir, revision_id=None):
512
if (kwargs.get('to_location', None) or
513
kwargs.get('revision', None) or
514
kwargs.get('basis_branch', None) or
515
(len(args) and isinstance(args[0], basestring))):
516
# backwards compatibility api:
517
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
518
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
519
# get basis_branch
520
if len(args) > 2:
521
basis_branch = args[2]
522
else:
523
basis_branch = kwargs.get('basis_branch', None)
524
if basis_branch:
525
basis = basis_branch.bzrdir
526
else:
527
basis = None
528
# get revision
529
if len(args) > 1:
530
revision_id = args[1]
531
else:
532
revision_id = kwargs.get('revision', None)
533
# get location
534
if len(args):
535
url = args[0]
536
else:
537
# no default to raise if not provided.
538
url = kwargs.get('to_location')
539
return self.bzrdir.clone(url,
540
revision_id=revision_id,
541
basis=basis).open_branch()
542
# new cleaner api.
543
# generate args by hand
544
if len(args) > 1:
545
revision_id = args[1]
546
else:
547
revision_id = kwargs.get('revision_id', None)
548
if len(args):
549
to_bzrdir = args[0]
550
else:
551
# no default to raise if not provided.
552
to_bzrdir = kwargs.get('to_bzrdir')
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id=revision_id)
555
return result
556
557
@needs_read_lock
558
def sprout(self, to_bzrdir, revision_id=None):
559
"""Create a new line of development from the branch, into to_bzrdir.
560
561
revision_id: if not None, the revision history in the new branch will
562
be truncated to end with revision_id.
563
"""
564
result = self._format.initialize(to_bzrdir)
565
self.copy_content_into(result, revision_id=revision_id)
566
result.set_parent(self.bzrdir.root_transport.base)
567
return result
568
569
def _synchronize_history(self, destination, revision_id):
570
"""Synchronize last revision and revision history between branches.
571
572
This version is most efficient when the destination is also a
573
BzrBranch5, but works for BzrBranch6 as long as the revision
574
history is the true lefthand parent history, and all of the revisions
575
are in the destination's repository. If not, set_revision_history
576
will fail.
577
578
:param destination: The branch to copy the history into
579
:param revision_id: The revision-id to truncate history at. May
580
be None to copy complete history.
581
"""
582
new_history = self.revision_history()
583
if revision_id is not None:
584
revision_id = osutils.safe_revision_id(revision_id)
585
try:
586
new_history = new_history[:new_history.index(revision_id) + 1]
587
except ValueError:
588
rev = self.repository.get_revision(revision_id)
589
new_history = rev.get_history(self.repository)[1:]
590
destination.set_revision_history(new_history)
591
592
@needs_read_lock
593
def copy_content_into(self, destination, revision_id=None):
594
"""Copy the content of self into destination.
595
596
revision_id: if not None, the revision history in the new branch will
597
be truncated to end with revision_id.
598
"""
599
self._synchronize_history(destination, revision_id)
600
try:
601
parent = self.get_parent()
602
except errors.InaccessibleParent, e:
603
mutter('parent was not accessible to copy: %s', e)
604
else:
605
if parent:
606
destination.set_parent(parent)
607
608
@needs_read_lock
609
def check(self):
610
"""Check consistency of the branch.
611
612
In particular this checks that revisions given in the revision-history
613
do actually match up in the revision graph, and that they're all
614
present in the repository.
615
616
Callers will typically also want to check the repository.
617
618
:return: A BranchCheckResult.
619
"""
620
mainline_parent_id = None
621
for revision_id in self.revision_history():
622
try:
623
revision = self.repository.get_revision(revision_id)
624
except errors.NoSuchRevision, e:
625
raise errors.BzrCheckError("mainline revision {%s} not in repository"
626
% revision_id)
627
# In general the first entry on the revision history has no parents.
628
# But it's not illegal for it to have parents listed; this can happen
629
# in imports from Arch when the parents weren't reachable.
630
if mainline_parent_id is not None:
631
if mainline_parent_id not in revision.parent_ids:
632
raise errors.BzrCheckError("previous revision {%s} not listed among "
633
"parents of {%s}"
634
% (mainline_parent_id, revision_id))
635
mainline_parent_id = revision_id
636
return BranchCheckResult(self)
637
638
def _get_checkout_format(self):
639
"""Return the most suitable metadir for a checkout of this branch.
640
Weaves are used if this branch's repostory uses weaves.
641
"""
642
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
643
from bzrlib.repofmt import weaverepo
644
format = bzrdir.BzrDirMetaFormat1()
645
format.repository_format = weaverepo.RepositoryFormat7()
646
else:
647
format = self.repository.bzrdir.checkout_metadir()
648
format.branch_format = self._format
649
return format
650
651
def create_checkout(self, to_location, revision_id=None,
652
lightweight=False):
653
"""Create a checkout of a branch.
654
655
:param to_location: The url to produce the checkout at
656
:param revision_id: The revision to check out
657
:param lightweight: If True, produce a lightweight checkout, otherwise,
658
produce a bound branch (heavyweight checkout)
659
:return: The tree of the created checkout
660
"""
661
t = transport.get_transport(to_location)
662
try:
663
t.mkdir('.')
664
except errors.FileExists:
665
pass
666
if lightweight:
667
format = self._get_checkout_format()
668
checkout = format.initialize_on_transport(t)
669
BranchReferenceFormat().initialize(checkout, self)
670
else:
671
format = self._get_checkout_format()
672
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
673
to_location, force_new_tree=False, format=format)
674
checkout = checkout_branch.bzrdir
675
checkout_branch.bind(self)
676
# pull up to the specified revision_id to set the initial
677
# branch tip correctly, and seed it with history.
678
checkout_branch.pull(self, stop_revision=revision_id)
679
tree = checkout.create_workingtree(revision_id)
680
for path, entry in tree.iter_reference_entries():
681
path = tree.id2path(entry.file_id)
682
reference_parent = self.reference_parent(entry.file_id, path)
683
reference_parent.create_checkout(tree.abspath(path),
684
entry.reference_revision,
685
lightweight)
686
return tree
687
688
def reference_parent(self, file_id, path):
689
"""Return the parent branch for a tree-reference file_id
690
:param file_id: The file_id of the tree reference
691
:param path: The path of the file_id in the tree
692
:return: A branch associated with the file_id
693
"""
694
# FIXME should provide multiple branches, based on config
695
return Branch.open(self.bzrdir.root_transport.clone(path).base)
696
697
698
class BranchFormat(object):
699
"""An encapsulation of the initialization and open routines for a format.
700
701
Formats provide three things:
702
* An initialization routine,
703
* a format string,
704
* an open routine.
705
706
Formats are placed in an dict by their format string for reference
707
during branch opening. Its not required that these be instances, they
708
can be classes themselves with class methods - it simply depends on
709
whether state is needed for a given format or not.
710
711
Once a format is deprecated, just deprecate the initialize and open
712
methods on the format class. Do not deprecate the object, as the
713
object will be created every time regardless.
714
"""
715
716
_default_format = None
717
"""The default format used for new branches."""
718
719
_formats = {}
720
"""The known formats."""
721
722
@classmethod
723
def find_format(klass, a_bzrdir):
724
"""Return the format for the branch object in a_bzrdir."""
725
try:
726
transport = a_bzrdir.get_branch_transport(None)
727
format_string = transport.get("format").read()
728
return klass._formats[format_string]
729
except NoSuchFile:
730
raise NotBranchError(path=transport.base)
731
except KeyError:
732
raise errors.UnknownFormatError(format=format_string)
733
734
@classmethod
735
def get_default_format(klass):
736
"""Return the current default format."""
737
return klass._default_format
738
739
def get_format_string(self):
740
"""Return the ASCII format string that identifies this format."""
741
raise NotImplementedError(self.get_format_string)
742
743
def get_format_description(self):
744
"""Return the short format description for this format."""
745
raise NotImplementedError(self.get_format_description)
746
747
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
748
set_format=True):
749
"""Initialize a branch in a bzrdir, with specified files
750
751
:param a_bzrdir: The bzrdir to initialize the branch in
752
:param utf8_files: The files to create as a list of
753
(filename, content) tuples
754
:param set_format: If True, set the format with
755
self.get_format_string. (BzrBranch4 has its format set
756
elsewhere)
757
:return: a branch in this format
758
"""
759
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
760
branch_transport = a_bzrdir.get_branch_transport(self)
761
lock_map = {
762
'metadir': ('lock', lockdir.LockDir),
763
'branch4': ('branch-lock', lockable_files.TransportLock),
764
}
765
lock_name, lock_class = lock_map[lock_type]
766
control_files = lockable_files.LockableFiles(branch_transport,
767
lock_name, lock_class)
768
control_files.create_lock()
769
control_files.lock_write()
770
if set_format:
771
control_files.put_utf8('format', self.get_format_string())
772
try:
773
for file, content in utf8_files:
774
control_files.put_utf8(file, content)
775
finally:
776
control_files.unlock()
777
return self.open(a_bzrdir, _found=True)
778
779
def initialize(self, a_bzrdir):
780
"""Create a branch of this format in a_bzrdir."""
781
raise NotImplementedError(self.initialize)
782
783
def is_supported(self):
784
"""Is this format supported?
785
786
Supported formats can be initialized and opened.
787
Unsupported formats may not support initialization or committing or
788
some other features depending on the reason for not being supported.
789
"""
790
return True
791
792
def open(self, a_bzrdir, _found=False):
793
"""Return the branch object for a_bzrdir
794
795
_found is a private parameter, do not use it. It is used to indicate
796
if format probing has already be done.
797
"""
798
raise NotImplementedError(self.open)
799
800
@classmethod
801
def register_format(klass, format):
802
klass._formats[format.get_format_string()] = format
803
804
@classmethod
805
def set_default_format(klass, format):
806
klass._default_format = format
807
808
@classmethod
809
def unregister_format(klass, format):
810
assert klass._formats[format.get_format_string()] is format
811
del klass._formats[format.get_format_string()]
812
813
def __str__(self):
814
return self.get_format_string().rstrip()
815
816
817
class BranchHooks(dict):
818
"""A dictionary mapping hook name to a list of callables for branch hooks.
819
820
e.g. ['set_rh'] Is the list of items to be called when the
821
set_revision_history function is invoked.
822
"""
823
824
def __init__(self):
825
"""Create the default hooks.
826
827
These are all empty initially, because by default nothing should get
828
notified.
829
"""
830
dict.__init__(self)
831
# Introduced in 0.15:
832
# invoked whenever the revision history has been set
833
# with set_revision_history. The api signature is
834
# (branch, revision_history), and the branch will
835
# be write-locked.
836
self['set_rh'] = []
837
# invoked after a push operation completes.
838
# the api signature is
839
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
840
# where local is the local branch or None, master is the target
841
# master branch, and the rest should be self explanatory. The source
842
# is read locked and the target branches write locked. Source will
843
# be the local low-latency branch.
844
self['post_push'] = []
845
# invoked after a pull operation completes.
846
# the api signature is
847
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
848
# where local is the local branch or None, master is the target
849
# master branch, and the rest should be self explanatory. The source
850
# is read locked and the target branches write locked. The local
851
# branch is the low-latency branch.
852
self['post_pull'] = []
853
# invoked after a commit operation completes.
854
# the api signature is
855
# (local, master, old_revno, old_revid, new_revno, new_revid)
856
# old_revid is NULL_REVISION for the first commit to a branch.
857
self['post_commit'] = []
858
# invoked after a uncommit operation completes.
859
# the api signature is
860
# (local, master, old_revno, old_revid, new_revno, new_revid) where
861
# local is the local branch or None, master is the target branch,
862
# and an empty branch recieves new_revno of 0, new_revid of None.
863
self['post_uncommit'] = []
864
865
def install_hook(self, hook_name, a_callable):
866
"""Install a_callable in to the hook hook_name.
867
868
:param hook_name: A hook name. See the __init__ method of BranchHooks
869
for the complete list of hooks.
870
:param a_callable: The callable to be invoked when the hook triggers.
871
The exact signature will depend on the hook - see the __init__
872
method of BranchHooks for details on each hook.
873
"""
874
try:
875
self[hook_name].append(a_callable)
876
except KeyError:
877
raise errors.UnknownHook('branch', hook_name)
878
879
880
# install the default hooks into the Branch class.
881
Branch.hooks = BranchHooks()
882
883
884
class BzrBranchFormat4(BranchFormat):
885
"""Bzr branch format 4.
886
887
This format has:
888
- a revision-history file.
889
- a branch-lock lock file [ to be shared with the bzrdir ]
890
"""
891
892
def get_format_description(self):
893
"""See BranchFormat.get_format_description()."""
894
return "Branch format 4"
895
896
def initialize(self, a_bzrdir):
897
"""Create a branch of this format in a_bzrdir."""
898
utf8_files = [('revision-history', ''),
899
('branch-name', ''),
900
]
901
return self._initialize_helper(a_bzrdir, utf8_files,
902
lock_type='branch4', set_format=False)
903
904
def __init__(self):
905
super(BzrBranchFormat4, self).__init__()
906
self._matchingbzrdir = bzrdir.BzrDirFormat6()
907
908
def open(self, a_bzrdir, _found=False):
909
"""Return the branch object for a_bzrdir
910
911
_found is a private parameter, do not use it. It is used to indicate
912
if format probing has already be done.
913
"""
914
if not _found:
915
# we are being called directly and must probe.
916
raise NotImplementedError
917
return BzrBranch(_format=self,
918
_control_files=a_bzrdir._control_files,
919
a_bzrdir=a_bzrdir,
920
_repository=a_bzrdir.open_repository())
921
922
def __str__(self):
923
return "Bazaar-NG branch format 4"
924
925
926
class BzrBranchFormat5(BranchFormat):
927
"""Bzr branch format 5.
928
929
This format has:
930
- a revision-history file.
931
- a format string
932
- a lock dir guarding the branch itself
933
- all of this stored in a branch/ subdirectory
934
- works with shared repositories.
935
936
This format is new in bzr 0.8.
937
"""
938
939
def get_format_string(self):
940
"""See BranchFormat.get_format_string()."""
941
return "Bazaar-NG branch format 5\n"
942
943
def get_format_description(self):
944
"""See BranchFormat.get_format_description()."""
945
return "Branch format 5"
946
947
def initialize(self, a_bzrdir):
948
"""Create a branch of this format in a_bzrdir."""
949
utf8_files = [('revision-history', ''),
950
('branch-name', ''),
951
]
952
return self._initialize_helper(a_bzrdir, utf8_files)
953
954
def __init__(self):
955
super(BzrBranchFormat5, self).__init__()
956
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
957
958
def open(self, a_bzrdir, _found=False):
959
"""Return the branch object for a_bzrdir
960
961
_found is a private parameter, do not use it. It is used to indicate
962
if format probing has already be done.
963
"""
964
if not _found:
965
format = BranchFormat.find_format(a_bzrdir)
966
assert format.__class__ == self.__class__
967
transport = a_bzrdir.get_branch_transport(None)
968
control_files = lockable_files.LockableFiles(transport, 'lock',
969
lockdir.LockDir)
970
return BzrBranch5(_format=self,
971
_control_files=control_files,
972
a_bzrdir=a_bzrdir,
973
_repository=a_bzrdir.find_repository())
974
975
def __str__(self):
976
return "Bazaar-NG Metadir branch format 5"
977
978
979
class BzrBranchFormat6(BzrBranchFormat5):
980
"""Branch format with last-revision
981
982
Unlike previous formats, this has no explicit revision history. Instead,
983
this just stores the last-revision, and the left-hand history leading
984
up to there is the history.
985
986
This format was introduced in bzr 0.15
987
"""
988
989
def get_format_string(self):
990
"""See BranchFormat.get_format_string()."""
991
return "Bazaar-NG branch format 6\n"
992
993
def get_format_description(self):
994
"""See BranchFormat.get_format_description()."""
995
return "Branch format 6"
996
997
def initialize(self, a_bzrdir):
998
"""Create a branch of this format in a_bzrdir."""
999
utf8_files = [('last-revision', '0 null:\n'),
1000
('branch-name', ''),
1001
('branch.conf', '')
1002
]
1003
return self._initialize_helper(a_bzrdir, utf8_files)
1004
1005
def open(self, a_bzrdir, _found=False):
1006
"""Return the branch object for a_bzrdir
1007
1008
_found is a private parameter, do not use it. It is used to indicate
1009
if format probing has already be done.
1010
"""
1011
if not _found:
1012
format = BranchFormat.find_format(a_bzrdir)
1013
assert format.__class__ == self.__class__
1014
transport = a_bzrdir.get_branch_transport(None)
1015
control_files = lockable_files.LockableFiles(transport, 'lock',
1016
lockdir.LockDir)
1017
return BzrBranch6(_format=self,
1018
_control_files=control_files,
1019
a_bzrdir=a_bzrdir,
1020
_repository=a_bzrdir.find_repository())
1021
1022
1023
class BranchReferenceFormat(BranchFormat):
1024
"""Bzr branch reference format.
1025
1026
Branch references are used in implementing checkouts, they
1027
act as an alias to the real branch which is at some other url.
1028
1029
This format has:
1030
- A location file
1031
- a format string
1032
"""
1033
1034
def get_format_string(self):
1035
"""See BranchFormat.get_format_string()."""
1036
return "Bazaar-NG Branch Reference Format 1\n"
1037
1038
def get_format_description(self):
1039
"""See BranchFormat.get_format_description()."""
1040
return "Checkout reference format 1"
1041
1042
def initialize(self, a_bzrdir, target_branch=None):
1043
"""Create a branch of this format in a_bzrdir."""
1044
if target_branch is None:
1045
# this format does not implement branch itself, thus the implicit
1046
# creation contract must see it as uninitializable
1047
raise errors.UninitializableFormat(self)
1048
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1049
branch_transport = a_bzrdir.get_branch_transport(self)
1050
branch_transport.put_bytes('location',
1051
target_branch.bzrdir.root_transport.base)
1052
branch_transport.put_bytes('format', self.get_format_string())
1053
return self.open(a_bzrdir, _found=True)
1054
1055
def __init__(self):
1056
super(BranchReferenceFormat, self).__init__()
1057
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1058
1059
def _make_reference_clone_function(format, a_branch):
1060
"""Create a clone() routine for a branch dynamically."""
1061
def clone(to_bzrdir, revision_id=None):
1062
"""See Branch.clone()."""
1063
return format.initialize(to_bzrdir, a_branch)
1064
# cannot obey revision_id limits when cloning a reference ...
1065
# FIXME RBC 20060210 either nuke revision_id for clone, or
1066
# emit some sort of warning/error to the caller ?!
1067
return clone
1068
1069
def open(self, a_bzrdir, _found=False):
1070
"""Return the branch that the branch reference in a_bzrdir points at.
1071
1072
_found is a private parameter, do not use it. It is used to indicate
1073
if format probing has already be done.
1074
"""
1075
if not _found:
1076
format = BranchFormat.find_format(a_bzrdir)
1077
assert format.__class__ == self.__class__
1078
transport = a_bzrdir.get_branch_transport(None)
1079
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1080
result = real_bzrdir.open_branch()
1081
# this changes the behaviour of result.clone to create a new reference
1082
# rather than a copy of the content of the branch.
1083
# I did not use a proxy object because that needs much more extensive
1084
# testing, and we are only changing one behaviour at the moment.
1085
# If we decide to alter more behaviours - i.e. the implicit nickname
1086
# then this should be refactored to introduce a tested proxy branch
1087
# and a subclass of that for use in overriding clone() and ....
1088
# - RBC 20060210
1089
result.clone = self._make_reference_clone_function(result)
1090
return result
1091
1092
1093
# formats which have no format string are not discoverable
1094
# and not independently creatable, so are not registered.
1095
__default_format = BzrBranchFormat5()
1096
BranchFormat.register_format(__default_format)
1097
BranchFormat.register_format(BranchReferenceFormat())
1098
BranchFormat.register_format(BzrBranchFormat6())
1099
BranchFormat.set_default_format(__default_format)
1100
_legacy_formats = [BzrBranchFormat4(),
1101
]
1102
1103
class BzrBranch(Branch):
1104
"""A branch stored in the actual filesystem.
1105
1106
Note that it's "local" in the context of the filesystem; it doesn't
1107
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1108
it's writable, and can be accessed via the normal filesystem API.
1109
"""
1110
1111
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1112
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1113
_control_files=None, a_bzrdir=None, _repository=None):
1114
"""Create new branch object at a particular location.
1115
1116
transport -- A Transport object, defining how to access files.
1117
1118
init -- If True, create new control files in a previously
1119
unversioned directory. If False, the branch must already
1120
be versioned.
1121
1122
relax_version_check -- If true, the usual check for the branch
1123
version is not applied. This is intended only for
1124
upgrade/recovery type use; it's not guaranteed that
1125
all operations will work on old format branches.
1126
"""
1127
if a_bzrdir is None:
1128
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1129
else:
1130
self.bzrdir = a_bzrdir
1131
self._transport = self.bzrdir.transport.clone('..')
1132
self._base = self._transport.base
1133
self._format = _format
1134
if _control_files is None:
1135
raise ValueError('BzrBranch _control_files is None')
1136
self.control_files = _control_files
1137
if deprecated_passed(init):
1138
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1139
"deprecated as of bzr 0.8. Please use Branch.create().",
1140
DeprecationWarning,
1141
stacklevel=2)
1142
if init:
1143
# this is slower than before deprecation, oh well never mind.
1144
# -> its deprecated.
1145
self._initialize(transport.base)
1146
self._check_format(_format)
1147
if deprecated_passed(relax_version_check):
1148
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1149
"relax_version_check parameter is deprecated as of bzr 0.8. "
1150
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1151
"open() method.",
1152
DeprecationWarning,
1153
stacklevel=2)
1154
if (not relax_version_check
1155
and not self._format.is_supported()):
1156
raise errors.UnsupportedFormatError(format=fmt)
1157
if deprecated_passed(transport):
1158
warn("BzrBranch.__init__(transport=XXX...): The transport "
1159
"parameter is deprecated as of bzr 0.8. "
1160
"Please use Branch.open, or bzrdir.open_branch().",
1161
DeprecationWarning,
1162
stacklevel=2)
1163
self.repository = _repository
1164
1165
def __str__(self):
1166
return '%s(%r)' % (self.__class__.__name__, self.base)
1167
1168
__repr__ = __str__
1169
1170
def _get_base(self):
1171
return self._base
1172
1173
base = property(_get_base, doc="The URL for the root of this branch.")
1174
1175
def _finish_transaction(self):
1176
"""Exit the current transaction."""
1177
return self.control_files._finish_transaction()
1178
1179
def get_transaction(self):
1180
"""Return the current active transaction.
1181
1182
If no transaction is active, this returns a passthrough object
1183
for which all data is immediately flushed and no caching happens.
1184
"""
1185
# this is an explicit function so that we can do tricky stuff
1186
# when the storage in rev_storage is elsewhere.
1187
# we probably need to hook the two 'lock a location' and
1188
# 'have a transaction' together more delicately, so that
1189
# we can have two locks (branch and storage) and one transaction
1190
# ... and finishing the transaction unlocks both, but unlocking
1191
# does not. - RBC 20051121
1192
return self.control_files.get_transaction()
1193
1194
def _set_transaction(self, transaction):
1195
"""Set a new active transaction."""
1196
return self.control_files._set_transaction(transaction)
1197
1198
def abspath(self, name):
1199
"""See Branch.abspath."""
1200
return self.control_files._transport.abspath(name)
1201
1202
def _check_format(self, format):
1203
"""Identify the branch format if needed.
1204
1205
The format is stored as a reference to the format object in
1206
self._format for code that needs to check it later.
1207
1208
The format parameter is either None or the branch format class
1209
used to open this branch.
1210
1211
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1212
"""
1213
if format is None:
1214
format = BranchFormat.find_format(self.bzrdir)
1215
self._format = format
1216
mutter("got branch format %s", self._format)
1217
1218
@needs_read_lock
1219
def get_root_id(self):
1220
"""See Branch.get_root_id."""
1221
tree = self.repository.revision_tree(self.last_revision())
1222
return tree.inventory.root.file_id
1223
1224
def is_locked(self):
1225
return self.control_files.is_locked()
1226
1227
def lock_write(self):
1228
self.repository.lock_write()
1229
try:
1230
self.control_files.lock_write()
1231
except:
1232
self.repository.unlock()
1233
raise
1234
1235
def lock_read(self):
1236
self.repository.lock_read()
1237
try:
1238
self.control_files.lock_read()
1239
except:
1240
self.repository.unlock()
1241
raise
1242
1243
def unlock(self):
1244
# TODO: test for failed two phase locks. This is known broken.
1245
try:
1246
self.control_files.unlock()
1247
finally:
1248
self.repository.unlock()
1249
1250
def peek_lock_mode(self):
1251
if self.control_files._lock_count == 0:
1252
return None
1253
else:
1254
return self.control_files._lock_mode
1255
1256
def get_physical_lock_status(self):
1257
return self.control_files.get_physical_lock_status()
1258
1259
@needs_read_lock
1260
def print_file(self, file, revision_id):
1261
"""See Branch.print_file."""
1262
return self.repository.print_file(file, revision_id)
1263
1264
@needs_write_lock
1265
def append_revision(self, *revision_ids):
1266
"""See Branch.append_revision."""
1267
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1268
for revision_id in revision_ids:
1269
_mod_revision.check_not_reserved_id(revision_id)
1270
mutter("add {%s} to revision-history" % revision_id)
1271
rev_history = self.revision_history()
1272
rev_history.extend(revision_ids)
1273
self.set_revision_history(rev_history)
1274
1275
def _write_revision_history(self, history):
1276
"""Factored out of set_revision_history.
1277
1278
This performs the actual writing to disk.
1279
It is intended to be called by BzrBranch5.set_revision_history."""
1280
self.control_files.put_bytes(
1281
'revision-history', '\n'.join(history))
1282
1283
@needs_write_lock
1284
def set_revision_history(self, rev_history):
1285
"""See Branch.set_revision_history."""
1286
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1287
self._write_revision_history(rev_history)
1288
transaction = self.get_transaction()
1289
history = transaction.map.find_revision_history()
1290
if history is not None:
1291
# update the revision history in the identity map.
1292
history[:] = list(rev_history)
1293
# this call is disabled because revision_history is
1294
# not really an object yet, and the transaction is for objects.
1295
# transaction.register_dirty(history)
1296
else:
1297
transaction.map.add_revision_history(rev_history)
1298
# this call is disabled because revision_history is
1299
# not really an object yet, and the transaction is for objects.
1300
# transaction.register_clean(history)
1301
for hook in Branch.hooks['set_rh']:
1302
hook(self, rev_history)
1303
1304
@needs_write_lock
1305
def set_last_revision_info(self, revno, revision_id):
1306
revision_id = osutils.safe_revision_id(revision_id)
1307
history = self._lefthand_history(revision_id)
1308
assert len(history) == revno, '%d != %d' % (len(history), revno)
1309
self.set_revision_history(history)
1310
1311
def _gen_revision_history(self):
1312
get_cached_utf8 = cache_utf8.get_cached_utf8
1313
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1314
self.control_files.get('revision-history').readlines()]
1315
return history
1316
1317
@needs_read_lock
1318
def revision_history(self):
1319
"""See Branch.revision_history."""
1320
transaction = self.get_transaction()
1321
history = transaction.map.find_revision_history()
1322
if history is not None:
1323
# mutter("cache hit for revision-history in %s", self)
1324
return list(history)
1325
history = self._gen_revision_history()
1326
transaction.map.add_revision_history(history)
1327
# this call is disabled because revision_history is
1328
# not really an object yet, and the transaction is for objects.
1329
# transaction.register_clean(history, precious=True)
1330
return list(history)
1331
1332
def _lefthand_history(self, revision_id, last_rev=None,
1333
other_branch=None):
1334
# stop_revision must be a descendant of last_revision
1335
stop_graph = self.repository.get_revision_graph(revision_id)
1336
if last_rev is not None and last_rev not in stop_graph:
1337
# our previous tip is not merged into stop_revision
1338
raise errors.DivergedBranches(self, other_branch)
1339
# make a new revision history from the graph
1340
current_rev_id = revision_id
1341
new_history = []
1342
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1343
new_history.append(current_rev_id)
1344
current_rev_id_parents = stop_graph[current_rev_id]
1345
try:
1346
current_rev_id = current_rev_id_parents[0]
1347
except IndexError:
1348
current_rev_id = None
1349
new_history.reverse()
1350
return new_history
1351
1352
@needs_write_lock
1353
def generate_revision_history(self, revision_id, last_rev=None,
1354
other_branch=None):
1355
"""Create a new revision history that will finish with revision_id.
1356
1357
:param revision_id: the new tip to use.
1358
:param last_rev: The previous last_revision. If not None, then this
1359
must be a ancestory of revision_id, or DivergedBranches is raised.
1360
:param other_branch: The other branch that DivergedBranches should
1361
raise with respect to.
1362
"""
1363
revision_id = osutils.safe_revision_id(revision_id)
1364
self.set_revision_history(self._lefthand_history(revision_id,
1365
last_rev, other_branch))
1366
1367
@needs_write_lock
1368
def update_revisions(self, other, stop_revision=None):
1369
"""See Branch.update_revisions."""
1370
other.lock_read()
1371
try:
1372
if stop_revision is None:
1373
stop_revision = other.last_revision()
1374
if stop_revision is None:
1375
# if there are no commits, we're done.
1376
return
1377
else:
1378
stop_revision = osutils.safe_revision_id(stop_revision)
1379
# whats the current last revision, before we fetch [and change it
1380
# possibly]
1381
last_rev = self.last_revision()
1382
# we fetch here regardless of whether we need to so that we pickup
1383
# filled in ghosts.
1384
self.fetch(other, stop_revision)
1385
my_ancestry = self.repository.get_ancestry(last_rev)
1386
if stop_revision in my_ancestry:
1387
# last_revision is a descendant of stop_revision
1388
return
1389
self.generate_revision_history(stop_revision, last_rev=last_rev,
1390
other_branch=other)
1391
finally:
1392
other.unlock()
1393
1394
def basis_tree(self):
1395
"""See Branch.basis_tree."""
1396
return self.repository.revision_tree(self.last_revision())
1397
1398
@deprecated_method(zero_eight)
1399
def working_tree(self):
1400
"""Create a Working tree object for this branch."""
1401
1402
from bzrlib.transport.local import LocalTransport
1403
if (self.base.find('://') != -1 or
1404
not isinstance(self._transport, LocalTransport)):
1405
raise NoWorkingTree(self.base)
1406
return self.bzrdir.open_workingtree()
1407
1408
@needs_write_lock
1409
def pull(self, source, overwrite=False, stop_revision=None,
1410
_hook_master=None, _run_hooks=True):
1411
"""See Branch.pull.
1412
1413
:param _hook_master: Private parameter - set the branch to
1414
be supplied as the master to push hooks.
1415
:param _run_hooks: Private parameter - allow disabling of
1416
hooks, used when pushing to a master branch.
1417
"""
1418
source.lock_read()
1419
try:
1420
old_count, old_tip = self.last_revision_info()
1421
try:
1422
self.update_revisions(source, stop_revision)
1423
except DivergedBranches:
1424
if not overwrite:
1425
raise
1426
if overwrite:
1427
self.set_revision_history(source.revision_history())
1428
new_count, new_tip = self.last_revision_info()
1429
if _run_hooks:
1430
if _hook_master:
1431
_hook_local = self
1432
else:
1433
_hook_master = self
1434
_hook_local = None
1435
for hook in Branch.hooks['post_pull']:
1436
hook(source, _hook_local, _hook_master, old_count, old_tip,
1437
new_count, new_tip)
1438
return new_count - old_count
1439
finally:
1440
source.unlock()
1441
1442
def _get_parent_location(self):
1443
_locs = ['parent', 'pull', 'x-pull']
1444
for l in _locs:
1445
try:
1446
return self.control_files.get(l).read().strip('\n')
1447
except NoSuchFile:
1448
pass
1449
return None
1450
1451
@needs_read_lock
1452
def push(self, target, overwrite=False, stop_revision=None,
1453
_hook_master=None, _run_hooks=True):
1454
"""See Branch.push.
1455
1456
:param _hook_master: Private parameter - set the branch to
1457
be supplied as the master to push hooks.
1458
:param _run_hooks: Private parameter - allow disabling of
1459
hooks, used when pushing to a master branch.
1460
"""
1461
target.lock_write()
1462
try:
1463
old_count, old_tip = target.last_revision_info()
1464
try:
1465
target.update_revisions(self, stop_revision)
1466
except DivergedBranches:
1467
if not overwrite:
1468
raise
1469
if overwrite:
1470
target.set_revision_history(self.revision_history())
1471
new_count, new_tip = target.last_revision_info()
1472
if _run_hooks:
1473
if _hook_master:
1474
_hook_local = target
1475
else:
1476
_hook_master = target
1477
_hook_local = None
1478
for hook in Branch.hooks['post_push']:
1479
hook(self, _hook_local, _hook_master, old_count, old_tip,
1480
new_count, new_tip)
1481
return new_count - old_count
1482
finally:
1483
target.unlock()
1484
1485
def get_parent(self):
1486
"""See Branch.get_parent."""
1487
1488
assert self.base[-1] == '/'
1489
parent = self._get_parent_location()
1490
if parent is None:
1491
return parent
1492
# This is an old-format absolute path to a local branch
1493
# turn it into a url
1494
if parent.startswith('/'):
1495
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1496
try:
1497
return urlutils.join(self.base[:-1], parent)
1498
except errors.InvalidURLJoin, e:
1499
raise errors.InaccessibleParent(parent, self.base)
1500
1501
def get_push_location(self):
1502
"""See Branch.get_push_location."""
1503
push_loc = self.get_config().get_user_option('push_location')
1504
return push_loc
1505
1506
def set_push_location(self, location):
1507
"""See Branch.set_push_location."""
1508
self.get_config().set_user_option(
1509
'push_location', location,
1510
store=_mod_config.STORE_LOCATION_NORECURSE)
1511
1512
@needs_write_lock
1513
def set_parent(self, url):
1514
"""See Branch.set_parent."""
1515
# TODO: Maybe delete old location files?
1516
# URLs should never be unicode, even on the local fs,
1517
# FIXUP this and get_parent in a future branch format bump:
1518
# read and rewrite the file, and have the new format code read
1519
# using .get not .get_utf8. RBC 20060125
1520
if url is not None:
1521
if isinstance(url, unicode):
1522
try:
1523
url = url.encode('ascii')
1524
except UnicodeEncodeError:
1525
raise bzrlib.errors.InvalidURL(url,
1526
"Urls must be 7-bit ascii, "
1527
"use bzrlib.urlutils.escape")
1528
url = urlutils.relative_url(self.base, url)
1529
self._set_parent_location(url)
1530
1531
def _set_parent_location(self, url):
1532
if url is None:
1533
self.control_files._transport.delete('parent')
1534
else:
1535
assert isinstance(url, str)
1536
self.control_files.put_bytes('parent', url + '\n')
1537
1538
@deprecated_function(zero_nine)
1539
def tree_config(self):
1540
"""DEPRECATED; call get_config instead.
1541
TreeConfig has become part of BranchConfig."""
1542
return TreeConfig(self)
1543
1544
1545
class BzrBranch5(BzrBranch):
1546
"""A format 5 branch. This supports new features over plan branches.
1547
1548
It has support for a master_branch which is the data for bound branches.
1549
"""
1550
1551
def __init__(self,
1552
_format,
1553
_control_files,
1554
a_bzrdir,
1555
_repository):
1556
super(BzrBranch5, self).__init__(_format=_format,
1557
_control_files=_control_files,
1558
a_bzrdir=a_bzrdir,
1559
_repository=_repository)
1560
1561
@needs_write_lock
1562
def pull(self, source, overwrite=False, stop_revision=None,
1563
_run_hooks=True):
1564
"""Extends branch.pull to be bound branch aware.
1565
1566
:param _run_hooks: Private parameter used to force hook running
1567
off during bound branch double-pushing.
1568
"""
1569
bound_location = self.get_bound_location()
1570
master_branch = None
1571
if bound_location and source.base != bound_location:
1572
# not pulling from master, so we need to update master.
1573
master_branch = self.get_master_branch()
1574
master_branch.lock_write()
1575
try:
1576
if master_branch:
1577
# pull from source into master.
1578
master_branch.pull(source, overwrite, stop_revision,
1579
_run_hooks=False)
1580
return super(BzrBranch5, self).pull(source, overwrite,
1581
stop_revision, _hook_master=master_branch,
1582
_run_hooks=_run_hooks)
1583
finally:
1584
if master_branch:
1585
master_branch.unlock()
1586
1587
@needs_read_lock
1588
def push(self, target, overwrite=False, stop_revision=None):
1589
"""Updates branch.push to be bound branch aware."""
1590
bound_location = target.get_bound_location()
1591
master_branch = None
1592
if bound_location and target.base != bound_location:
1593
# not pushing to master, so we need to update master.
1594
master_branch = target.get_master_branch()
1595
master_branch.lock_write()
1596
try:
1597
if master_branch:
1598
# push into the master from this branch.
1599
super(BzrBranch5, self).push(master_branch, overwrite,
1600
stop_revision, _run_hooks=False)
1601
# and push into the target branch from this. Note that we push from
1602
# this branch again, because its considered the highest bandwidth
1603
# repository.
1604
return super(BzrBranch5, self).push(target, overwrite,
1605
stop_revision, _hook_master=master_branch)
1606
finally:
1607
if master_branch:
1608
master_branch.unlock()
1609
1610
def get_bound_location(self):
1611
try:
1612
return self.control_files.get_utf8('bound').read()[:-1]
1613
except errors.NoSuchFile:
1614
return None
1615
1616
@needs_read_lock
1617
def get_master_branch(self):
1618
"""Return the branch we are bound to.
1619
1620
:return: Either a Branch, or None
1621
1622
This could memoise the branch, but if thats done
1623
it must be revalidated on each new lock.
1624
So for now we just don't memoise it.
1625
# RBC 20060304 review this decision.
1626
"""
1627
bound_loc = self.get_bound_location()
1628
if not bound_loc:
1629
return None
1630
try:
1631
return Branch.open(bound_loc)
1632
except (errors.NotBranchError, errors.ConnectionError), e:
1633
raise errors.BoundBranchConnectionFailure(
1634
self, bound_loc, e)
1635
1636
@needs_write_lock
1637
def set_bound_location(self, location):
1638
"""Set the target where this branch is bound to.
1639
1640
:param location: URL to the target branch
1641
"""
1642
if location:
1643
self.control_files.put_utf8('bound', location+'\n')
1644
else:
1645
try:
1646
self.control_files._transport.delete('bound')
1647
except NoSuchFile:
1648
return False
1649
return True
1650
1651
@needs_write_lock
1652
def bind(self, other):
1653
"""Bind this branch to the branch other.
1654
1655
This does not push or pull data between the branches, though it does
1656
check for divergence to raise an error when the branches are not
1657
either the same, or one a prefix of the other. That behaviour may not
1658
be useful, so that check may be removed in future.
1659
1660
:param other: The branch to bind to
1661
:type other: Branch
1662
"""
1663
# TODO: jam 20051230 Consider checking if the target is bound
1664
# It is debatable whether you should be able to bind to
1665
# a branch which is itself bound.
1666
# Committing is obviously forbidden,
1667
# but binding itself may not be.
1668
# Since we *have* to check at commit time, we don't
1669
# *need* to check here
1670
1671
# we want to raise diverged if:
1672
# last_rev is not in the other_last_rev history, AND
1673
# other_last_rev is not in our history, and do it without pulling
1674
# history around
1675
last_rev = self.last_revision()
1676
if last_rev is not None:
1677
other.lock_read()
1678
try:
1679
other_last_rev = other.last_revision()
1680
if other_last_rev is not None:
1681
# neither branch is new, we have to do some work to
1682
# ascertain diversion.
1683
remote_graph = other.repository.get_revision_graph(
1684
other_last_rev)
1685
local_graph = self.repository.get_revision_graph(last_rev)
1686
if (last_rev not in remote_graph and
1687
other_last_rev not in local_graph):
1688
raise errors.DivergedBranches(self, other)
1689
finally:
1690
other.unlock()
1691
self.set_bound_location(other.base)
1692
1693
@needs_write_lock
1694
def unbind(self):
1695
"""If bound, unbind"""
1696
return self.set_bound_location(None)
1697
1698
@needs_write_lock
1699
def update(self):
1700
"""Synchronise this branch with the master branch if any.
1701
1702
:return: None or the last_revision that was pivoted out during the
1703
update.
1704
"""
1705
master = self.get_master_branch()
1706
if master is not None:
1707
old_tip = self.last_revision()
1708
self.pull(master, overwrite=True)
1709
if old_tip in self.repository.get_ancestry(self.last_revision()):
1710
return None
1711
return old_tip
1712
return None
1713
1714
1715
class BzrBranch6(BzrBranch5):
1716
1717
@needs_read_lock
1718
def last_revision_info(self):
1719
revision_string = self.control_files.get('last-revision').read()
1720
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1721
revision_id = cache_utf8.get_cached_utf8(revision_id)
1722
revno = int(revno)
1723
return revno, revision_id
1724
1725
def last_revision(self):
1726
"""Return last revision id, or None"""
1727
revision_id = self.last_revision_info()[1]
1728
if revision_id == _mod_revision.NULL_REVISION:
1729
revision_id = None
1730
return revision_id
1731
1732
def _write_last_revision_info(self, revno, revision_id):
1733
"""Simply write out the revision id, with no checks.
1734
1735
Use set_last_revision_info to perform this safely.
1736
1737
Does not update the revision_history cache.
1738
Intended to be called by set_last_revision_info and
1739
_write_revision_history.
1740
"""
1741
if revision_id is None:
1742
revision_id = 'null:'
1743
out_string = '%d %s\n' % (revno, revision_id)
1744
self.control_files.put_bytes('last-revision', out_string)
1745
1746
@needs_write_lock
1747
def set_last_revision_info(self, revno, revision_id):
1748
revision_id = osutils.safe_revision_id(revision_id)
1749
if self._get_append_revisions_only():
1750
self._check_history_violation(revision_id)
1751
self._write_last_revision_info(revno, revision_id)
1752
transaction = self.get_transaction()
1753
cached_history = transaction.map.find_revision_history()
1754
if cached_history is not None:
1755
transaction.map.remove_object(cached_history)
1756
1757
def _check_history_violation(self, revision_id):
1758
last_revision = self.last_revision()
1759
if last_revision is None:
1760
return
1761
if last_revision not in self._lefthand_history(revision_id):
1762
raise errors.AppendRevisionsOnlyViolation(self.base)
1763
1764
def _gen_revision_history(self):
1765
"""Generate the revision history from last revision
1766
"""
1767
history = list(self.repository.iter_reverse_revision_history(
1768
self.last_revision()))
1769
history.reverse()
1770
return history
1771
1772
def _write_revision_history(self, history):
1773
"""Factored out of set_revision_history.
1774
1775
This performs the actual writing to disk, with format-specific checks.
1776
It is intended to be called by BzrBranch5.set_revision_history.
1777
"""
1778
if len(history) == 0:
1779
last_revision = 'null:'
1780
else:
1781
if history != self._lefthand_history(history[-1]):
1782
raise errors.NotLefthandHistory(history)
1783
last_revision = history[-1]
1784
if self._get_append_revisions_only():
1785
self._check_history_violation(last_revision)
1786
self._write_last_revision_info(len(history), last_revision)
1787
1788
@needs_write_lock
1789
def append_revision(self, *revision_ids):
1790
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1791
if len(revision_ids) == 0:
1792
return
1793
prev_revno, prev_revision = self.last_revision_info()
1794
for revision in self.repository.get_revisions(revision_ids):
1795
if prev_revision == _mod_revision.NULL_REVISION:
1796
if revision.parent_ids != []:
1797
raise errors.NotLeftParentDescendant(self, prev_revision,
1798
revision.revision_id)
1799
else:
1800
if revision.parent_ids[0] != prev_revision:
1801
raise errors.NotLeftParentDescendant(self, prev_revision,
1802
revision.revision_id)
1803
prev_revision = revision.revision_id
1804
self.set_last_revision_info(prev_revno + len(revision_ids),
1805
revision_ids[-1])
1806
1807
def _set_config_location(self, name, url, config=None,
1808
make_relative=False):
1809
if config is None:
1810
config = self.get_config()
1811
if url is None:
1812
url = ''
1813
elif make_relative:
1814
url = urlutils.relative_url(self.base, url)
1815
config.set_user_option(name, url)
1816
1817
1818
def _get_config_location(self, name, config=None):
1819
if config is None:
1820
config = self.get_config()
1821
location = config.get_user_option(name)
1822
if location == '':
1823
location = None
1824
return location
1825
1826
@needs_write_lock
1827
def _set_parent_location(self, url):
1828
"""Set the parent branch"""
1829
self._set_config_location('parent_location', url, make_relative=True)
1830
1831
@needs_read_lock
1832
def _get_parent_location(self):
1833
"""Set the parent branch"""
1834
return self._get_config_location('parent_location')
1835
1836
def set_push_location(self, location):
1837
"""See Branch.set_push_location."""
1838
self._set_config_location('push_location', location)
1839
1840
def set_bound_location(self, location):
1841
"""See Branch.set_push_location."""
1842
result = None
1843
config = self.get_config()
1844
if location is None:
1845
if config.get_user_option('bound') != 'True':
1846
return False
1847
else:
1848
config.set_user_option('bound', 'False')
1849
return True
1850
else:
1851
self._set_config_location('bound_location', location,
1852
config=config)
1853
config.set_user_option('bound', 'True')
1854
return True
1855
1856
def _get_bound_location(self, bound):
1857
"""Return the bound location in the config file.
1858
1859
Return None if the bound parameter does not match"""
1860
config = self.get_config()
1861
config_bound = (config.get_user_option('bound') == 'True')
1862
if config_bound != bound:
1863
return None
1864
return self._get_config_location('bound_location', config=config)
1865
1866
def get_bound_location(self):
1867
"""See Branch.set_push_location."""
1868
return self._get_bound_location(True)
1869
1870
def get_old_bound_location(self):
1871
"""See Branch.get_old_bound_location"""
1872
return self._get_bound_location(False)
1873
1874
def set_append_revisions_only(self, enabled):
1875
if enabled:
1876
value = 'True'
1877
else:
1878
value = 'False'
1879
self.get_config().set_user_option('append_revisions_only', value)
1880
1881
def _get_append_revisions_only(self):
1882
value = self.get_config().get_user_option('append_revisions_only')
1883
return value == 'True'
1884
1885
def _synchronize_history(self, destination, revision_id):
1886
"""Synchronize last revision and revision history between branches.
1887
1888
This version is most efficient when the destination is also a
1889
BzrBranch6, but works for BzrBranch5, as long as the destination's
1890
repository contains all the lefthand ancestors of the intended
1891
last_revision. If not, set_last_revision_info will fail.
1892
1893
:param destination: The branch to copy the history into
1894
:param revision_id: The revision-id to truncate history at. May
1895
be None to copy complete history.
1896
"""
1897
if revision_id is None:
1898
revno, revision_id = self.last_revision_info()
1899
else:
1900
revno = self.revision_id_to_revno(revision_id)
1901
destination.set_last_revision_info(revno, revision_id)
1902
1903
1904
class BranchTestProviderAdapter(object):
1905
"""A tool to generate a suite testing multiple branch formats at once.
1906
1907
This is done by copying the test once for each transport and injecting
1908
the transport_server, transport_readonly_server, and branch_format
1909
classes into each copy. Each copy is also given a new id() to make it
1910
easy to identify.
1911
"""
1912
1913
def __init__(self, transport_server, transport_readonly_server, formats):
1914
self._transport_server = transport_server
1915
self._transport_readonly_server = transport_readonly_server
1916
self._formats = formats
1917
1918
def adapt(self, test):
1919
result = TestSuite()
1920
for branch_format, bzrdir_format in self._formats:
1921
new_test = deepcopy(test)
1922
new_test.transport_server = self._transport_server
1923
new_test.transport_readonly_server = self._transport_readonly_server
1924
new_test.bzrdir_format = bzrdir_format
1925
new_test.branch_format = branch_format
1926
def make_new_test_id():
1927
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1928
return lambda: new_id
1929
new_test.id = make_new_test_id()
1930
result.addTest(new_test)
1931
return result
1932
1933
1934
class BranchCheckResult(object):
1935
"""Results of checking branch consistency.
1936
1937
:see: Branch.check
1938
"""
1939
1940
def __init__(self, branch):
1941
self.branch = branch
1942
1943
def report_results(self, verbose):
1944
"""Report the check results via trace.note.
1945
1946
:param verbose: Requests more detailed display of what was checked,
1947
if any.
1948
"""
1949
note('checked branch %s format %s',
1950
self.branch.base,
1951
self.branch._format)
1952
1336
1953
1337
1954
######################################################################
1338
1955
# predicates
1339
1956
1340
1957
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
1348
return True
1349
if filename == head:
1350
break
1351
filename = head
1352
return False
1353
1354
1355
1356
def gen_file_id(name):
1357
"""Return new file id.
1358
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1361
slow."""
1362
import re
1363
from binascii import hexlify
1364
from time import time
1365
1366
# get last component
1367
idx = name.rfind('/')
1368
if idx != -1:
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1371
if idx != -1:
1372
name = name[idx+1 : ]
1373
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1376
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1380
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1383
1384
1385
def gen_root_id():
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
1388
1958
@deprecated_function(zero_eight)
1959
def is_control_file(*args, **kwargs):
1960
"""See bzrlib.workingtree.is_control_file."""
1961
from bzrlib import workingtree
1962
return workingtree.is_control_file(*args, **kwargs)
1963
1964
1965
class Converter5to6(object):
1966
"""Perform an in-place upgrade of format 5 to format 6"""
1967
1968
def convert(self, branch):
1969
# Data for 5 and 6 can peacefully coexist.
1970
format = BzrBranchFormat6()
1971
new_branch = format.open(branch.bzrdir, _found=True)
1972
1973
# Copy source data into target
1974
new_branch.set_last_revision_info(*branch.last_revision_info())
1975
new_branch.set_parent(branch.get_parent())
1976
new_branch.set_bound_location(branch.get_bound_location())
1977
new_branch.set_push_location(branch.get_push_location())
1978
1979
# Copying done; now update target format
1980
new_branch.control_files.put_utf8('format',
1981
format.get_format_string())
1982
1983
# Clean up old files
1984
new_branch.control_files._transport.delete('revision-history')
1985
try:
1986
branch.set_parent(None)
1987
except NoSuchFile:
1988
pass
1989
branch.set_bound_location(None)
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0