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