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