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 2290
- compare with another revision
- download diff
- download tarball
- view history from revision 2290
- Committer: Canonical.com Patch Queue Manager
- Date: 2007-02-15 15:11:31 UTC
- mfrom: (2230.3.55 branch6)
- Revision ID: pqm@pqm.ubuntu.com-20070215151131-1f2ce67d76e40200
Provide new branch6 format
- 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
history = self.revision_history()
382
try:
383
return history.index(revision_id) + 1
384
except ValueError:
385
raise bzrlib.errors.NoSuchRevision(self, revision_id)
386
387
def get_rev_id(self, revno, history=None):
388
"""Find the revision id of the specified revno."""
389
if revno == 0:
390
return None
391
if history is None:
392
history = self.revision_history()
393
if revno <= 0 or revno > len(history):
394
raise bzrlib.errors.NoSuchRevision(self, revno)
395
return history[revno - 1]
396
397
def pull(self, source, overwrite=False, stop_revision=None):
398
"""Mirror source into this branch.
399
400
This branch is considered to be 'local', having low latency.
401
"""
402
raise NotImplementedError(self.pull)
403
404
def push(self, target, overwrite=False, stop_revision=None):
405
"""Mirror this branch into target.
406
407
This branch is considered to be 'local', having low latency.
408
"""
409
raise NotImplementedError(self.push)
1052
410
1053
411
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
412
"""Return `Tree` object for last revision."""
413
return self.repository.revision_tree(self.last_revision())
1065
414
1066
415
def rename_one(self, from_rel, to_rel):
1067
416
"""Rename one file.
1068
417
1069
418
This can change the directory or the filename or both.
1070
419
"""
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
420
raise NotImplementedError(self.rename_one)
1116
421
1117
422
def move(self, from_paths, to_name):
1118
423
"""Rename files.
1124
429
1125
430
Note that to_name is only the last component of the new name;
1126
431
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
432
433
This returns a list of (from_path, to_path) pairs for each
434
entry that is moved.
435
"""
436
raise NotImplementedError(self.move)
437
438
def get_parent(self):
439
"""Return the parent location of the branch.
440
441
This is the default location for push/pull/missing. The usual
442
pattern is that the user can override it by specifying a
443
location.
444
"""
445
raise NotImplementedError(self.get_parent)
446
447
def get_submit_branch(self):
448
"""Return the submit location of the branch.
449
450
This is the default location for bundle. The usual
451
pattern is that the user can override it by specifying a
452
location.
453
"""
454
return self.get_config().get_user_option('submit_branch')
455
456
def set_submit_branch(self, location):
457
"""Return the submit location of the branch.
458
459
This is the default location for bundle. The usual
460
pattern is that the user can override it by specifying a
461
location.
462
"""
463
self.get_config().set_user_option('submit_branch', location)
464
465
def get_push_location(self):
466
"""Return the None or the location to push this branch to."""
467
raise NotImplementedError(self.get_push_location)
468
469
def set_push_location(self, location):
470
"""Set a new push location for this branch."""
471
raise NotImplementedError(self.set_push_location)
472
473
def set_parent(self, url):
474
raise NotImplementedError(self.set_parent)
475
476
@needs_write_lock
477
def update(self):
478
"""Synchronise this branch with the master branch if any.
479
480
:return: None or the last_revision pivoted out during the update.
481
"""
482
return None
483
484
def check_revno(self, revno):
485
"""\
486
Check whether a revno corresponds to any revision.
487
Zero (the NULL revision) is considered valid.
488
"""
489
if revno != 0:
490
self.check_real_revno(revno)
491
492
def check_real_revno(self, revno):
493
"""\
494
Check whether a revno corresponds to a real revision.
495
Zero (the NULL revision) is considered invalid
496
"""
497
if revno < 1 or revno > self.revno():
498
raise InvalidRevisionNumber(revno)
499
500
@needs_read_lock
501
def clone(self, *args, **kwargs):
502
"""Clone this branch into to_bzrdir preserving all semantic values.
503
504
revision_id: if not None, the revision history in the new branch will
505
be truncated to end with revision_id.
506
"""
507
# for API compatibility, until 0.8 releases we provide the old api:
508
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
509
# after 0.8 releases, the *args and **kwargs should be changed:
510
# def clone(self, to_bzrdir, revision_id=None):
511
if (kwargs.get('to_location', None) or
512
kwargs.get('revision', None) or
513
kwargs.get('basis_branch', None) or
514
(len(args) and isinstance(args[0], basestring))):
515
# backwards compatibility api:
516
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
517
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
518
# get basis_branch
519
if len(args) > 2:
520
basis_branch = args[2]
521
else:
522
basis_branch = kwargs.get('basis_branch', None)
523
if basis_branch:
524
basis = basis_branch.bzrdir
525
else:
526
basis = None
527
# get revision
528
if len(args) > 1:
529
revision_id = args[1]
530
else:
531
revision_id = kwargs.get('revision', None)
532
# get location
533
if len(args):
534
url = args[0]
535
else:
536
# no default to raise if not provided.
537
url = kwargs.get('to_location')
538
return self.bzrdir.clone(url,
539
revision_id=revision_id,
540
basis=basis).open_branch()
541
# new cleaner api.
542
# generate args by hand
543
if len(args) > 1:
544
revision_id = args[1]
545
else:
546
revision_id = kwargs.get('revision_id', None)
547
if len(args):
548
to_bzrdir = args[0]
549
else:
550
# no default to raise if not provided.
551
to_bzrdir = kwargs.get('to_bzrdir')
552
result = self._format.initialize(to_bzrdir)
553
self.copy_content_into(result, revision_id=revision_id)
554
return result
555
556
@needs_read_lock
557
def sprout(self, to_bzrdir, revision_id=None):
558
"""Create a new line of development from the branch, into to_bzrdir.
559
560
revision_id: if not None, the revision history in the new branch will
561
be truncated to end with revision_id.
562
"""
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
565
result.set_parent(self.bzrdir.root_transport.base)
566
return result
567
568
def _synchronize_history(self, destination, revision_id):
569
"""Synchronize last revision and revision history between branches.
570
571
This version is most efficient when the destination is also a
572
BzrBranch5, but works for BzrBranch6 as long as the revision
573
history is the true lefthand parent history, and all of the revisions
574
are in the destination's repository. If not, set_revision_history
575
will fail.
576
577
:param destination: The branch to copy the history into
578
:param revision_id: The revision-id to truncate history at. May
579
be None to copy complete history.
580
"""
581
new_history = self.revision_history()
582
if revision_id is not None:
583
try:
584
new_history = new_history[:new_history.index(revision_id) + 1]
585
except ValueError:
586
rev = self.repository.get_revision(revision_id)
587
new_history = rev.get_history(self.repository)[1:]
588
destination.set_revision_history(new_history)
589
590
@needs_read_lock
591
def copy_content_into(self, destination, revision_id=None):
592
"""Copy the content of self into destination.
593
594
revision_id: if not None, the revision history in the new branch will
595
be truncated to end with revision_id.
596
"""
597
self._synchronize_history(destination, revision_id)
598
try:
599
parent = self.get_parent()
600
except errors.InaccessibleParent, e:
601
mutter('parent was not accessible to copy: %s', e)
602
else:
603
if parent:
604
destination.set_parent(parent)
605
606
@needs_read_lock
607
def check(self):
608
"""Check consistency of the branch.
609
610
In particular this checks that revisions given in the revision-history
611
do actually match up in the revision graph, and that they're all
612
present in the repository.
613
614
Callers will typically also want to check the repository.
615
616
:return: A BranchCheckResult.
617
"""
618
mainline_parent_id = None
619
for revision_id in self.revision_history():
620
try:
621
revision = self.repository.get_revision(revision_id)
622
except errors.NoSuchRevision, e:
623
raise errors.BzrCheckError("mainline revision {%s} not in repository"
624
% revision_id)
625
# In general the first entry on the revision history has no parents.
626
# But it's not illegal for it to have parents listed; this can happen
627
# in imports from Arch when the parents weren't reachable.
628
if mainline_parent_id is not None:
629
if mainline_parent_id not in revision.parent_ids:
630
raise errors.BzrCheckError("previous revision {%s} not listed among "
631
"parents of {%s}"
632
% (mainline_parent_id, revision_id))
633
mainline_parent_id = revision_id
634
return BranchCheckResult(self)
635
636
def _get_checkout_format(self):
637
"""Return the most suitable metadir for a checkout of this branch.
638
Weaves are used if this branch's repostory uses weaves.
639
"""
640
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
641
from bzrlib.repofmt import weaverepo
642
format = bzrdir.BzrDirMetaFormat1()
643
format.repository_format = weaverepo.RepositoryFormat7()
644
else:
645
format = self.repository.bzrdir.cloning_metadir()
646
format.branch_format = self._format
647
return format
648
649
def create_checkout(self, to_location, revision_id=None,
650
lightweight=False):
651
"""Create a checkout of a branch.
652
653
:param to_location: The url to produce the checkout at
654
:param revision_id: The revision to check out
655
:param lightweight: If True, produce a lightweight checkout, otherwise,
656
produce a bound branch (heavyweight checkout)
657
:return: The tree of the created checkout
658
"""
659
t = transport.get_transport(to_location)
660
try:
661
t.mkdir('.')
662
except errors.FileExists:
663
pass
664
if lightweight:
665
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
666
BranchReferenceFormat().initialize(checkout, self)
667
else:
668
format = self._get_checkout_format()
669
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
670
to_location, force_new_tree=False, format=format)
671
checkout = checkout_branch.bzrdir
672
checkout_branch.bind(self)
673
# pull up to the specified revision_id to set the initial
674
# branch tip correctly, and seed it with history.
675
checkout_branch.pull(self, stop_revision=revision_id)
676
return checkout.create_workingtree(revision_id)
677
678
679
class BranchFormat(object):
680
"""An encapsulation of the initialization and open routines for a format.
681
682
Formats provide three things:
683
* An initialization routine,
684
* a format string,
685
* an open routine.
686
687
Formats are placed in an dict by their format string for reference
688
during branch opening. Its not required that these be instances, they
689
can be classes themselves with class methods - it simply depends on
690
whether state is needed for a given format or not.
691
692
Once a format is deprecated, just deprecate the initialize and open
693
methods on the format class. Do not deprecate the object, as the
694
object will be created every time regardless.
695
"""
696
697
_default_format = None
698
"""The default format used for new branches."""
699
700
_formats = {}
701
"""The known formats."""
702
703
@classmethod
704
def find_format(klass, a_bzrdir):
705
"""Return the format for the branch object in a_bzrdir."""
706
try:
707
transport = a_bzrdir.get_branch_transport(None)
708
format_string = transport.get("format").read()
709
return klass._formats[format_string]
710
except NoSuchFile:
711
raise NotBranchError(path=transport.base)
712
except KeyError:
713
raise errors.UnknownFormatError(format=format_string)
714
715
@classmethod
716
def get_default_format(klass):
717
"""Return the current default format."""
718
return klass._default_format
719
720
def get_format_string(self):
721
"""Return the ASCII format string that identifies this format."""
722
raise NotImplementedError(self.get_format_string)
723
724
def get_format_description(self):
725
"""Return the short format description for this format."""
726
raise NotImplementedError(self.get_format_description)
727
728
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
729
set_format=True):
730
"""Initialize a branch in a bzrdir, with specified files
731
732
:param a_bzrdir: The bzrdir to initialize the branch in
733
:param utf8_files: The files to create as a list of
734
(filename, content) tuples
735
:param set_format: If True, set the format with
736
self.get_format_string. (BzrBranch4 has its format set
737
elsewhere)
738
:return: a branch in this format
739
"""
740
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
741
branch_transport = a_bzrdir.get_branch_transport(self)
742
lock_map = {
743
'metadir': ('lock', lockdir.LockDir),
744
'branch4': ('branch-lock', lockable_files.TransportLock),
745
}
746
lock_name, lock_class = lock_map[lock_type]
747
control_files = lockable_files.LockableFiles(branch_transport,
748
lock_name, lock_class)
749
control_files.create_lock()
750
control_files.lock_write()
751
if set_format:
752
control_files.put_utf8('format', self.get_format_string())
753
try:
754
for file, content in utf8_files:
755
control_files.put_utf8(file, content)
756
finally:
757
control_files.unlock()
758
return self.open(a_bzrdir, _found=True)
759
760
def initialize(self, a_bzrdir):
761
"""Create a branch of this format in a_bzrdir."""
762
raise NotImplementedError(self.initialize)
763
764
def is_supported(self):
765
"""Is this format supported?
766
767
Supported formats can be initialized and opened.
768
Unsupported formats may not support initialization or committing or
769
some other features depending on the reason for not being supported.
770
"""
771
return True
772
773
def open(self, a_bzrdir, _found=False):
774
"""Return the branch object for a_bzrdir
775
776
_found is a private parameter, do not use it. It is used to indicate
777
if format probing has already be done.
778
"""
779
raise NotImplementedError(self.open)
780
781
@classmethod
782
def register_format(klass, format):
783
klass._formats[format.get_format_string()] = format
784
785
@classmethod
786
def set_default_format(klass, format):
787
klass._default_format = format
788
789
@classmethod
790
def unregister_format(klass, format):
791
assert klass._formats[format.get_format_string()] is format
792
del klass._formats[format.get_format_string()]
793
794
def __str__(self):
795
return self.get_format_string().rstrip()
796
797
798
class BranchHooks(dict):
799
"""A dictionary mapping hook name to a list of callables for branch hooks.
800
801
e.g. ['set_rh'] Is the list of items to be called when the
802
set_revision_history function is invoked.
803
"""
804
805
def __init__(self):
806
"""Create the default hooks.
807
808
These are all empty initially, because by default nothing should get
809
notified.
810
"""
811
dict.__init__(self)
812
# Introduced in 0.15:
813
# invoked whenever the revision history has been set
814
# with set_revision_history. The api signature is
815
# (branch, revision_history), and the branch will
816
# be write-locked.
817
self['set_rh'] = []
818
# invoked after a push operation completes.
819
# the api signature is
820
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
821
# where local is the local branch or None, master is the target
822
# master branch, and the rest should be self explanatory. The source
823
# is read locked and the target branches write locked. Source will
824
# be the local low-latency branch.
825
self['post_push'] = []
826
# invoked after a pull operation completes.
827
# the api signature is
828
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
829
# where local is the local branch or None, master is the target
830
# master branch, and the rest should be self explanatory. The source
831
# is read locked and the target branches write locked. The local
832
# branch is the low-latency branch.
833
self['post_pull'] = []
834
# invoked after a commit operation completes.
835
# the api signature is
836
# (local, master, old_revno, old_revid, new_revno, new_revid)
837
# old_revid is NULL_REVISION for the first commit to a branch.
838
self['post_commit'] = []
839
# invoked after a uncommit operation completes.
840
# the api signature is
841
# (local, master, old_revno, old_revid, new_revno, new_revid) where
842
# local is the local branch or None, master is the target branch,
843
# and an empty branch recieves new_revno of 0, new_revid of None.
844
self['post_uncommit'] = []
845
846
def install_hook(self, hook_name, a_callable):
847
"""Install a_callable in to the hook hook_name.
848
849
:param hook_name: A hook name. See the __init__ method of BranchHooks
850
for the complete list of hooks.
851
:param a_callable: The callable to be invoked when the hook triggers.
852
The exact signature will depend on the hook - see the __init__
853
method of BranchHooks for details on each hook.
854
"""
855
try:
856
self[hook_name].append(a_callable)
857
except KeyError:
858
raise errors.UnknownHook('branch', hook_name)
859
860
861
# install the default hooks into the Branch class.
862
Branch.hooks = BranchHooks()
863
864
865
class BzrBranchFormat4(BranchFormat):
866
"""Bzr branch format 4.
867
868
This format has:
869
- a revision-history file.
870
- a branch-lock lock file [ to be shared with the bzrdir ]
871
"""
872
873
def get_format_description(self):
874
"""See BranchFormat.get_format_description()."""
875
return "Branch format 4"
876
877
def initialize(self, a_bzrdir):
878
"""Create a branch of this format in a_bzrdir."""
879
utf8_files = [('revision-history', ''),
880
('branch-name', ''),
881
]
882
return self._initialize_helper(a_bzrdir, utf8_files,
883
lock_type='branch4', set_format=False)
884
885
def __init__(self):
886
super(BzrBranchFormat4, self).__init__()
887
self._matchingbzrdir = bzrdir.BzrDirFormat6()
888
889
def open(self, a_bzrdir, _found=False):
890
"""Return the branch object for a_bzrdir
891
892
_found is a private parameter, do not use it. It is used to indicate
893
if format probing has already be done.
894
"""
895
if not _found:
896
# we are being called directly and must probe.
897
raise NotImplementedError
898
return BzrBranch(_format=self,
899
_control_files=a_bzrdir._control_files,
900
a_bzrdir=a_bzrdir,
901
_repository=a_bzrdir.open_repository())
902
903
def __str__(self):
904
return "Bazaar-NG branch format 4"
905
906
907
class BzrBranchFormat5(BranchFormat):
908
"""Bzr branch format 5.
909
910
This format has:
911
- a revision-history file.
912
- a format string
913
- a lock dir guarding the branch itself
914
- all of this stored in a branch/ subdirectory
915
- works with shared repositories.
916
917
This format is new in bzr 0.8.
918
"""
919
920
def get_format_string(self):
921
"""See BranchFormat.get_format_string()."""
922
return "Bazaar-NG branch format 5\n"
923
924
def get_format_description(self):
925
"""See BranchFormat.get_format_description()."""
926
return "Branch format 5"
927
928
def initialize(self, a_bzrdir):
929
"""Create a branch of this format in a_bzrdir."""
930
utf8_files = [('revision-history', ''),
931
('branch-name', ''),
932
]
933
return self._initialize_helper(a_bzrdir, utf8_files)
934
935
def __init__(self):
936
super(BzrBranchFormat5, self).__init__()
937
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
938
939
def open(self, a_bzrdir, _found=False):
940
"""Return the branch object for a_bzrdir
941
942
_found is a private parameter, do not use it. It is used to indicate
943
if format probing has already be done.
944
"""
945
if not _found:
946
format = BranchFormat.find_format(a_bzrdir)
947
assert format.__class__ == self.__class__
948
transport = a_bzrdir.get_branch_transport(None)
949
control_files = lockable_files.LockableFiles(transport, 'lock',
950
lockdir.LockDir)
951
return BzrBranch5(_format=self,
952
_control_files=control_files,
953
a_bzrdir=a_bzrdir,
954
_repository=a_bzrdir.find_repository())
955
956
def __str__(self):
957
return "Bazaar-NG Metadir branch format 5"
958
959
960
class BzrBranchFormat6(BzrBranchFormat5):
961
"""Branch format with last-revision
962
963
Unlike previous formats, this has no explicit revision history. Instead,
964
this just stores the last-revision, and the left-hand history leading
965
up to there is the history.
966
967
This format was introduced in bzr 0.15
968
"""
969
970
def get_format_string(self):
971
"""See BranchFormat.get_format_string()."""
972
return "Bazaar-NG branch format 6\n"
973
974
def get_format_description(self):
975
"""See BranchFormat.get_format_description()."""
976
return "Branch format 6"
977
978
def initialize(self, a_bzrdir):
979
"""Create a branch of this format in a_bzrdir."""
980
utf8_files = [('last-revision', '0 null:\n'),
981
('branch-name', ''),
982
('branch.conf', '')
983
]
984
return self._initialize_helper(a_bzrdir, utf8_files)
985
986
def open(self, a_bzrdir, _found=False):
987
"""Return the branch object for a_bzrdir
988
989
_found is a private parameter, do not use it. It is used to indicate
990
if format probing has already be done.
991
"""
992
if not _found:
993
format = BranchFormat.find_format(a_bzrdir)
994
assert format.__class__ == self.__class__
995
transport = a_bzrdir.get_branch_transport(None)
996
control_files = lockable_files.LockableFiles(transport, 'lock',
997
lockdir.LockDir)
998
return BzrBranch6(_format=self,
999
_control_files=control_files,
1000
a_bzrdir=a_bzrdir,
1001
_repository=a_bzrdir.find_repository())
1002
1003
1004
class BranchReferenceFormat(BranchFormat):
1005
"""Bzr branch reference format.
1006
1007
Branch references are used in implementing checkouts, they
1008
act as an alias to the real branch which is at some other url.
1009
1010
This format has:
1011
- A location file
1012
- a format string
1013
"""
1014
1015
def get_format_string(self):
1016
"""See BranchFormat.get_format_string()."""
1017
return "Bazaar-NG Branch Reference Format 1\n"
1018
1019
def get_format_description(self):
1020
"""See BranchFormat.get_format_description()."""
1021
return "Checkout reference format 1"
1022
1023
def initialize(self, a_bzrdir, target_branch=None):
1024
"""Create a branch of this format in a_bzrdir."""
1025
if target_branch is None:
1026
# this format does not implement branch itself, thus the implicit
1027
# creation contract must see it as uninitializable
1028
raise errors.UninitializableFormat(self)
1029
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1030
branch_transport = a_bzrdir.get_branch_transport(self)
1031
branch_transport.put_bytes('location',
1032
target_branch.bzrdir.root_transport.base)
1033
branch_transport.put_bytes('format', self.get_format_string())
1034
return self.open(a_bzrdir, _found=True)
1035
1036
def __init__(self):
1037
super(BranchReferenceFormat, self).__init__()
1038
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1039
1040
def _make_reference_clone_function(format, a_branch):
1041
"""Create a clone() routine for a branch dynamically."""
1042
def clone(to_bzrdir, revision_id=None):
1043
"""See Branch.clone()."""
1044
return format.initialize(to_bzrdir, a_branch)
1045
# cannot obey revision_id limits when cloning a reference ...
1046
# FIXME RBC 20060210 either nuke revision_id for clone, or
1047
# emit some sort of warning/error to the caller ?!
1048
return clone
1049
1050
def open(self, a_bzrdir, _found=False):
1051
"""Return the branch that the branch reference in a_bzrdir points at.
1052
1053
_found is a private parameter, do not use it. It is used to indicate
1054
if format probing has already be done.
1055
"""
1056
if not _found:
1057
format = BranchFormat.find_format(a_bzrdir)
1058
assert format.__class__ == self.__class__
1059
transport = a_bzrdir.get_branch_transport(None)
1060
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1061
result = real_bzrdir.open_branch()
1062
# this changes the behaviour of result.clone to create a new reference
1063
# rather than a copy of the content of the branch.
1064
# I did not use a proxy object because that needs much more extensive
1065
# testing, and we are only changing one behaviour at the moment.
1066
# If we decide to alter more behaviours - i.e. the implicit nickname
1067
# then this should be refactored to introduce a tested proxy branch
1068
# and a subclass of that for use in overriding clone() and ....
1069
# - RBC 20060210
1070
result.clone = self._make_reference_clone_function(result)
1071
return result
1072
1073
1074
# formats which have no format string are not discoverable
1075
# and not independently creatable, so are not registered.
1076
__default_format = BzrBranchFormat5()
1077
BranchFormat.register_format(__default_format)
1078
BranchFormat.register_format(BranchReferenceFormat())
1079
BranchFormat.register_format(BzrBranchFormat6())
1080
BranchFormat.set_default_format(__default_format)
1081
_legacy_formats = [BzrBranchFormat4(),
1082
]
1083
1084
class BzrBranch(Branch):
1085
"""A branch stored in the actual filesystem.
1086
1087
Note that it's "local" in the context of the filesystem; it doesn't
1088
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1089
it's writable, and can be accessed via the normal filesystem API.
1090
"""
1091
1092
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1093
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1094
_control_files=None, a_bzrdir=None, _repository=None):
1095
"""Create new branch object at a particular location.
1096
1097
transport -- A Transport object, defining how to access files.
1098
1099
init -- If True, create new control files in a previously
1100
unversioned directory. If False, the branch must already
1101
be versioned.
1102
1103
relax_version_check -- If true, the usual check for the branch
1104
version is not applied. This is intended only for
1105
upgrade/recovery type use; it's not guaranteed that
1106
all operations will work on old format branches.
1107
"""
1108
if a_bzrdir is None:
1109
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1110
else:
1111
self.bzrdir = a_bzrdir
1112
self._transport = self.bzrdir.transport.clone('..')
1113
self._base = self._transport.base
1114
self._format = _format
1115
if _control_files is None:
1116
raise ValueError('BzrBranch _control_files is None')
1117
self.control_files = _control_files
1118
if deprecated_passed(init):
1119
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1120
"deprecated as of bzr 0.8. Please use Branch.create().",
1121
DeprecationWarning,
1122
stacklevel=2)
1123
if init:
1124
# this is slower than before deprecation, oh well never mind.
1125
# -> its deprecated.
1126
self._initialize(transport.base)
1127
self._check_format(_format)
1128
if deprecated_passed(relax_version_check):
1129
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1130
"relax_version_check parameter is deprecated as of bzr 0.8. "
1131
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1132
"open() method.",
1133
DeprecationWarning,
1134
stacklevel=2)
1135
if (not relax_version_check
1136
and not self._format.is_supported()):
1137
raise errors.UnsupportedFormatError(format=fmt)
1138
if deprecated_passed(transport):
1139
warn("BzrBranch.__init__(transport=XXX...): The transport "
1140
"parameter is deprecated as of bzr 0.8. "
1141
"Please use Branch.open, or bzrdir.open_branch().",
1142
DeprecationWarning,
1143
stacklevel=2)
1144
self.repository = _repository
1145
1146
def __str__(self):
1147
return '%s(%r)' % (self.__class__.__name__, self.base)
1148
1149
__repr__ = __str__
1150
1151
def _get_base(self):
1152
return self._base
1153
1154
base = property(_get_base, doc="The URL for the root of this branch.")
1155
1156
def _finish_transaction(self):
1157
"""Exit the current transaction."""
1158
return self.control_files._finish_transaction()
1159
1160
def get_transaction(self):
1161
"""Return the current active transaction.
1162
1163
If no transaction is active, this returns a passthrough object
1164
for which all data is immediately flushed and no caching happens.
1165
"""
1166
# this is an explicit function so that we can do tricky stuff
1167
# when the storage in rev_storage is elsewhere.
1168
# we probably need to hook the two 'lock a location' and
1169
# 'have a transaction' together more delicately, so that
1170
# we can have two locks (branch and storage) and one transaction
1171
# ... and finishing the transaction unlocks both, but unlocking
1172
# does not. - RBC 20051121
1173
return self.control_files.get_transaction()
1174
1175
def _set_transaction(self, transaction):
1176
"""Set a new active transaction."""
1177
return self.control_files._set_transaction(transaction)
1178
1179
def abspath(self, name):
1180
"""See Branch.abspath."""
1181
return self.control_files._transport.abspath(name)
1182
1183
def _check_format(self, format):
1184
"""Identify the branch format if needed.
1185
1186
The format is stored as a reference to the format object in
1187
self._format for code that needs to check it later.
1188
1189
The format parameter is either None or the branch format class
1190
used to open this branch.
1191
1192
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1193
"""
1194
if format is None:
1195
format = BranchFormat.find_format(self.bzrdir)
1196
self._format = format
1197
mutter("got branch format %s", self._format)
1198
1199
@needs_read_lock
1200
def get_root_id(self):
1201
"""See Branch.get_root_id."""
1202
tree = self.repository.revision_tree(self.last_revision())
1203
return tree.inventory.root.file_id
1204
1205
def is_locked(self):
1206
return self.control_files.is_locked()
1207
1208
def lock_write(self):
1209
self.repository.lock_write()
1210
try:
1211
self.control_files.lock_write()
1212
except:
1213
self.repository.unlock()
1214
raise
1215
1216
def lock_read(self):
1217
self.repository.lock_read()
1218
try:
1219
self.control_files.lock_read()
1220
except:
1221
self.repository.unlock()
1222
raise
1223
1224
def unlock(self):
1225
# TODO: test for failed two phase locks. This is known broken.
1226
try:
1227
self.control_files.unlock()
1228
finally:
1229
self.repository.unlock()
1230
1231
def peek_lock_mode(self):
1232
if self.control_files._lock_count == 0:
1233
return None
1234
else:
1235
return self.control_files._lock_mode
1236
1237
def get_physical_lock_status(self):
1238
return self.control_files.get_physical_lock_status()
1239
1240
@needs_read_lock
1241
def print_file(self, file, revision_id):
1242
"""See Branch.print_file."""
1243
return self.repository.print_file(file, revision_id)
1244
1245
@needs_write_lock
1246
def append_revision(self, *revision_ids):
1247
"""See Branch.append_revision."""
1248
for revision_id in revision_ids:
1249
_mod_revision.check_not_reserved_id(revision_id)
1250
mutter("add {%s} to revision-history" % revision_id)
1251
rev_history = self.revision_history()
1252
rev_history.extend(revision_ids)
1253
self.set_revision_history(rev_history)
1254
1255
def _write_revision_history(self, history):
1256
"""Factored out of set_revision_history.
1257
1258
This performs the actual writing to disk.
1259
It is intended to be called by BzrBranch5.set_revision_history."""
1260
self.control_files.put_utf8(
1261
'revision-history', '\n'.join(history))
1262
1263
@needs_write_lock
1264
def set_revision_history(self, rev_history):
1265
"""See Branch.set_revision_history."""
1266
self._write_revision_history(rev_history)
1267
transaction = self.get_transaction()
1268
history = transaction.map.find_revision_history()
1269
if history is not None:
1270
# update the revision history in the identity map.
1271
history[:] = list(rev_history)
1272
# this call is disabled because revision_history is
1273
# not really an object yet, and the transaction is for objects.
1274
# transaction.register_dirty(history)
1275
else:
1276
transaction.map.add_revision_history(rev_history)
1277
# this call is disabled because revision_history is
1278
# not really an object yet, and the transaction is for objects.
1279
# transaction.register_clean(history)
1280
for hook in Branch.hooks['set_rh']:
1281
hook(self, rev_history)
1282
1283
@needs_write_lock
1284
def set_last_revision_info(self, revno, revision_id):
1285
history = self._lefthand_history(revision_id)
1286
assert len(history) == revno, '%d != %d' % (len(history), revno)
1287
self.set_revision_history(history)
1288
1289
def _gen_revision_history(self):
1290
decode_utf8 = cache_utf8.decode
1291
history = [decode_utf8(l.rstrip('\r\n')) for l in
1292
self.control_files.get('revision-history').readlines()]
1293
return history
1294
1295
@needs_read_lock
1296
def revision_history(self):
1297
"""See Branch.revision_history."""
1298
transaction = self.get_transaction()
1299
history = transaction.map.find_revision_history()
1300
if history is not None:
1301
# mutter("cache hit for revision-history in %s", self)
1302
return list(history)
1303
history = self._gen_revision_history()
1304
transaction.map.add_revision_history(history)
1305
# this call is disabled because revision_history is
1306
# not really an object yet, and the transaction is for objects.
1307
# transaction.register_clean(history, precious=True)
1308
return list(history)
1309
1310
def _lefthand_history(self, revision_id, last_rev=None,
1311
other_branch=None):
1312
# stop_revision must be a descendant of last_revision
1313
stop_graph = self.repository.get_revision_graph(revision_id)
1314
if last_rev is not None and last_rev not in stop_graph:
1315
# our previous tip is not merged into stop_revision
1316
raise errors.DivergedBranches(self, other_branch)
1317
# make a new revision history from the graph
1318
current_rev_id = revision_id
1319
new_history = []
1320
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1321
new_history.append(current_rev_id)
1322
current_rev_id_parents = stop_graph[current_rev_id]
1323
try:
1324
current_rev_id = current_rev_id_parents[0]
1325
except IndexError:
1326
current_rev_id = None
1327
new_history.reverse()
1328
return new_history
1329
1330
@needs_write_lock
1331
def generate_revision_history(self, revision_id, last_rev=None,
1332
other_branch=None):
1333
"""Create a new revision history that will finish with revision_id.
1334
1335
:param revision_id: the new tip to use.
1336
:param last_rev: The previous last_revision. If not None, then this
1337
must be a ancestory of revision_id, or DivergedBranches is raised.
1338
:param other_branch: The other branch that DivergedBranches should
1339
raise with respect to.
1340
"""
1341
self.set_revision_history(self._lefthand_history(revision_id,
1342
last_rev, other_branch))
1343
1344
@needs_write_lock
1345
def update_revisions(self, other, stop_revision=None):
1346
"""See Branch.update_revisions."""
1347
other.lock_read()
1348
try:
1349
if stop_revision is None:
1350
stop_revision = other.last_revision()
1351
if stop_revision is None:
1352
# if there are no commits, we're done.
1353
return
1354
# whats the current last revision, before we fetch [and change it
1355
# possibly]
1356
last_rev = self.last_revision()
1357
# we fetch here regardless of whether we need to so that we pickup
1358
# filled in ghosts.
1359
self.fetch(other, stop_revision)
1360
my_ancestry = self.repository.get_ancestry(last_rev)
1361
if stop_revision in my_ancestry:
1362
# last_revision is a descendant of stop_revision
1363
return
1364
self.generate_revision_history(stop_revision, last_rev=last_rev,
1365
other_branch=other)
1366
finally:
1367
other.unlock()
1368
1369
def basis_tree(self):
1370
"""See Branch.basis_tree."""
1371
return self.repository.revision_tree(self.last_revision())
1372
1373
@deprecated_method(zero_eight)
1374
def working_tree(self):
1375
"""Create a Working tree object for this branch."""
1376
1377
from bzrlib.transport.local import LocalTransport
1378
if (self.base.find('://') != -1 or
1379
not isinstance(self._transport, LocalTransport)):
1380
raise NoWorkingTree(self.base)
1381
return self.bzrdir.open_workingtree()
1382
1383
@needs_write_lock
1384
def pull(self, source, overwrite=False, stop_revision=None,
1385
_hook_master=None, _run_hooks=True):
1386
"""See Branch.pull.
1387
1388
:param _hook_master: Private parameter - set the branch to
1389
be supplied as the master to push hooks.
1390
:param _run_hooks: Private parameter - allow disabling of
1391
hooks, used when pushing to a master branch.
1392
"""
1393
source.lock_read()
1394
try:
1395
old_count, old_tip = self.last_revision_info()
1396
try:
1397
self.update_revisions(source, stop_revision)
1398
except DivergedBranches:
1399
if not overwrite:
1400
raise
1401
if overwrite:
1402
self.set_revision_history(source.revision_history())
1403
new_count, new_tip = self.last_revision_info()
1404
if _run_hooks:
1405
if _hook_master:
1406
_hook_local = self
1407
else:
1408
_hook_master = self
1409
_hook_local = None
1410
for hook in Branch.hooks['post_pull']:
1411
hook(source, _hook_local, _hook_master, old_count, old_tip,
1412
new_count, new_tip)
1413
return new_count - old_count
1414
finally:
1415
source.unlock()
1416
1417
def _get_parent_location(self):
1418
_locs = ['parent', 'pull', 'x-pull']
1419
for l in _locs:
1420
try:
1421
return self.control_files.get(l).read().strip('\n')
1422
except NoSuchFile:
1423
pass
1424
return None
1425
1426
@needs_read_lock
1427
def push(self, target, overwrite=False, stop_revision=None,
1428
_hook_master=None, _run_hooks=True):
1429
"""See Branch.push.
1430
1431
:param _hook_master: Private parameter - set the branch to
1432
be supplied as the master to push hooks.
1433
:param _run_hooks: Private parameter - allow disabling of
1434
hooks, used when pushing to a master branch.
1435
"""
1436
target.lock_write()
1437
try:
1438
old_count, old_tip = target.last_revision_info()
1439
try:
1440
target.update_revisions(self, stop_revision)
1441
except DivergedBranches:
1442
if not overwrite:
1443
raise
1444
if overwrite:
1445
target.set_revision_history(self.revision_history())
1446
new_count, new_tip = target.last_revision_info()
1447
if _run_hooks:
1448
if _hook_master:
1449
_hook_local = target
1450
else:
1451
_hook_master = target
1452
_hook_local = None
1453
for hook in Branch.hooks['post_push']:
1454
hook(self, _hook_local, _hook_master, old_count, old_tip,
1455
new_count, new_tip)
1456
return new_count - old_count
1457
finally:
1458
target.unlock()
1459
1460
def get_parent(self):
1461
"""See Branch.get_parent."""
1462
1463
assert self.base[-1] == '/'
1464
parent = self._get_parent_location()
1465
if parent is None:
1466
return parent
1467
# This is an old-format absolute path to a local branch
1468
# turn it into a url
1469
if parent.startswith('/'):
1470
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1471
try:
1472
return urlutils.join(self.base[:-1], parent)
1473
except errors.InvalidURLJoin, e:
1474
raise errors.InaccessibleParent(parent, self.base)
1475
1476
def get_push_location(self):
1477
"""See Branch.get_push_location."""
1478
push_loc = self.get_config().get_user_option('push_location')
1479
return push_loc
1480
1481
def set_push_location(self, location):
1482
"""See Branch.set_push_location."""
1483
self.get_config().set_user_option(
1484
'push_location', location,
1485
store=_mod_config.STORE_LOCATION_NORECURSE)
1486
1487
@needs_write_lock
1488
def set_parent(self, url):
1489
"""See Branch.set_parent."""
1490
# TODO: Maybe delete old location files?
1491
# URLs should never be unicode, even on the local fs,
1492
# FIXUP this and get_parent in a future branch format bump:
1493
# read and rewrite the file, and have the new format code read
1494
# using .get not .get_utf8. RBC 20060125
1495
if url is not None:
1496
if isinstance(url, unicode):
1497
try:
1498
url = url.encode('ascii')
1499
except UnicodeEncodeError:
1500
raise bzrlib.errors.InvalidURL(url,
1501
"Urls must be 7-bit ascii, "
1502
"use bzrlib.urlutils.escape")
1503
1504
url = urlutils.relative_url(self.base, url)
1505
self._set_parent_location(url)
1506
1507
def _set_parent_location(self, url):
1508
if url is None:
1509
self.control_files._transport.delete('parent')
1510
else:
1511
assert isinstance(url, str)
1512
self.control_files.put('parent', StringIO(url + '\n'))
1513
1514
@deprecated_function(zero_nine)
1515
def tree_config(self):
1516
"""DEPRECATED; call get_config instead.
1517
TreeConfig has become part of BranchConfig."""
1518
return TreeConfig(self)
1519
1520
1521
class BzrBranch5(BzrBranch):
1522
"""A format 5 branch. This supports new features over plan branches.
1523
1524
It has support for a master_branch which is the data for bound branches.
1525
"""
1526
1527
def __init__(self,
1528
_format,
1529
_control_files,
1530
a_bzrdir,
1531
_repository):
1532
super(BzrBranch5, self).__init__(_format=_format,
1533
_control_files=_control_files,
1534
a_bzrdir=a_bzrdir,
1535
_repository=_repository)
1536
1537
@needs_write_lock
1538
def pull(self, source, overwrite=False, stop_revision=None,
1539
_run_hooks=True):
1540
"""Extends branch.pull to be bound branch aware.
1541
1542
:param _run_hooks: Private parameter used to force hook running
1543
off during bound branch double-pushing.
1544
"""
1545
bound_location = self.get_bound_location()
1546
master_branch = None
1547
if bound_location and source.base != bound_location:
1548
# not pulling from master, so we need to update master.
1549
master_branch = self.get_master_branch()
1550
master_branch.lock_write()
1551
try:
1552
if master_branch:
1553
# pull from source into master.
1554
master_branch.pull(source, overwrite, stop_revision,
1555
_run_hooks=False)
1556
return super(BzrBranch5, self).pull(source, overwrite,
1557
stop_revision, _hook_master=master_branch,
1558
_run_hooks=_run_hooks)
1559
finally:
1560
if master_branch:
1561
master_branch.unlock()
1562
1563
@needs_read_lock
1564
def push(self, target, overwrite=False, stop_revision=None):
1565
"""Updates branch.push to be bound branch aware."""
1566
bound_location = target.get_bound_location()
1567
master_branch = None
1568
if bound_location and target.base != bound_location:
1569
# not pushing to master, so we need to update master.
1570
master_branch = target.get_master_branch()
1571
master_branch.lock_write()
1572
try:
1573
if master_branch:
1574
# push into the master from this branch.
1575
super(BzrBranch5, self).push(master_branch, overwrite,
1576
stop_revision, _run_hooks=False)
1577
# and push into the target branch from this. Note that we push from
1578
# this branch again, because its considered the highest bandwidth
1579
# repository.
1580
return super(BzrBranch5, self).push(target, overwrite,
1581
stop_revision, _hook_master=master_branch)
1582
finally:
1583
if master_branch:
1584
master_branch.unlock()
1585
1586
def get_bound_location(self):
1587
try:
1588
return self.control_files.get_utf8('bound').read()[:-1]
1589
except errors.NoSuchFile:
1590
return None
1591
1592
@needs_read_lock
1593
def get_master_branch(self):
1594
"""Return the branch we are bound to.
1595
1596
:return: Either a Branch, or None
1597
1598
This could memoise the branch, but if thats done
1599
it must be revalidated on each new lock.
1600
So for now we just don't memoise it.
1601
# RBC 20060304 review this decision.
1602
"""
1603
bound_loc = self.get_bound_location()
1604
if not bound_loc:
1605
return None
1606
try:
1607
return Branch.open(bound_loc)
1608
except (errors.NotBranchError, errors.ConnectionError), e:
1609
raise errors.BoundBranchConnectionFailure(
1610
self, bound_loc, e)
1611
1612
@needs_write_lock
1613
def set_bound_location(self, location):
1614
"""Set the target where this branch is bound to.
1615
1616
:param location: URL to the target branch
1617
"""
1618
if location:
1619
self.control_files.put_utf8('bound', location+'\n')
1620
else:
1621
try:
1622
self.control_files._transport.delete('bound')
1623
except NoSuchFile:
1624
return False
1625
return True
1626
1627
@needs_write_lock
1628
def bind(self, other):
1629
"""Bind this branch to the branch other.
1630
1631
This does not push or pull data between the branches, though it does
1632
check for divergence to raise an error when the branches are not
1633
either the same, or one a prefix of the other. That behaviour may not
1634
be useful, so that check may be removed in future.
1635
1636
:param other: The branch to bind to
1637
:type other: Branch
1638
"""
1639
# TODO: jam 20051230 Consider checking if the target is bound
1640
# It is debatable whether you should be able to bind to
1641
# a branch which is itself bound.
1642
# Committing is obviously forbidden,
1643
# but binding itself may not be.
1644
# Since we *have* to check at commit time, we don't
1645
# *need* to check here
1646
1647
# we want to raise diverged if:
1648
# last_rev is not in the other_last_rev history, AND
1649
# other_last_rev is not in our history, and do it without pulling
1650
# history around
1651
last_rev = self.last_revision()
1652
if last_rev is not None:
1653
other.lock_read()
1654
try:
1655
other_last_rev = other.last_revision()
1656
if other_last_rev is not None:
1657
# neither branch is new, we have to do some work to
1658
# ascertain diversion.
1659
remote_graph = other.repository.get_revision_graph(
1660
other_last_rev)
1661
local_graph = self.repository.get_revision_graph(last_rev)
1662
if (last_rev not in remote_graph and
1663
other_last_rev not in local_graph):
1664
raise errors.DivergedBranches(self, other)
1665
finally:
1666
other.unlock()
1667
self.set_bound_location(other.base)
1668
1669
@needs_write_lock
1670
def unbind(self):
1671
"""If bound, unbind"""
1672
return self.set_bound_location(None)
1673
1674
@needs_write_lock
1675
def update(self):
1676
"""Synchronise this branch with the master branch if any.
1677
1678
:return: None or the last_revision that was pivoted out during the
1679
update.
1680
"""
1681
master = self.get_master_branch()
1682
if master is not None:
1683
old_tip = self.last_revision()
1684
self.pull(master, overwrite=True)
1685
if old_tip in self.repository.get_ancestry(self.last_revision()):
1686
return None
1687
return old_tip
1688
return None
1689
1690
1691
class BzrBranch6(BzrBranch5):
1692
1693
@needs_read_lock
1694
def last_revision_info(self):
1695
revision_string = self.control_files.get_utf8('last-revision').read()
1696
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1697
revno = int(revno)
1698
return revno, revision_id
1699
1700
def last_revision(self):
1701
"""Return last revision id, or None"""
1702
revision_id = self.last_revision_info()[1]
1703
if revision_id == _mod_revision.NULL_REVISION:
1704
revision_id = None
1705
return revision_id
1706
1707
def _write_last_revision_info(self, revno, revision_id):
1708
"""Simply write out the revision id, with no checks.
1709
1710
Use set_last_revision_info to perform this safely.
1711
1712
Does not update the revision_history cache.
1713
Intended to be called by set_last_revision_info and
1714
_write_revision_history.
1715
"""
1716
if revision_id is None:
1717
revision_id = 'null:'
1718
out_string = '%d %s\n' % (revno, revision_id)
1719
self.control_files.put_utf8('last-revision', out_string)
1720
1721
@needs_write_lock
1722
def set_last_revision_info(self, revno, revision_id):
1723
if self._get_append_revisions_only():
1724
self._check_history_violation(revision_id)
1725
self._write_last_revision_info(revno, revision_id)
1726
transaction = self.get_transaction()
1727
cached_history = transaction.map.find_revision_history()
1728
if cached_history is not None:
1729
transaction.map.remove_object(cached_history)
1730
1731
def _check_history_violation(self, revision_id):
1732
last_revision = self.last_revision()
1733
if last_revision is None:
1734
return
1735
if last_revision not in self._lefthand_history(revision_id):
1736
raise errors.AppendRevisionsOnlyViolation(self.base)
1737
1738
def _gen_revision_history(self):
1739
"""Generate the revision history from last revision
1740
"""
1741
history = list(self.repository.iter_reverse_revision_history(
1742
self.last_revision()))
1743
history.reverse()
1744
return history
1745
1746
def _write_revision_history(self, history):
1747
"""Factored out of set_revision_history.
1748
1749
This performs the actual writing to disk, with format-specific checks.
1750
It is intended to be called by BzrBranch5.set_revision_history.
1751
"""
1752
if len(history) == 0:
1753
last_revision = 'null:'
1754
else:
1755
if history != self._lefthand_history(history[-1]):
1756
raise errors.NotLefthandHistory(history)
1757
last_revision = history[-1]
1758
if self._get_append_revisions_only():
1759
self._check_history_violation(last_revision)
1760
self._write_last_revision_info(len(history), last_revision)
1761
1762
@needs_write_lock
1763
def append_revision(self, *revision_ids):
1764
if len(revision_ids) == 0:
1765
return
1766
prev_revno, prev_revision = self.last_revision_info()
1767
for revision in self.repository.get_revisions(revision_ids):
1768
if prev_revision == _mod_revision.NULL_REVISION:
1769
if revision.parent_ids != []:
1770
raise errors.NotLeftParentDescendant(self, prev_revision,
1771
revision.revision_id)
1772
else:
1773
if revision.parent_ids[0] != prev_revision:
1774
raise errors.NotLeftParentDescendant(self, prev_revision,
1775
revision.revision_id)
1776
prev_revision = revision.revision_id
1777
self.set_last_revision_info(prev_revno + len(revision_ids),
1778
revision_ids[-1])
1779
1780
def _set_config_location(self, name, url, config=None,
1781
make_relative=False):
1782
if config is None:
1783
config = self.get_config()
1784
if url is None:
1785
url = ''
1786
elif make_relative:
1787
url = urlutils.relative_url(self.base, url)
1788
config.set_user_option(name, url)
1789
1790
1791
def _get_config_location(self, name, config=None):
1792
if config is None:
1793
config = self.get_config()
1794
location = config.get_user_option(name)
1795
if location == '':
1796
location = None
1797
return location
1798
1799
@needs_write_lock
1800
def _set_parent_location(self, url):
1801
"""Set the parent branch"""
1802
self._set_config_location('parent_location', url, make_relative=True)
1803
1804
@needs_read_lock
1805
def _get_parent_location(self):
1806
"""Set the parent branch"""
1807
return self._get_config_location('parent_location')
1808
1809
def set_push_location(self, location):
1810
"""See Branch.set_push_location."""
1811
self._set_config_location('push_location', location)
1812
1813
def set_bound_location(self, location):
1814
"""See Branch.set_push_location."""
1815
result = None
1816
config = self.get_config()
1817
if location is None:
1818
if config.get_user_option('bound') != 'True':
1819
return False
1820
else:
1821
config.set_user_option('bound', 'False')
1822
return True
1823
else:
1824
self._set_config_location('bound_location', location,
1825
config=config)
1826
config.set_user_option('bound', 'True')
1827
return True
1828
1829
def _get_bound_location(self, bound):
1830
"""Return the bound location in the config file.
1831
1832
Return None if the bound parameter does not match"""
1833
config = self.get_config()
1834
config_bound = (config.get_user_option('bound') == 'True')
1835
if config_bound != bound:
1836
return None
1837
return self._get_config_location('bound_location', config=config)
1838
1839
def get_bound_location(self):
1840
"""See Branch.set_push_location."""
1841
return self._get_bound_location(True)
1842
1843
def get_old_bound_location(self):
1844
"""See Branch.get_old_bound_location"""
1845
return self._get_bound_location(False)
1846
1847
def set_append_revisions_only(self, enabled):
1848
if enabled:
1849
value = 'True'
1850
else:
1851
value = 'False'
1852
self.get_config().set_user_option('append_revisions_only', value)
1853
1854
def _get_append_revisions_only(self):
1855
value = self.get_config().get_user_option('append_revisions_only')
1856
return value == 'True'
1857
1858
def _synchronize_history(self, destination, revision_id):
1859
"""Synchronize last revision and revision history between branches.
1860
1861
This version is most efficient when the destination is also a
1862
BzrBranch6, but works for BzrBranch5, as long as the destination's
1863
repository contains all the lefthand ancestors of the intended
1864
last_revision. If not, set_last_revision_info will fail.
1865
1866
:param destination: The branch to copy the history into
1867
:param revision_id: The revision-id to truncate history at. May
1868
be None to copy complete history.
1869
"""
1870
if revision_id is None:
1871
revno, revision_id = self.last_revision_info()
1872
else:
1873
revno = self.revision_id_to_revno(revision_id)
1874
destination.set_last_revision_info(revno, revision_id)
1875
1876
1877
class BranchTestProviderAdapter(object):
1878
"""A tool to generate a suite testing multiple branch formats at once.
1879
1880
This is done by copying the test once for each transport and injecting
1881
the transport_server, transport_readonly_server, and branch_format
1882
classes into each copy. Each copy is also given a new id() to make it
1883
easy to identify.
1884
"""
1885
1886
def __init__(self, transport_server, transport_readonly_server, formats):
1887
self._transport_server = transport_server
1888
self._transport_readonly_server = transport_readonly_server
1889
self._formats = formats
1890
1891
def adapt(self, test):
1892
result = TestSuite()
1893
for branch_format, bzrdir_format in self._formats:
1894
new_test = deepcopy(test)
1895
new_test.transport_server = self._transport_server
1896
new_test.transport_readonly_server = self._transport_readonly_server
1897
new_test.bzrdir_format = bzrdir_format
1898
new_test.branch_format = branch_format
1899
def make_new_test_id():
1900
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1901
return lambda: new_id
1902
new_test.id = make_new_test_id()
1903
result.addTest(new_test)
1904
return result
1905
1906
1907
class BranchCheckResult(object):
1908
"""Results of checking branch consistency.
1909
1910
:see: Branch.check
1911
"""
1912
1913
def __init__(self, branch):
1914
self.branch = branch
1915
1916
def report_results(self, verbose):
1917
"""Report the check results via trace.note.
1918
1919
:param verbose: Requests more detailed display of what was checked,
1920
if any.
1921
"""
1922
note('checked branch %s format %s',
1923
self.branch.base,
1924
self.branch._format)
1925
1336
1926
1337
1927
######################################################################
1338
1928
# predicates
1339
1929
1340
1930
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
1931
@deprecated_function(zero_eight)
1932
def is_control_file(*args, **kwargs):
1933
"""See bzrlib.workingtree.is_control_file."""
1934
from bzrlib import workingtree
1935
return workingtree.is_control_file(*args, **kwargs)
1936
1937
1938
class Converter5to6(object):
1939
"""Perform an in-place upgrade of format 5 to format 6"""
1940
1941
def convert(self, branch):
1942
# Data for 5 and 6 can peacefully coexist.
1943
format = BzrBranchFormat6()
1944
new_branch = format.open(branch.bzrdir, _found=True)
1945
1946
# Copy source data into target
1947
new_branch.set_last_revision_info(*branch.last_revision_info())
1948
new_branch.set_parent(branch.get_parent())
1949
new_branch.set_bound_location(branch.get_bound_location())
1950
new_branch.set_push_location(branch.get_push_location())
1951
1952
# Copying done; now update target format
1953
new_branch.control_files.put_utf8('format',
1954
format.get_format_string())
1955
1956
# Clean up old files
1957
new_branch.control_files._transport.delete('revision-history')
1958
try:
1959
branch.set_parent(None)
1960
except NoSuchFile:
1961
pass
1962
branch.set_bound_location(None)
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0