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