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