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 2318.2.3
- compare with another revision
- download diff
- download tarball
- view history from revision 2318.2.3
- Committer: Kent Gibson
- Date: 2007-03-07 14:49:00 UTC
- mfrom: (2324 +trunk)
- mto: This revision was merged to the branch mainline in revision 2350.
- Revision ID: warthog618@gmail.com-20070307144900-6bt7twg47zul3w0w
merged bzr.dev
- 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
from bzrlib.tag import (
44
BasicTags,
45
DisabledTags,
46
)
47
""")
48
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
56
)
57
from bzrlib.symbol_versioning import (deprecated_function,
58
deprecated_method,
59
DEPRECATED_PARAMETER,
60
deprecated_passed,
61
zero_eight, zero_nine,
62
)
22
63
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
64
65
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
69
70
71
# TODO: Maybe include checks for common corruption of newlines, etc?
37
72
38
73
# TODO: Some operations like log might retrieve the same revisions
39
74
# 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.")
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
131
78
132
79
133
80
######################################################################
137
84
"""Branch holding a history of revisions.
138
85
139
86
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.
87
Base directory/url of the branch.
88
89
hooks: An instance of BranchHooks.
151
90
"""
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
152
93
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
94
95
# override this to set the strategy for storing tags
96
def _make_tags(self):
97
return DisabledTags(self)
98
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
104
105
Uses the ui factory to ask for confirmation if the lock may be from
106
an active process.
107
108
This will probe the repository for its lock as well.
109
"""
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
114
master.break_lock()
115
116
@staticmethod
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
121
122
@staticmethod
123
def open(base, _unsupported=False):
124
"""Open the branch rooted at base.
125
126
For instance, if the branch is at URL/.bzr/branch,
127
Branch.open(URL) -> a Branch instance.
128
"""
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
131
132
@staticmethod
133
def open_containing(url):
134
"""Open an existing branch which contains url.
135
136
This probes for a branch at url, and searches upwards from there.
137
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
143
"""
144
control, relpath = bzrdir.BzrDir.open_containing(url)
145
return control.open_branch(), relpath
146
147
@staticmethod
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
151
152
NOTE: This will soon be deprecated in favour of creation
153
through a BzrDir.
154
"""
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
156
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
161
162
NOTE: This is unused.
163
"""
164
pass
165
166
def get_config(self):
167
return BranchConfig(self)
168
169
def _get_nick(self):
170
return self.get_config().get_nickname()
171
172
def _set_nick(self, nick):
173
self.get_config().set_user_option('nickname', nick)
174
175
nick = property(_get_nick, _set_nick)
176
177
def is_locked(self):
178
raise NotImplementedError(self.is_locked)
211
179
212
180
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
181
raise NotImplementedError(self.lock_write)
227
182
228
183
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
184
raise NotImplementedError(self.lock_read)
185
242
186
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
187
raise NotImplementedError(self.unlock)
188
189
def peek_lock_mode(self):
190
"""Return lock mode for the Branch: 'r', 'w' or None"""
191
raise NotImplementedError(self.peek_lock_mode)
192
193
def get_physical_lock_status(self):
194
raise NotImplementedError(self.get_physical_lock_status)
254
195
255
196
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
197
"""Return absolute filename for something in the branch
198
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
201
"""
202
raise NotImplementedError(self.abspath)
203
204
def bind(self, other):
205
"""Bind the local branch the other branch.
206
207
:param other: The branch to bind to
208
:type other: Branch
209
"""
210
raise errors.UpgradeRequired(self.base)
211
212
@needs_write_lock
213
def fetch(self, from_branch, last_revision=None, pb=None):
214
"""Copy revisions from from_branch into this branch.
215
216
:param from_branch: Where to copy from.
217
:param last_revision: What revision to stop at (None for at the end
218
of the branch.
219
:param pb: An optional progress bar to use.
220
221
Returns the copied revision count and the failed revisions in a tuple:
222
(copied, failures).
223
"""
224
if self.base == from_branch.base:
225
return (0, [])
226
if pb is None:
227
nested_pb = ui.ui_factory.nested_progress_bar()
228
pb = nested_pb
229
else:
230
nested_pb = None
231
232
from_branch.lock_read()
233
try:
234
if last_revision is None:
235
pb.update('get source history')
236
last_revision = from_branch.last_revision()
237
if last_revision is None:
238
last_revision = _mod_revision.NULL_REVISION
239
return self.repository.fetch(from_branch.repository,
240
revision_id=last_revision,
241
pb=nested_pb)
242
finally:
243
if nested_pb is not None:
244
nested_pb.finished()
245
from_branch.unlock()
246
247
def get_bound_location(self):
248
"""Return the URL of the branch we are bound to.
249
250
Older format branches cannot bind, please be sure to use a metadir
251
branch.
252
"""
253
return None
254
255
def get_old_bound_location(self):
256
"""Return the URL of the branch we used to be bound to
257
"""
258
raise errors.UpgradeRequired(self.base)
259
260
def get_commit_builder(self, parents, config=None, timestamp=None,
261
timezone=None, committer=None, revprops=None,
262
revision_id=None):
263
"""Obtain a CommitBuilder for this branch.
264
265
:param parents: Revision ids of the parents of the new revision.
266
:param config: Optional configuration to use.
267
:param timestamp: Optional timestamp recorded for commit.
268
:param timezone: Optional timezone for timestamp.
269
:param committer: Optional committer to set for commit.
270
:param revprops: Optional dictionary of revision properties.
271
:param revision_id: Optional revision id.
272
"""
273
274
if config is None:
275
config = self.get_config()
276
277
return self.repository.get_commit_builder(self, parents, config,
278
timestamp, timezone, committer, revprops, revision_id)
279
280
def get_master_branch(self):
281
"""Return the branch we are bound to.
282
283
:return: Either a Branch, or None
284
"""
285
return None
616
286
617
287
def get_revision_delta(self, revno):
618
288
"""Return the delta for one revision.
624
294
rh = self.revision_history()
625
295
if not (1 <= revno <= len(rh)):
626
296
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
297
return self.repository.get_revision_delta(rh[revno-1])
298
299
def get_root_id(self):
300
"""Return the id of this branches root"""
301
raise NotImplementedError(self.get_root_id)
302
303
def print_file(self, file, revision_id):
304
"""Print `file` to stdout."""
305
raise NotImplementedError(self.print_file)
306
307
def append_revision(self, *revision_ids):
308
raise NotImplementedError(self.append_revision)
309
310
def set_revision_history(self, rev_history):
311
raise NotImplementedError(self.set_revision_history)
679
312
680
313
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
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError(self.revision_history)
738
316
739
317
def revno(self):
740
318
"""Return current revision number for this branch.
744
322
"""
745
323
return len(self.revision_history())
746
324
747
748
def last_patch(self):
749
"""Return last patch hash, or None if no history.
750
"""
325
def unbind(self):
326
"""Older format branches cannot bind or unbind."""
327
raise errors.UpgradeRequired(self.base)
328
329
def set_append_revisions_only(self, enabled):
330
"""Older format branches are never restricted to append-only"""
331
raise errors.UpgradeRequired(self.base)
332
333
def last_revision(self):
334
"""Return last revision id, or None"""
751
335
ph = self.revision_history()
752
336
if ph:
753
337
return ph[-1]
754
338
else:
755
339
return None
756
340
341
def last_revision_info(self):
342
"""Return information about the last revision.
343
344
:return: A tuple (revno, last_revision_id).
345
"""
346
rh = self.revision_history()
347
revno = len(rh)
348
if revno:
349
return (revno, rh[-1])
350
else:
351
return (0, _mod_revision.NULL_REVISION)
757
352
758
353
def missing_revisions(self, other, stop_revision=None):
759
"""
354
"""Return a list of new revisions that would perfectly fit.
355
760
356
If self and other have not diverged, return a list of the revisions
761
357
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
358
"""
785
359
self_history = self.revision_history()
786
360
self_len = len(self_history)
793
367
794
368
if stop_revision is None:
795
369
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
798
370
else:
371
assert isinstance(stop_revision, int)
372
if stop_revision > other_len:
373
raise errors.NoSuchRevision(self, stop_revision)
799
374
return other_history[self_len:stop_revision]
800
375
801
802
376
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
377
"""Pull in new perfect-fit revisions.
378
379
:param other: Another Branch to pull from
380
:param stop_revision: Updated until the given revision
381
:return: None
382
"""
383
raise NotImplementedError(self.update_revisions)
384
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
388
return 0
389
revision_id = osutils.safe_revision_id(revision_id)
390
history = self.revision_history()
391
try:
392
return history.index(revision_id) + 1
393
except ValueError:
394
raise bzrlib.errors.NoSuchRevision(self, revision_id)
395
396
def get_rev_id(self, revno, history=None):
397
"""Find the revision id of the specified revno."""
398
if revno == 0:
399
return None
400
if history is None:
401
history = self.revision_history()
402
if revno <= 0 or revno > len(history):
403
raise bzrlib.errors.NoSuchRevision(self, revno)
404
return history[revno - 1]
405
406
def pull(self, source, overwrite=False, stop_revision=None):
407
"""Mirror source into this branch.
408
409
This branch is considered to be 'local', having low latency.
410
411
:returns: PullResult instance
412
"""
413
raise NotImplementedError(self.pull)
414
415
def push(self, target, overwrite=False, stop_revision=None):
416
"""Mirror this branch into target.
417
418
This branch is considered to be 'local', having low latency.
419
"""
420
raise NotImplementedError(self.push)
1052
421
1053
422
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
423
"""Return `Tree` object for last revision."""
424
return self.repository.revision_tree(self.last_revision())
1065
425
1066
426
def rename_one(self, from_rel, to_rel):
1067
427
"""Rename one file.
1068
428
1069
429
This can change the directory or the filename or both.
1070
430
"""
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
431
raise NotImplementedError(self.rename_one)
1116
432
1117
433
def move(self, from_paths, to_name):
1118
434
"""Rename files.
1124
440
1125
441
Note that to_name is only the last component of the new name;
1126
442
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
1336
1337
######################################################################
1338
# predicates
1339
1340
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:
443
444
This returns a list of (from_path, to_path) pairs for each
445
entry that is moved.
446
"""
447
raise NotImplementedError(self.move)
448
449
def get_parent(self):
450
"""Return the parent location of the branch.
451
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
454
location.
455
"""
456
raise NotImplementedError(self.get_parent)
457
458
def get_submit_branch(self):
459
"""Return the submit location of the branch.
460
461
This is the default location for bundle. The usual
462
pattern is that the user can override it by specifying a
463
location.
464
"""
465
return self.get_config().get_user_option('submit_branch')
466
467
def set_submit_branch(self, location):
468
"""Return the submit location of the branch.
469
470
This is the default location for bundle. The usual
471
pattern is that the user can override it by specifying a
472
location.
473
"""
474
self.get_config().set_user_option('submit_branch', location)
475
476
def get_push_location(self):
477
"""Return the None or the location to push this branch to."""
478
raise NotImplementedError(self.get_push_location)
479
480
def set_push_location(self, location):
481
"""Set a new push location for this branch."""
482
raise NotImplementedError(self.set_push_location)
483
484
def set_parent(self, url):
485
raise NotImplementedError(self.set_parent)
486
487
@needs_write_lock
488
def update(self):
489
"""Synchronise this branch with the master branch if any.
490
491
:return: None or the last_revision pivoted out during the update.
492
"""
493
return None
494
495
def check_revno(self, revno):
496
"""\
497
Check whether a revno corresponds to any revision.
498
Zero (the NULL revision) is considered valid.
499
"""
500
if revno != 0:
501
self.check_real_revno(revno)
502
503
def check_real_revno(self, revno):
504
"""\
505
Check whether a revno corresponds to a real revision.
506
Zero (the NULL revision) is considered invalid
507
"""
508
if revno < 1 or revno > self.revno():
509
raise InvalidRevisionNumber(revno)
510
511
@needs_read_lock
512
def clone(self, *args, **kwargs):
513
"""Clone this branch into to_bzrdir preserving all semantic values.
514
515
revision_id: if not None, the revision history in the new branch will
516
be truncated to end with revision_id.
517
"""
518
# for API compatibility, until 0.8 releases we provide the old api:
519
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
520
# after 0.8 releases, the *args and **kwargs should be changed:
521
# def clone(self, to_bzrdir, revision_id=None):
522
if (kwargs.get('to_location', None) or
523
kwargs.get('revision', None) or
524
kwargs.get('basis_branch', None) or
525
(len(args) and isinstance(args[0], basestring))):
526
# backwards compatibility api:
527
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
528
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
529
# get basis_branch
530
if len(args) > 2:
531
basis_branch = args[2]
532
else:
533
basis_branch = kwargs.get('basis_branch', None)
534
if basis_branch:
535
basis = basis_branch.bzrdir
536
else:
537
basis = None
538
# get revision
539
if len(args) > 1:
540
revision_id = args[1]
541
else:
542
revision_id = kwargs.get('revision', None)
543
# get location
544
if len(args):
545
url = args[0]
546
else:
547
# no default to raise if not provided.
548
url = kwargs.get('to_location')
549
return self.bzrdir.clone(url,
550
revision_id=revision_id,
551
basis=basis).open_branch()
552
# new cleaner api.
553
# generate args by hand
554
if len(args) > 1:
555
revision_id = args[1]
556
else:
557
revision_id = kwargs.get('revision_id', None)
558
if len(args):
559
to_bzrdir = args[0]
560
else:
561
# no default to raise if not provided.
562
to_bzrdir = kwargs.get('to_bzrdir')
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
565
return result
566
567
@needs_read_lock
568
def sprout(self, to_bzrdir, revision_id=None):
569
"""Create a new line of development from the branch, into to_bzrdir.
570
571
revision_id: if not None, the revision history in the new branch will
572
be truncated to end with revision_id.
573
"""
574
result = self._format.initialize(to_bzrdir)
575
self.copy_content_into(result, revision_id=revision_id)
576
result.set_parent(self.bzrdir.root_transport.base)
577
return result
578
579
def _synchronize_history(self, destination, revision_id):
580
"""Synchronize last revision and revision history between branches.
581
582
This version is most efficient when the destination is also a
583
BzrBranch5, but works for BzrBranch6 as long as the revision
584
history is the true lefthand parent history, and all of the revisions
585
are in the destination's repository. If not, set_revision_history
586
will fail.
587
588
:param destination: The branch to copy the history into
589
:param revision_id: The revision-id to truncate history at. May
590
be None to copy complete history.
591
"""
592
new_history = self.revision_history()
593
if revision_id is not None:
594
revision_id = osutils.safe_revision_id(revision_id)
595
try:
596
new_history = new_history[:new_history.index(revision_id) + 1]
597
except ValueError:
598
rev = self.repository.get_revision(revision_id)
599
new_history = rev.get_history(self.repository)[1:]
600
destination.set_revision_history(new_history)
601
602
@needs_read_lock
603
def copy_content_into(self, destination, revision_id=None):
604
"""Copy the content of self into destination.
605
606
revision_id: if not None, the revision history in the new branch will
607
be truncated to end with revision_id.
608
"""
609
self._synchronize_history(destination, revision_id)
610
try:
611
parent = self.get_parent()
612
except errors.InaccessibleParent, e:
613
mutter('parent was not accessible to copy: %s', e)
614
else:
615
if parent:
616
destination.set_parent(parent)
617
618
@needs_read_lock
619
def check(self):
620
"""Check consistency of the branch.
621
622
In particular this checks that revisions given in the revision-history
623
do actually match up in the revision graph, and that they're all
624
present in the repository.
625
626
Callers will typically also want to check the repository.
627
628
:return: A BranchCheckResult.
629
"""
630
mainline_parent_id = None
631
for revision_id in self.revision_history():
632
try:
633
revision = self.repository.get_revision(revision_id)
634
except errors.NoSuchRevision, e:
635
raise errors.BzrCheckError("mainline revision {%s} not in repository"
636
% revision_id)
637
# In general the first entry on the revision history has no parents.
638
# But it's not illegal for it to have parents listed; this can happen
639
# in imports from Arch when the parents weren't reachable.
640
if mainline_parent_id is not None:
641
if mainline_parent_id not in revision.parent_ids:
642
raise errors.BzrCheckError("previous revision {%s} not listed among "
643
"parents of {%s}"
644
% (mainline_parent_id, revision_id))
645
mainline_parent_id = revision_id
646
return BranchCheckResult(self)
647
648
def _get_checkout_format(self):
649
"""Return the most suitable metadir for a checkout of this branch.
650
Weaves are used if this branch's repostory uses weaves.
651
"""
652
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
653
from bzrlib.repofmt import weaverepo
654
format = bzrdir.BzrDirMetaFormat1()
655
format.repository_format = weaverepo.RepositoryFormat7()
656
else:
657
format = self.repository.bzrdir.checkout_metadir()
658
format.branch_format = self._format
659
return format
660
661
def create_checkout(self, to_location, revision_id=None,
662
lightweight=False):
663
"""Create a checkout of a branch.
664
665
:param to_location: The url to produce the checkout at
666
:param revision_id: The revision to check out
667
:param lightweight: If True, produce a lightweight checkout, otherwise,
668
produce a bound branch (heavyweight checkout)
669
:return: The tree of the created checkout
670
"""
671
t = transport.get_transport(to_location)
672
try:
673
t.mkdir('.')
674
except errors.FileExists:
675
pass
676
if lightweight:
677
format = self._get_checkout_format()
678
checkout = format.initialize_on_transport(t)
679
BranchReferenceFormat().initialize(checkout, self)
680
else:
681
format = self._get_checkout_format()
682
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
683
to_location, force_new_tree=False, format=format)
684
checkout = checkout_branch.bzrdir
685
checkout_branch.bind(self)
686
# pull up to the specified revision_id to set the initial
687
# branch tip correctly, and seed it with history.
688
checkout_branch.pull(self, stop_revision=revision_id)
689
tree = checkout.create_workingtree(revision_id)
690
basis_tree = tree.basis_tree()
691
basis_tree.lock_read()
692
try:
693
for path, file_id in basis_tree.iter_references():
694
reference_parent = self.reference_parent(file_id, path)
695
reference_parent.create_checkout(tree.abspath(path),
696
basis_tree.get_reference_revision(file_id, path),
697
lightweight)
698
finally:
699
basis_tree.unlock()
700
return tree
701
702
def reference_parent(self, file_id, path):
703
"""Return the parent branch for a tree-reference file_id
704
:param file_id: The file_id of the tree reference
705
:param path: The path of the file_id in the tree
706
:return: A branch associated with the file_id
707
"""
708
# FIXME should provide multiple branches, based on config
709
return Branch.open(self.bzrdir.root_transport.clone(path).base)
710
711
def supports_tags(self):
712
return self._format.supports_tags()
713
714
715
class BranchFormat(object):
716
"""An encapsulation of the initialization and open routines for a format.
717
718
Formats provide three things:
719
* An initialization routine,
720
* a format string,
721
* an open routine.
722
723
Formats are placed in an dict by their format string for reference
724
during branch opening. Its not required that these be instances, they
725
can be classes themselves with class methods - it simply depends on
726
whether state is needed for a given format or not.
727
728
Once a format is deprecated, just deprecate the initialize and open
729
methods on the format class. Do not deprecate the object, as the
730
object will be created every time regardless.
731
"""
732
733
_default_format = None
734
"""The default format used for new branches."""
735
736
_formats = {}
737
"""The known formats."""
738
739
@classmethod
740
def find_format(klass, a_bzrdir):
741
"""Return the format for the branch object in a_bzrdir."""
742
try:
743
transport = a_bzrdir.get_branch_transport(None)
744
format_string = transport.get("format").read()
745
return klass._formats[format_string]
746
except NoSuchFile:
747
raise NotBranchError(path=transport.base)
748
except KeyError:
749
raise errors.UnknownFormatError(format=format_string)
750
751
@classmethod
752
def get_default_format(klass):
753
"""Return the current default format."""
754
return klass._default_format
755
756
def get_format_string(self):
757
"""Return the ASCII format string that identifies this format."""
758
raise NotImplementedError(self.get_format_string)
759
760
def get_format_description(self):
761
"""Return the short format description for this format."""
762
raise NotImplementedError(self.get_format_description)
763
764
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
765
set_format=True):
766
"""Initialize a branch in a bzrdir, with specified files
767
768
:param a_bzrdir: The bzrdir to initialize the branch in
769
:param utf8_files: The files to create as a list of
770
(filename, content) tuples
771
:param set_format: If True, set the format with
772
self.get_format_string. (BzrBranch4 has its format set
773
elsewhere)
774
:return: a branch in this format
775
"""
776
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
777
branch_transport = a_bzrdir.get_branch_transport(self)
778
lock_map = {
779
'metadir': ('lock', lockdir.LockDir),
780
'branch4': ('branch-lock', lockable_files.TransportLock),
781
}
782
lock_name, lock_class = lock_map[lock_type]
783
control_files = lockable_files.LockableFiles(branch_transport,
784
lock_name, lock_class)
785
control_files.create_lock()
786
control_files.lock_write()
787
if set_format:
788
control_files.put_utf8('format', self.get_format_string())
789
try:
790
for file, content in utf8_files:
791
control_files.put_utf8(file, content)
792
finally:
793
control_files.unlock()
794
return self.open(a_bzrdir, _found=True)
795
796
def initialize(self, a_bzrdir):
797
"""Create a branch of this format in a_bzrdir."""
798
raise NotImplementedError(self.initialize)
799
800
def is_supported(self):
801
"""Is this format supported?
802
803
Supported formats can be initialized and opened.
804
Unsupported formats may not support initialization or committing or
805
some other features depending on the reason for not being supported.
806
"""
807
return True
808
809
def open(self, a_bzrdir, _found=False):
810
"""Return the branch object for a_bzrdir
811
812
_found is a private parameter, do not use it. It is used to indicate
813
if format probing has already be done.
814
"""
815
raise NotImplementedError(self.open)
816
817
@classmethod
818
def register_format(klass, format):
819
klass._formats[format.get_format_string()] = format
820
821
@classmethod
822
def set_default_format(klass, format):
823
klass._default_format = format
824
825
@classmethod
826
def unregister_format(klass, format):
827
assert klass._formats[format.get_format_string()] is format
828
del klass._formats[format.get_format_string()]
829
830
def __str__(self):
831
return self.get_format_string().rstrip()
832
833
def supports_tags(self):
834
"""True if this format supports tags stored in the branch"""
835
return False # by default
836
837
# XXX: Probably doesn't really belong here -- mbp 20070212
838
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
839
lock_class):
840
branch_transport = a_bzrdir.get_branch_transport(self)
841
control_files = lockable_files.LockableFiles(branch_transport,
842
lock_filename, lock_class)
843
control_files.create_lock()
844
control_files.lock_write()
845
try:
846
for filename, content in utf8_files:
847
control_files.put_utf8(filename, content)
848
finally:
849
control_files.unlock()
850
851
852
class BranchHooks(dict):
853
"""A dictionary mapping hook name to a list of callables for branch hooks.
854
855
e.g. ['set_rh'] Is the list of items to be called when the
856
set_revision_history function is invoked.
857
"""
858
859
def __init__(self):
860
"""Create the default hooks.
861
862
These are all empty initially, because by default nothing should get
863
notified.
864
"""
865
dict.__init__(self)
866
# Introduced in 0.15:
867
# invoked whenever the revision history has been set
868
# with set_revision_history. The api signature is
869
# (branch, revision_history), and the branch will
870
# be write-locked.
871
self['set_rh'] = []
872
# invoked after a push operation completes.
873
# the api signature is
874
# (push_result)
875
# containing the members
876
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
877
# where local is the local branch or None, master is the target
878
# master branch, and the rest should be self explanatory. The source
879
# is read locked and the target branches write locked. Source will
880
# be the local low-latency branch.
881
self['post_push'] = []
882
# invoked after a pull operation completes.
883
# the api signature is
884
# (pull_result)
885
# containing the members
886
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
887
# where local is the local branch or None, master is the target
888
# master branch, and the rest should be self explanatory. The source
889
# is read locked and the target branches write locked. The local
890
# branch is the low-latency branch.
891
self['post_pull'] = []
892
# invoked after a commit operation completes.
893
# the api signature is
894
# (local, master, old_revno, old_revid, new_revno, new_revid)
895
# old_revid is NULL_REVISION for the first commit to a branch.
896
self['post_commit'] = []
897
# invoked after a uncommit operation completes.
898
# the api signature is
899
# (local, master, old_revno, old_revid, new_revno, new_revid) where
900
# local is the local branch or None, master is the target branch,
901
# and an empty branch recieves new_revno of 0, new_revid of None.
902
self['post_uncommit'] = []
903
904
def install_hook(self, hook_name, a_callable):
905
"""Install a_callable in to the hook hook_name.
906
907
:param hook_name: A hook name. See the __init__ method of BranchHooks
908
for the complete list of hooks.
909
:param a_callable: The callable to be invoked when the hook triggers.
910
The exact signature will depend on the hook - see the __init__
911
method of BranchHooks for details on each hook.
912
"""
913
try:
914
self[hook_name].append(a_callable)
915
except KeyError:
916
raise errors.UnknownHook('branch', hook_name)
917
918
919
# install the default hooks into the Branch class.
920
Branch.hooks = BranchHooks()
921
922
923
class BzrBranchFormat4(BranchFormat):
924
"""Bzr branch format 4.
925
926
This format has:
927
- a revision-history file.
928
- a branch-lock lock file [ to be shared with the bzrdir ]
929
"""
930
931
def get_format_description(self):
932
"""See BranchFormat.get_format_description()."""
933
return "Branch format 4"
934
935
def initialize(self, a_bzrdir):
936
"""Create a branch of this format in a_bzrdir."""
937
utf8_files = [('revision-history', ''),
938
('branch-name', ''),
939
]
940
return self._initialize_helper(a_bzrdir, utf8_files,
941
lock_type='branch4', set_format=False)
942
943
def __init__(self):
944
super(BzrBranchFormat4, self).__init__()
945
self._matchingbzrdir = bzrdir.BzrDirFormat6()
946
947
def open(self, a_bzrdir, _found=False):
948
"""Return the branch object for a_bzrdir
949
950
_found is a private parameter, do not use it. It is used to indicate
951
if format probing has already be done.
952
"""
953
if not _found:
954
# we are being called directly and must probe.
955
raise NotImplementedError
956
return BzrBranch(_format=self,
957
_control_files=a_bzrdir._control_files,
958
a_bzrdir=a_bzrdir,
959
_repository=a_bzrdir.open_repository())
960
961
def __str__(self):
962
return "Bazaar-NG branch format 4"
963
964
965
class BzrBranchFormat5(BranchFormat):
966
"""Bzr branch format 5.
967
968
This format has:
969
- a revision-history file.
970
- a format string
971
- a lock dir guarding the branch itself
972
- all of this stored in a branch/ subdirectory
973
- works with shared repositories.
974
975
This format is new in bzr 0.8.
976
"""
977
978
def get_format_string(self):
979
"""See BranchFormat.get_format_string()."""
980
return "Bazaar-NG branch format 5\n"
981
982
def get_format_description(self):
983
"""See BranchFormat.get_format_description()."""
984
return "Branch format 5"
985
986
def initialize(self, a_bzrdir):
987
"""Create a branch of this format in a_bzrdir."""
988
utf8_files = [('revision-history', ''),
989
('branch-name', ''),
990
]
991
return self._initialize_helper(a_bzrdir, utf8_files)
992
993
def __init__(self):
994
super(BzrBranchFormat5, self).__init__()
995
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
996
997
def open(self, a_bzrdir, _found=False):
998
"""Return the branch object for a_bzrdir
999
1000
_found is a private parameter, do not use it. It is used to indicate
1001
if format probing has already be done.
1002
"""
1003
if not _found:
1004
format = BranchFormat.find_format(a_bzrdir)
1005
assert format.__class__ == self.__class__
1006
transport = a_bzrdir.get_branch_transport(None)
1007
control_files = lockable_files.LockableFiles(transport, 'lock',
1008
lockdir.LockDir)
1009
return BzrBranch5(_format=self,
1010
_control_files=control_files,
1011
a_bzrdir=a_bzrdir,
1012
_repository=a_bzrdir.find_repository())
1013
1014
1015
class BzrBranchFormat6(BzrBranchFormat5):
1016
"""Branch format with last-revision
1017
1018
Unlike previous formats, this has no explicit revision history. Instead,
1019
this just stores the last-revision, and the left-hand history leading
1020
up to there is the history.
1021
1022
This format was introduced in bzr 0.15
1023
"""
1024
1025
def get_format_string(self):
1026
"""See BranchFormat.get_format_string()."""
1027
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1028
1029
def get_format_description(self):
1030
"""See BranchFormat.get_format_description()."""
1031
return "Branch format 6"
1032
1033
def initialize(self, a_bzrdir):
1034
"""Create a branch of this format in a_bzrdir."""
1035
utf8_files = [('last-revision', '0 null:\n'),
1036
('branch-name', ''),
1037
('branch.conf', ''),
1038
('tags', ''),
1039
]
1040
return self._initialize_helper(a_bzrdir, utf8_files)
1041
1042
def open(self, a_bzrdir, _found=False):
1043
"""Return the branch object for a_bzrdir
1044
1045
_found is a private parameter, do not use it. It is used to indicate
1046
if format probing has already be done.
1047
"""
1048
if not _found:
1049
format = BranchFormat.find_format(a_bzrdir)
1050
assert format.__class__ == self.__class__
1051
transport = a_bzrdir.get_branch_transport(None)
1052
control_files = lockable_files.LockableFiles(transport, 'lock',
1053
lockdir.LockDir)
1054
return BzrBranch6(_format=self,
1055
_control_files=control_files,
1056
a_bzrdir=a_bzrdir,
1057
_repository=a_bzrdir.find_repository())
1058
1059
def supports_tags(self):
1060
return True
1061
1062
1063
class BranchReferenceFormat(BranchFormat):
1064
"""Bzr branch reference format.
1065
1066
Branch references are used in implementing checkouts, they
1067
act as an alias to the real branch which is at some other url.
1068
1069
This format has:
1070
- A location file
1071
- a format string
1072
"""
1073
1074
def get_format_string(self):
1075
"""See BranchFormat.get_format_string()."""
1076
return "Bazaar-NG Branch Reference Format 1\n"
1077
1078
def get_format_description(self):
1079
"""See BranchFormat.get_format_description()."""
1080
return "Checkout reference format 1"
1081
1082
def initialize(self, a_bzrdir, target_branch=None):
1083
"""Create a branch of this format in a_bzrdir."""
1084
if target_branch is None:
1085
# this format does not implement branch itself, thus the implicit
1086
# creation contract must see it as uninitializable
1087
raise errors.UninitializableFormat(self)
1088
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1089
branch_transport = a_bzrdir.get_branch_transport(self)
1090
branch_transport.put_bytes('location',
1091
target_branch.bzrdir.root_transport.base)
1092
branch_transport.put_bytes('format', self.get_format_string())
1093
return self.open(a_bzrdir, _found=True)
1094
1095
def __init__(self):
1096
super(BranchReferenceFormat, self).__init__()
1097
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1098
1099
def _make_reference_clone_function(format, a_branch):
1100
"""Create a clone() routine for a branch dynamically."""
1101
def clone(to_bzrdir, revision_id=None):
1102
"""See Branch.clone()."""
1103
return format.initialize(to_bzrdir, a_branch)
1104
# cannot obey revision_id limits when cloning a reference ...
1105
# FIXME RBC 20060210 either nuke revision_id for clone, or
1106
# emit some sort of warning/error to the caller ?!
1107
return clone
1108
1109
def open(self, a_bzrdir, _found=False):
1110
"""Return the branch that the branch reference in a_bzrdir points at.
1111
1112
_found is a private parameter, do not use it. It is used to indicate
1113
if format probing has already be done.
1114
"""
1115
if not _found:
1116
format = BranchFormat.find_format(a_bzrdir)
1117
assert format.__class__ == self.__class__
1118
transport = a_bzrdir.get_branch_transport(None)
1119
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1120
result = real_bzrdir.open_branch()
1121
# this changes the behaviour of result.clone to create a new reference
1122
# rather than a copy of the content of the branch.
1123
# I did not use a proxy object because that needs much more extensive
1124
# testing, and we are only changing one behaviour at the moment.
1125
# If we decide to alter more behaviours - i.e. the implicit nickname
1126
# then this should be refactored to introduce a tested proxy branch
1127
# and a subclass of that for use in overriding clone() and ....
1128
# - RBC 20060210
1129
result.clone = self._make_reference_clone_function(result)
1130
return result
1131
1132
1133
# formats which have no format string are not discoverable
1134
# and not independently creatable, so are not registered.
1135
__default_format = BzrBranchFormat5()
1136
BranchFormat.register_format(__default_format)
1137
BranchFormat.register_format(BranchReferenceFormat())
1138
BranchFormat.register_format(BzrBranchFormat6())
1139
BranchFormat.set_default_format(__default_format)
1140
_legacy_formats = [BzrBranchFormat4(),
1141
]
1142
1143
class BzrBranch(Branch):
1144
"""A branch stored in the actual filesystem.
1145
1146
Note that it's "local" in the context of the filesystem; it doesn't
1147
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1148
it's writable, and can be accessed via the normal filesystem API.
1149
"""
1150
1151
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1152
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1153
_control_files=None, a_bzrdir=None, _repository=None):
1154
"""Create new branch object at a particular location.
1155
1156
transport -- A Transport object, defining how to access files.
1157
1158
init -- If True, create new control files in a previously
1159
unversioned directory. If False, the branch must already
1160
be versioned.
1161
1162
relax_version_check -- If true, the usual check for the branch
1163
version is not applied. This is intended only for
1164
upgrade/recovery type use; it's not guaranteed that
1165
all operations will work on old format branches.
1166
"""
1167
Branch.__init__(self)
1168
if a_bzrdir is None:
1169
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1170
else:
1171
self.bzrdir = a_bzrdir
1172
# self._transport used to point to the directory containing the
1173
# control directory, but was not used - now it's just the transport
1174
# for the branch control files. mbp 20070212
1175
self._base = self.bzrdir.transport.clone('..').base
1176
self._format = _format
1177
if _control_files is None:
1178
raise ValueError('BzrBranch _control_files is None')
1179
self.control_files = _control_files
1180
self._transport = _control_files._transport
1181
if deprecated_passed(init):
1182
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1183
"deprecated as of bzr 0.8. Please use Branch.create().",
1184
DeprecationWarning,
1185
stacklevel=2)
1186
if init:
1187
# this is slower than before deprecation, oh well never mind.
1188
# -> its deprecated.
1189
self._initialize(transport.base)
1190
self._check_format(_format)
1191
if deprecated_passed(relax_version_check):
1192
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1193
"relax_version_check parameter is deprecated as of bzr 0.8. "
1194
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1195
"open() method.",
1196
DeprecationWarning,
1197
stacklevel=2)
1198
if (not relax_version_check
1199
and not self._format.is_supported()):
1200
raise errors.UnsupportedFormatError(format=fmt)
1201
if deprecated_passed(transport):
1202
warn("BzrBranch.__init__(transport=XXX...): The transport "
1203
"parameter is deprecated as of bzr 0.8. "
1204
"Please use Branch.open, or bzrdir.open_branch().",
1205
DeprecationWarning,
1206
stacklevel=2)
1207
self.repository = _repository
1208
1209
def __str__(self):
1210
return '%s(%r)' % (self.__class__.__name__, self.base)
1211
1212
__repr__ = __str__
1213
1214
def _get_base(self):
1215
"""Returns the directory containing the control directory."""
1216
return self._base
1217
1218
base = property(_get_base, doc="The URL for the root of this branch.")
1219
1220
def _finish_transaction(self):
1221
"""Exit the current transaction."""
1222
return self.control_files._finish_transaction()
1223
1224
def get_transaction(self):
1225
"""Return the current active transaction.
1226
1227
If no transaction is active, this returns a passthrough object
1228
for which all data is immediately flushed and no caching happens.
1229
"""
1230
# this is an explicit function so that we can do tricky stuff
1231
# when the storage in rev_storage is elsewhere.
1232
# we probably need to hook the two 'lock a location' and
1233
# 'have a transaction' together more delicately, so that
1234
# we can have two locks (branch and storage) and one transaction
1235
# ... and finishing the transaction unlocks both, but unlocking
1236
# does not. - RBC 20051121
1237
return self.control_files.get_transaction()
1238
1239
def _set_transaction(self, transaction):
1240
"""Set a new active transaction."""
1241
return self.control_files._set_transaction(transaction)
1242
1243
def abspath(self, name):
1244
"""See Branch.abspath."""
1245
return self.control_files._transport.abspath(name)
1246
1247
def _check_format(self, format):
1248
"""Identify the branch format if needed.
1249
1250
The format is stored as a reference to the format object in
1251
self._format for code that needs to check it later.
1252
1253
The format parameter is either None or the branch format class
1254
used to open this branch.
1255
1256
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1257
"""
1258
if format is None:
1259
format = BranchFormat.find_format(self.bzrdir)
1260
self._format = format
1261
mutter("got branch format %s", self._format)
1262
1263
@needs_read_lock
1264
def get_root_id(self):
1265
"""See Branch.get_root_id."""
1266
tree = self.repository.revision_tree(self.last_revision())
1267
return tree.inventory.root.file_id
1268
1269
def is_locked(self):
1270
return self.control_files.is_locked()
1271
1272
def lock_write(self):
1273
self.repository.lock_write()
1274
try:
1275
self.control_files.lock_write()
1276
except:
1277
self.repository.unlock()
1278
raise
1279
1280
def lock_read(self):
1281
self.repository.lock_read()
1282
try:
1283
self.control_files.lock_read()
1284
except:
1285
self.repository.unlock()
1286
raise
1287
1288
def unlock(self):
1289
# TODO: test for failed two phase locks. This is known broken.
1290
try:
1291
self.control_files.unlock()
1292
finally:
1293
self.repository.unlock()
1294
1295
def peek_lock_mode(self):
1296
if self.control_files._lock_count == 0:
1297
return None
1298
else:
1299
return self.control_files._lock_mode
1300
1301
def get_physical_lock_status(self):
1302
return self.control_files.get_physical_lock_status()
1303
1304
@needs_read_lock
1305
def print_file(self, file, revision_id):
1306
"""See Branch.print_file."""
1307
return self.repository.print_file(file, revision_id)
1308
1309
@needs_write_lock
1310
def append_revision(self, *revision_ids):
1311
"""See Branch.append_revision."""
1312
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1313
for revision_id in revision_ids:
1314
_mod_revision.check_not_reserved_id(revision_id)
1315
mutter("add {%s} to revision-history" % revision_id)
1316
rev_history = self.revision_history()
1317
rev_history.extend(revision_ids)
1318
self.set_revision_history(rev_history)
1319
1320
def _write_revision_history(self, history):
1321
"""Factored out of set_revision_history.
1322
1323
This performs the actual writing to disk.
1324
It is intended to be called by BzrBranch5.set_revision_history."""
1325
self.control_files.put_bytes(
1326
'revision-history', '\n'.join(history))
1327
1328
@needs_write_lock
1329
def set_revision_history(self, rev_history):
1330
"""See Branch.set_revision_history."""
1331
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1332
self._write_revision_history(rev_history)
1333
transaction = self.get_transaction()
1334
history = transaction.map.find_revision_history()
1335
if history is not None:
1336
# update the revision history in the identity map.
1337
history[:] = list(rev_history)
1338
# this call is disabled because revision_history is
1339
# not really an object yet, and the transaction is for objects.
1340
# transaction.register_dirty(history)
1341
else:
1342
transaction.map.add_revision_history(rev_history)
1343
# this call is disabled because revision_history is
1344
# not really an object yet, and the transaction is for objects.
1345
# transaction.register_clean(history)
1346
for hook in Branch.hooks['set_rh']:
1347
hook(self, rev_history)
1348
1349
@needs_write_lock
1350
def set_last_revision_info(self, revno, revision_id):
1351
revision_id = osutils.safe_revision_id(revision_id)
1352
history = self._lefthand_history(revision_id)
1353
assert len(history) == revno, '%d != %d' % (len(history), revno)
1354
self.set_revision_history(history)
1355
1356
def _gen_revision_history(self):
1357
history = self.control_files.get('revision-history').read().split('\n')
1358
if history[-1:] == ['']:
1359
# There shouldn't be a trailing newline, but just in case.
1360
history.pop()
1361
return history
1362
1363
@needs_read_lock
1364
def revision_history(self):
1365
"""See Branch.revision_history."""
1366
transaction = self.get_transaction()
1367
history = transaction.map.find_revision_history()
1368
if history is not None:
1369
# mutter("cache hit for revision-history in %s", self)
1370
return list(history)
1371
history = self._gen_revision_history()
1372
transaction.map.add_revision_history(history)
1373
# this call is disabled because revision_history is
1374
# not really an object yet, and the transaction is for objects.
1375
# transaction.register_clean(history, precious=True)
1376
return list(history)
1377
1378
def _lefthand_history(self, revision_id, last_rev=None,
1379
other_branch=None):
1380
# stop_revision must be a descendant of last_revision
1381
stop_graph = self.repository.get_revision_graph(revision_id)
1382
if last_rev is not None and last_rev not in stop_graph:
1383
# our previous tip is not merged into stop_revision
1384
raise errors.DivergedBranches(self, other_branch)
1385
# make a new revision history from the graph
1386
current_rev_id = revision_id
1387
new_history = []
1388
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1389
new_history.append(current_rev_id)
1390
current_rev_id_parents = stop_graph[current_rev_id]
1391
try:
1392
current_rev_id = current_rev_id_parents[0]
1393
except IndexError:
1394
current_rev_id = None
1395
new_history.reverse()
1396
return new_history
1397
1398
@needs_write_lock
1399
def generate_revision_history(self, revision_id, last_rev=None,
1400
other_branch=None):
1401
"""Create a new revision history that will finish with revision_id.
1402
1403
:param revision_id: the new tip to use.
1404
:param last_rev: The previous last_revision. If not None, then this
1405
must be a ancestory of revision_id, or DivergedBranches is raised.
1406
:param other_branch: The other branch that DivergedBranches should
1407
raise with respect to.
1408
"""
1409
revision_id = osutils.safe_revision_id(revision_id)
1410
self.set_revision_history(self._lefthand_history(revision_id,
1411
last_rev, other_branch))
1412
1413
@needs_write_lock
1414
def update_revisions(self, other, stop_revision=None):
1415
"""See Branch.update_revisions."""
1416
other.lock_read()
1417
try:
1418
if stop_revision is None:
1419
stop_revision = other.last_revision()
1420
if stop_revision is None:
1421
# if there are no commits, we're done.
1422
return
1423
else:
1424
stop_revision = osutils.safe_revision_id(stop_revision)
1425
# whats the current last revision, before we fetch [and change it
1426
# possibly]
1427
last_rev = self.last_revision()
1428
# we fetch here regardless of whether we need to so that we pickup
1429
# filled in ghosts.
1430
self.fetch(other, stop_revision)
1431
my_ancestry = self.repository.get_ancestry(last_rev)
1432
if stop_revision in my_ancestry:
1433
# last_revision is a descendant of stop_revision
1434
return
1435
self.generate_revision_history(stop_revision, last_rev=last_rev,
1436
other_branch=other)
1437
finally:
1438
other.unlock()
1439
1440
def basis_tree(self):
1441
"""See Branch.basis_tree."""
1442
return self.repository.revision_tree(self.last_revision())
1443
1444
@deprecated_method(zero_eight)
1445
def working_tree(self):
1446
"""Create a Working tree object for this branch."""
1447
1448
from bzrlib.transport.local import LocalTransport
1449
if (self.base.find('://') != -1 or
1450
not isinstance(self._transport, LocalTransport)):
1451
raise NoWorkingTree(self.base)
1452
return self.bzrdir.open_workingtree()
1453
1454
@needs_write_lock
1455
def pull(self, source, overwrite=False, stop_revision=None,
1456
_hook_master=None, _run_hooks=True):
1457
"""See Branch.pull.
1458
1459
:param _hook_master: Private parameter - set the branch to
1460
be supplied as the master to push hooks.
1461
:param _run_hooks: Private parameter - allow disabling of
1462
hooks, used when pushing to a master branch.
1463
"""
1464
result = PullResult()
1465
result.source_branch = source
1466
result.target_branch = self
1467
source.lock_read()
1468
try:
1469
result.old_revno, result.old_revid = self.last_revision_info()
1470
try:
1471
self.update_revisions(source, stop_revision)
1472
except DivergedBranches:
1473
if not overwrite:
1474
raise
1475
if overwrite:
1476
if stop_revision is None:
1477
stop_revision = source.last_revision()
1478
self.generate_revision_history(stop_revision)
1479
result.tag_conflicts = source.tags.merge_to(self.tags)
1480
result.new_revno, result.new_revid = self.last_revision_info()
1481
if _hook_master:
1482
result.master_branch = _hook_master
1483
result.local_branch = self
1484
else:
1485
result.master_branch = self
1486
result.local_branch = None
1487
if _run_hooks:
1488
for hook in Branch.hooks['post_pull']:
1489
hook(result)
1490
finally:
1491
source.unlock()
1492
return result
1493
1494
def _get_parent_location(self):
1495
_locs = ['parent', 'pull', 'x-pull']
1496
for l in _locs:
1497
try:
1498
return self.control_files.get(l).read().strip('\n')
1499
except NoSuchFile:
1500
pass
1501
return None
1502
1503
@needs_read_lock
1504
def push(self, target, overwrite=False, stop_revision=None,
1505
_hook_master=None, _run_hooks=True):
1506
"""See Branch.push.
1507
1508
:param _hook_master: Private parameter - set the branch to
1509
be supplied as the master to push hooks.
1510
:param _run_hooks: Private parameter - allow disabling of
1511
hooks, used when pushing to a master branch.
1512
"""
1513
result = PushResult()
1514
result.source_branch = self
1515
result.target_branch = target
1516
target.lock_write()
1517
try:
1518
result.old_revno, result.old_revid = target.last_revision_info()
1519
try:
1520
target.update_revisions(self, stop_revision)
1521
except DivergedBranches:
1522
if not overwrite:
1523
raise
1524
if overwrite:
1525
target.set_revision_history(self.revision_history())
1526
result.tag_conflicts = self.tags.merge_to(target.tags)
1527
result.new_revno, result.new_revid = target.last_revision_info()
1528
if _hook_master:
1529
result.master_branch = _hook_master
1530
result.local_branch = target
1531
else:
1532
result.master_branch = target
1533
result.local_branch = None
1534
if _run_hooks:
1535
for hook in Branch.hooks['post_push']:
1536
hook(result)
1537
finally:
1538
target.unlock()
1539
return result
1540
1541
def get_parent(self):
1542
"""See Branch.get_parent."""
1543
1544
assert self.base[-1] == '/'
1545
parent = self._get_parent_location()
1546
if parent is None:
1547
return parent
1548
# This is an old-format absolute path to a local branch
1549
# turn it into a url
1550
if parent.startswith('/'):
1551
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1552
try:
1553
return urlutils.join(self.base[:-1], parent)
1554
except errors.InvalidURLJoin, e:
1555
raise errors.InaccessibleParent(parent, self.base)
1556
1557
def get_push_location(self):
1558
"""See Branch.get_push_location."""
1559
push_loc = self.get_config().get_user_option('push_location')
1560
return push_loc
1561
1562
def set_push_location(self, location):
1563
"""See Branch.set_push_location."""
1564
self.get_config().set_user_option(
1565
'push_location', location,
1566
store=_mod_config.STORE_LOCATION_NORECURSE)
1567
1568
@needs_write_lock
1569
def set_parent(self, url):
1570
"""See Branch.set_parent."""
1571
# TODO: Maybe delete old location files?
1572
# URLs should never be unicode, even on the local fs,
1573
# FIXUP this and get_parent in a future branch format bump:
1574
# read and rewrite the file, and have the new format code read
1575
# using .get not .get_utf8. RBC 20060125
1576
if url is not None:
1577
if isinstance(url, unicode):
1578
try:
1579
url = url.encode('ascii')
1580
except UnicodeEncodeError:
1581
raise bzrlib.errors.InvalidURL(url,
1582
"Urls must be 7-bit ascii, "
1583
"use bzrlib.urlutils.escape")
1584
url = urlutils.relative_url(self.base, url)
1585
self._set_parent_location(url)
1586
1587
def _set_parent_location(self, url):
1588
if url is None:
1589
self.control_files._transport.delete('parent')
1590
else:
1591
assert isinstance(url, str)
1592
self.control_files.put_bytes('parent', url + '\n')
1593
1594
@deprecated_function(zero_nine)
1595
def tree_config(self):
1596
"""DEPRECATED; call get_config instead.
1597
TreeConfig has become part of BranchConfig."""
1598
return TreeConfig(self)
1599
1600
1601
class BzrBranch5(BzrBranch):
1602
"""A format 5 branch. This supports new features over plan branches.
1603
1604
It has support for a master_branch which is the data for bound branches.
1605
"""
1606
1607
def __init__(self,
1608
_format,
1609
_control_files,
1610
a_bzrdir,
1611
_repository):
1612
super(BzrBranch5, self).__init__(_format=_format,
1613
_control_files=_control_files,
1614
a_bzrdir=a_bzrdir,
1615
_repository=_repository)
1616
1617
@needs_write_lock
1618
def pull(self, source, overwrite=False, stop_revision=None,
1619
_run_hooks=True):
1620
"""Extends branch.pull to be bound branch aware.
1621
1622
:param _run_hooks: Private parameter used to force hook running
1623
off during bound branch double-pushing.
1624
"""
1625
bound_location = self.get_bound_location()
1626
master_branch = None
1627
if bound_location and source.base != bound_location:
1628
# not pulling from master, so we need to update master.
1629
master_branch = self.get_master_branch()
1630
master_branch.lock_write()
1631
try:
1632
if master_branch:
1633
# pull from source into master.
1634
master_branch.pull(source, overwrite, stop_revision,
1635
_run_hooks=False)
1636
return super(BzrBranch5, self).pull(source, overwrite,
1637
stop_revision, _hook_master=master_branch,
1638
_run_hooks=_run_hooks)
1639
finally:
1640
if master_branch:
1641
master_branch.unlock()
1642
1643
@needs_read_lock
1644
def push(self, target, overwrite=False, stop_revision=None):
1645
"""Updates branch.push to be bound branch aware."""
1646
bound_location = target.get_bound_location()
1647
master_branch = None
1648
if bound_location and target.base != bound_location:
1649
# not pushing to master, so we need to update master.
1650
master_branch = target.get_master_branch()
1651
master_branch.lock_write()
1652
try:
1653
if master_branch:
1654
# push into the master from this branch.
1655
super(BzrBranch5, self).push(master_branch, overwrite,
1656
stop_revision, _run_hooks=False)
1657
# and push into the target branch from this. Note that we push from
1658
# this branch again, because its considered the highest bandwidth
1659
# repository.
1660
return super(BzrBranch5, self).push(target, overwrite,
1661
stop_revision, _hook_master=master_branch)
1662
finally:
1663
if master_branch:
1664
master_branch.unlock()
1665
1666
def get_bound_location(self):
1667
try:
1668
return self.control_files.get_utf8('bound').read()[:-1]
1669
except errors.NoSuchFile:
1670
return None
1671
1672
@needs_read_lock
1673
def get_master_branch(self):
1674
"""Return the branch we are bound to.
1675
1676
:return: Either a Branch, or None
1677
1678
This could memoise the branch, but if thats done
1679
it must be revalidated on each new lock.
1680
So for now we just don't memoise it.
1681
# RBC 20060304 review this decision.
1682
"""
1683
bound_loc = self.get_bound_location()
1684
if not bound_loc:
1685
return None
1686
try:
1687
return Branch.open(bound_loc)
1688
except (errors.NotBranchError, errors.ConnectionError), e:
1689
raise errors.BoundBranchConnectionFailure(
1690
self, bound_loc, e)
1691
1692
@needs_write_lock
1693
def set_bound_location(self, location):
1694
"""Set the target where this branch is bound to.
1695
1696
:param location: URL to the target branch
1697
"""
1698
if location:
1699
self.control_files.put_utf8('bound', location+'\n')
1700
else:
1701
try:
1702
self.control_files._transport.delete('bound')
1703
except NoSuchFile:
1704
return False
1348
1705
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
1706
1707
@needs_write_lock
1708
def bind(self, other):
1709
"""Bind this branch to the branch other.
1710
1711
This does not push or pull data between the branches, though it does
1712
check for divergence to raise an error when the branches are not
1713
either the same, or one a prefix of the other. That behaviour may not
1714
be useful, so that check may be removed in future.
1715
1716
:param other: The branch to bind to
1717
:type other: Branch
1718
"""
1719
# TODO: jam 20051230 Consider checking if the target is bound
1720
# It is debatable whether you should be able to bind to
1721
# a branch which is itself bound.
1722
# Committing is obviously forbidden,
1723
# but binding itself may not be.
1724
# Since we *have* to check at commit time, we don't
1725
# *need* to check here
1726
1727
# we want to raise diverged if:
1728
# last_rev is not in the other_last_rev history, AND
1729
# other_last_rev is not in our history, and do it without pulling
1730
# history around
1731
last_rev = self.last_revision()
1732
if last_rev is not None:
1733
other.lock_read()
1734
try:
1735
other_last_rev = other.last_revision()
1736
if other_last_rev is not None:
1737
# neither branch is new, we have to do some work to
1738
# ascertain diversion.
1739
remote_graph = other.repository.get_revision_graph(
1740
other_last_rev)
1741
local_graph = self.repository.get_revision_graph(last_rev)
1742
if (last_rev not in remote_graph and
1743
other_last_rev not in local_graph):
1744
raise errors.DivergedBranches(self, other)
1745
finally:
1746
other.unlock()
1747
self.set_bound_location(other.base)
1748
1749
@needs_write_lock
1750
def unbind(self):
1751
"""If bound, unbind"""
1752
return self.set_bound_location(None)
1753
1754
@needs_write_lock
1755
def update(self):
1756
"""Synchronise this branch with the master branch if any.
1757
1758
:return: None or the last_revision that was pivoted out during the
1759
update.
1760
"""
1761
master = self.get_master_branch()
1762
if master is not None:
1763
old_tip = self.last_revision()
1764
self.pull(master, overwrite=True)
1765
if old_tip in self.repository.get_ancestry(self.last_revision()):
1766
return None
1767
return old_tip
1768
return None
1769
1770
1771
class BzrBranchExperimental(BzrBranch5):
1772
"""Bzr experimental branch format
1773
1774
This format has:
1775
- a revision-history file.
1776
- a format string
1777
- a lock dir guarding the branch itself
1778
- all of this stored in a branch/ subdirectory
1779
- works with shared repositories.
1780
- a tag dictionary in the branch
1781
1782
This format is new in bzr 0.15, but shouldn't be used for real data,
1783
only for testing.
1784
1785
This class acts as it's own BranchFormat.
1786
"""
1787
1788
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1789
1790
@classmethod
1791
def get_format_string(cls):
1792
"""See BranchFormat.get_format_string()."""
1793
return "Bazaar-NG branch format experimental\n"
1794
1795
@classmethod
1796
def get_format_description(cls):
1797
"""See BranchFormat.get_format_description()."""
1798
return "Experimental branch format"
1799
1800
@classmethod
1801
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1802
lock_class):
1803
branch_transport = a_bzrdir.get_branch_transport(cls)
1804
control_files = lockable_files.LockableFiles(branch_transport,
1805
lock_filename, lock_class)
1806
control_files.create_lock()
1807
control_files.lock_write()
1808
try:
1809
for filename, content in utf8_files:
1810
control_files.put_utf8(filename, content)
1811
finally:
1812
control_files.unlock()
1813
1814
@classmethod
1815
def initialize(cls, a_bzrdir):
1816
"""Create a branch of this format in a_bzrdir."""
1817
utf8_files = [('format', cls.get_format_string()),
1818
('revision-history', ''),
1819
('branch-name', ''),
1820
('tags', ''),
1821
]
1822
cls._initialize_control_files(a_bzrdir, utf8_files,
1823
'lock', lockdir.LockDir)
1824
return cls.open(a_bzrdir, _found=True)
1825
1826
@classmethod
1827
def open(cls, a_bzrdir, _found=False):
1828
"""Return the branch object for a_bzrdir
1829
1830
_found is a private parameter, do not use it. It is used to indicate
1831
if format probing has already be done.
1832
"""
1833
if not _found:
1834
format = BranchFormat.find_format(a_bzrdir)
1835
assert format.__class__ == cls
1836
transport = a_bzrdir.get_branch_transport(None)
1837
control_files = lockable_files.LockableFiles(transport, 'lock',
1838
lockdir.LockDir)
1839
return cls(_format=cls,
1840
_control_files=control_files,
1841
a_bzrdir=a_bzrdir,
1842
_repository=a_bzrdir.find_repository())
1843
1844
@classmethod
1845
def is_supported(cls):
1846
return True
1847
1848
def _make_tags(self):
1849
return BasicTags(self)
1850
1851
@classmethod
1852
def supports_tags(cls):
1853
return True
1854
1855
1856
BranchFormat.register_format(BzrBranchExperimental)
1857
1858
1859
class BzrBranch6(BzrBranch5):
1860
1861
@needs_read_lock
1862
def last_revision_info(self):
1863
revision_string = self.control_files.get('last-revision').read()
1864
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1865
revision_id = cache_utf8.get_cached_utf8(revision_id)
1866
revno = int(revno)
1867
return revno, revision_id
1868
1869
def last_revision(self):
1870
"""Return last revision id, or None"""
1871
revision_id = self.last_revision_info()[1]
1872
if revision_id == _mod_revision.NULL_REVISION:
1873
revision_id = None
1874
return revision_id
1875
1876
def _write_last_revision_info(self, revno, revision_id):
1877
"""Simply write out the revision id, with no checks.
1878
1879
Use set_last_revision_info to perform this safely.
1880
1881
Does not update the revision_history cache.
1882
Intended to be called by set_last_revision_info and
1883
_write_revision_history.
1884
"""
1885
if revision_id is None:
1886
revision_id = 'null:'
1887
out_string = '%d %s\n' % (revno, revision_id)
1888
self.control_files.put_bytes('last-revision', out_string)
1889
1890
@needs_write_lock
1891
def set_last_revision_info(self, revno, revision_id):
1892
revision_id = osutils.safe_revision_id(revision_id)
1893
if self._get_append_revisions_only():
1894
self._check_history_violation(revision_id)
1895
self._write_last_revision_info(revno, revision_id)
1896
transaction = self.get_transaction()
1897
cached_history = transaction.map.find_revision_history()
1898
if cached_history is not None:
1899
transaction.map.remove_object(cached_history)
1900
1901
def _check_history_violation(self, revision_id):
1902
last_revision = self.last_revision()
1903
if last_revision is None:
1904
return
1905
if last_revision not in self._lefthand_history(revision_id):
1906
raise errors.AppendRevisionsOnlyViolation(self.base)
1907
1908
def _gen_revision_history(self):
1909
"""Generate the revision history from last revision
1910
"""
1911
history = list(self.repository.iter_reverse_revision_history(
1912
self.last_revision()))
1913
history.reverse()
1914
return history
1915
1916
def _write_revision_history(self, history):
1917
"""Factored out of set_revision_history.
1918
1919
This performs the actual writing to disk, with format-specific checks.
1920
It is intended to be called by BzrBranch5.set_revision_history.
1921
"""
1922
if len(history) == 0:
1923
last_revision = 'null:'
1924
else:
1925
if history != self._lefthand_history(history[-1]):
1926
raise errors.NotLefthandHistory(history)
1927
last_revision = history[-1]
1928
if self._get_append_revisions_only():
1929
self._check_history_violation(last_revision)
1930
self._write_last_revision_info(len(history), last_revision)
1931
1932
@needs_write_lock
1933
def append_revision(self, *revision_ids):
1934
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1935
if len(revision_ids) == 0:
1936
return
1937
prev_revno, prev_revision = self.last_revision_info()
1938
for revision in self.repository.get_revisions(revision_ids):
1939
if prev_revision == _mod_revision.NULL_REVISION:
1940
if revision.parent_ids != []:
1941
raise errors.NotLeftParentDescendant(self, prev_revision,
1942
revision.revision_id)
1943
else:
1944
if revision.parent_ids[0] != prev_revision:
1945
raise errors.NotLeftParentDescendant(self, prev_revision,
1946
revision.revision_id)
1947
prev_revision = revision.revision_id
1948
self.set_last_revision_info(prev_revno + len(revision_ids),
1949
revision_ids[-1])
1950
1951
def _set_config_location(self, name, url, config=None,
1952
make_relative=False):
1953
if config is None:
1954
config = self.get_config()
1955
if url is None:
1956
url = ''
1957
elif make_relative:
1958
url = urlutils.relative_url(self.base, url)
1959
config.set_user_option(name, url)
1960
1961
1962
def _get_config_location(self, name, config=None):
1963
if config is None:
1964
config = self.get_config()
1965
location = config.get_user_option(name)
1966
if location == '':
1967
location = None
1968
return location
1969
1970
@needs_write_lock
1971
def _set_parent_location(self, url):
1972
"""Set the parent branch"""
1973
self._set_config_location('parent_location', url, make_relative=True)
1974
1975
@needs_read_lock
1976
def _get_parent_location(self):
1977
"""Set the parent branch"""
1978
return self._get_config_location('parent_location')
1979
1980
def set_push_location(self, location):
1981
"""See Branch.set_push_location."""
1982
self._set_config_location('push_location', location)
1983
1984
def set_bound_location(self, location):
1985
"""See Branch.set_push_location."""
1986
result = None
1987
config = self.get_config()
1988
if location is None:
1989
if config.get_user_option('bound') != 'True':
1990
return False
1991
else:
1992
config.set_user_option('bound', 'False')
1993
return True
1994
else:
1995
self._set_config_location('bound_location', location,
1996
config=config)
1997
config.set_user_option('bound', 'True')
1998
return True
1999
2000
def _get_bound_location(self, bound):
2001
"""Return the bound location in the config file.
2002
2003
Return None if the bound parameter does not match"""
2004
config = self.get_config()
2005
config_bound = (config.get_user_option('bound') == 'True')
2006
if config_bound != bound:
2007
return None
2008
return self._get_config_location('bound_location', config=config)
2009
2010
def get_bound_location(self):
2011
"""See Branch.set_push_location."""
2012
return self._get_bound_location(True)
2013
2014
def get_old_bound_location(self):
2015
"""See Branch.get_old_bound_location"""
2016
return self._get_bound_location(False)
2017
2018
def set_append_revisions_only(self, enabled):
2019
if enabled:
2020
value = 'True'
2021
else:
2022
value = 'False'
2023
self.get_config().set_user_option('append_revisions_only', value)
2024
2025
def _get_append_revisions_only(self):
2026
value = self.get_config().get_user_option('append_revisions_only')
2027
return value == 'True'
2028
2029
def _synchronize_history(self, destination, revision_id):
2030
"""Synchronize last revision and revision history between branches.
2031
2032
This version is most efficient when the destination is also a
2033
BzrBranch6, but works for BzrBranch5, as long as the destination's
2034
repository contains all the lefthand ancestors of the intended
2035
last_revision. If not, set_last_revision_info will fail.
2036
2037
:param destination: The branch to copy the history into
2038
:param revision_id: The revision-id to truncate history at. May
2039
be None to copy complete history.
2040
"""
2041
if revision_id is None:
2042
revno, revision_id = self.last_revision_info()
2043
else:
2044
revno = self.revision_id_to_revno(revision_id)
2045
destination.set_last_revision_info(revno, revision_id)
2046
2047
def _make_tags(self):
2048
return BasicTags(self)
2049
2050
2051
class BranchTestProviderAdapter(object):
2052
"""A tool to generate a suite testing multiple branch formats at once.
2053
2054
This is done by copying the test once for each transport and injecting
2055
the transport_server, transport_readonly_server, and branch_format
2056
classes into each copy. Each copy is also given a new id() to make it
2057
easy to identify.
2058
"""
2059
2060
def __init__(self, transport_server, transport_readonly_server, formats):
2061
self._transport_server = transport_server
2062
self._transport_readonly_server = transport_readonly_server
2063
self._formats = formats
2064
2065
def adapt(self, test):
2066
result = TestSuite()
2067
for branch_format, bzrdir_format in self._formats:
2068
new_test = deepcopy(test)
2069
new_test.transport_server = self._transport_server
2070
new_test.transport_readonly_server = self._transport_readonly_server
2071
new_test.bzrdir_format = bzrdir_format
2072
new_test.branch_format = branch_format
2073
def make_new_test_id():
2074
# the format can be either a class or an instance
2075
name = getattr(branch_format, '__name__',
2076
branch_format.__class__.__name__)
2077
new_id = "%s(%s)" % (new_test.id(), name)
2078
return lambda: new_id
2079
new_test.id = make_new_test_id()
2080
result.addTest(new_test)
2081
return result
2082
2083
2084
######################################################################
2085
# results of operations
2086
2087
2088
class _Result(object):
2089
2090
def _show_tag_conficts(self, to_file):
2091
if not getattr(self, 'tag_conflicts', None):
2092
return
2093
to_file.write('Conflicting tags:\n')
2094
for name, value1, value2 in self.tag_conflicts:
2095
to_file.write(' %s\n' % (name, ))
2096
2097
2098
class PullResult(_Result):
2099
"""Result of a Branch.pull operation.
2100
2101
:ivar old_revno: Revision number before pull.
2102
:ivar new_revno: Revision number after pull.
2103
:ivar old_revid: Tip revision id before pull.
2104
:ivar new_revid: Tip revision id after pull.
2105
:ivar source_branch: Source (local) branch object.
2106
:ivar master_branch: Master branch of the target, or None.
2107
:ivar target_branch: Target/destination branch object.
2108
"""
2109
2110
def __int__(self):
2111
# DEPRECATED: pull used to return the change in revno
2112
return self.new_revno - self.old_revno
2113
2114
def report(self, to_file):
2115
if self.old_revid == self.new_revid:
2116
to_file.write('No revisions to pull.\n')
2117
else:
2118
to_file.write('Now on revision %d.\n' % self.new_revno)
2119
self._show_tag_conficts(to_file)
2120
2121
2122
class PushResult(_Result):
2123
"""Result of a Branch.push operation.
2124
2125
:ivar old_revno: Revision number before push.
2126
:ivar new_revno: Revision number after push.
2127
:ivar old_revid: Tip revision id before push.
2128
:ivar new_revid: Tip revision id after push.
2129
:ivar source_branch: Source branch object.
2130
:ivar master_branch: Master branch of the target, or None.
2131
:ivar target_branch: Target/destination branch object.
2132
"""
2133
2134
def __int__(self):
2135
# DEPRECATED: push used to return the change in revno
2136
return self.new_revno - self.old_revno
2137
2138
def report(self, to_file):
2139
"""Write a human-readable description of the result."""
2140
if self.old_revid == self.new_revid:
2141
to_file.write('No new revisions to push.\n')
2142
else:
2143
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2144
self._show_tag_conficts(to_file)
2145
2146
2147
class BranchCheckResult(object):
2148
"""Results of checking branch consistency.
2149
2150
:see: Branch.check
2151
"""
2152
2153
def __init__(self, branch):
2154
self.branch = branch
2155
2156
def report_results(self, verbose):
2157
"""Report the check results via trace.note.
2158
2159
:param verbose: Requests more detailed display of what was checked,
2160
if any.
2161
"""
2162
note('checked branch %s format %s',
2163
self.branch.base,
2164
self.branch._format)
2165
2166
2167
class Converter5to6(object):
2168
"""Perform an in-place upgrade of format 5 to format 6"""
2169
2170
def convert(self, branch):
2171
# Data for 5 and 6 can peacefully coexist.
2172
format = BzrBranchFormat6()
2173
new_branch = format.open(branch.bzrdir, _found=True)
2174
2175
# Copy source data into target
2176
new_branch.set_last_revision_info(*branch.last_revision_info())
2177
new_branch.set_parent(branch.get_parent())
2178
new_branch.set_bound_location(branch.get_bound_location())
2179
new_branch.set_push_location(branch.get_push_location())
2180
2181
# New branch has no tags by default
2182
new_branch.tags._set_tag_dict({})
2183
2184
# Copying done; now update target format
2185
new_branch.control_files.put_utf8('format',
2186
format.get_format_string())
2187
2188
# Clean up old files
2189
new_branch.control_files._transport.delete('revision-history')
2190
try:
2191
branch.set_parent(None)
2192
except NoSuchFile:
2193
pass
2194
branch.set_bound_location(None)
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0