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 1740.5.6
- compare with another revision
- download diff
- download tarball
- view history from revision 1740.5.6
- Committer: Martin Pool
- Date: 2006-06-15 05:36:34 UTC
- mto: This revision was merged to the branch mainline in revision 1797.
- Revision ID: mbp@sourcefrog.net-20060615053634-4fd52ba691855659
Clean up many exception classes.
Errors indicating a user error are now shown with is_user_error on the
exception; use this rather than hardcoding a list of exceptions that should be
handled this way.
Exceptions now inherit from BzrNewException where possible to use consistent
formatting method.
Remove rather obsolete docstring test on Branch.missing_revisions.
Remove dead code from find_merge_base.
Errors indicating a user error are now shown with is_user_error on the
exception; use this rather than hardcoding a list of exceptions that should be
handled this way.
Exceptions now inherit from BzrNewException where possible to use consistent
formatting method.
Remove rather obsolete docstring test on Branch.missing_revisions.
Remove dead code from find_merge_base.
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- 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/test_patches_data
- 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/mdiff.py
- notes
- patches
- plugins/changeset
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testlog.py => bzrlib/tests/test_log.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevision.py => bzrlib/tests/test_revision.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- tutorial.txt => doc/tutorial.txt
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- 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, 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
rmtree,
49
)
50
from bzrlib.textui import show_status
22
51
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
52
from bzrlib.tree import EmptyTree, RevisionTree
53
from bzrlib.repository import Repository
54
from bzrlib.revision import (
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
94
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
97
98
def break_lock(self):
99
"""Break a lock if one is present from another instance.
100
101
Uses the ui factory to ask for confirmation if the lock may be from
102
an active process.
103
104
This will probe the repository for its lock as well.
105
"""
106
self.control_files.break_lock()
107
self.repository.break_lock()
108
master = self.get_master_branch()
109
if master is not None:
110
master.break_lock()
111
112
@staticmethod
113
@deprecated_method(zero_eight)
114
def open_downlevel(base):
115
"""Open a branch which may be of an old format."""
116
return Branch.open(base, _unsupported=True)
117
118
@staticmethod
119
def open(base, _unsupported=False):
120
"""Open the repository rooted at base.
121
122
For instance, if the repository is at URL/.bzr/repository,
123
Repository.open(URL) -> a Repository instance.
124
"""
125
control = bzrdir.BzrDir.open(base, _unsupported)
126
return control.open_branch(_unsupported)
127
128
@staticmethod
129
def open_containing(url):
130
"""Open an existing branch which contains url.
131
132
This probes for a branch at url, and searches upwards from there.
133
134
Basically we keep looking up until we find the control directory or
135
run into the root. If there isn't one, raises NotBranchError.
136
If there is one and it is either an unrecognised format or an unsupported
137
format, UnknownFormatError or UnsupportedFormatError are raised.
138
If there is one, it is returned, along with the unused portion of url.
139
"""
140
control, relpath = bzrdir.BzrDir.open_containing(url)
141
return control.open_branch(), relpath
142
143
@staticmethod
144
@deprecated_function(zero_eight)
145
def initialize(base):
146
"""Create a new working tree and branch, rooted at 'base' (url)
147
148
NOTE: This will soon be deprecated in favour of creation
149
through a BzrDir.
150
"""
151
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
152
153
def setup_caching(self, cache_root):
154
"""Subclasses that care about caching should override this, and set
155
up cached stores located under cache_root.
156
"""
157
# seems to be unused, 2006-01-13 mbp
158
warn('%s is deprecated' % self.setup_caching)
159
self.cache_root = cache_root
160
161
def _get_nick(self):
162
cfg = self.tree_config()
163
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
164
165
def _set_nick(self, nick):
166
cfg = self.tree_config()
167
cfg.set_option(nick, "nickname")
168
assert cfg.get_option("nickname") == nick
169
170
nick = property(_get_nick, _set_nick)
171
172
def is_locked(self):
173
raise NotImplementedError('is_locked is abstract')
211
174
212
175
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
176
raise NotImplementedError('lock_write is abstract')
227
177
228
178
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
179
raise NotImplementedError('lock_read is abstract')
180
242
181
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
182
raise NotImplementedError('unlock is abstract')
183
184
def peek_lock_mode(self):
185
"""Return lock mode for the Branch: 'r', 'w' or None"""
186
raise NotImplementedError(self.peek_lock_mode)
187
188
def get_physical_lock_status(self):
189
raise NotImplementedError('get_physical_lock_status is abstract')
254
190
255
191
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)
192
"""Return absolute filename for something in the branch
193
194
XXX: Robert Collins 20051017 what is this used for? why is it a branch
195
method and not a tree method.
196
"""
197
raise NotImplementedError('abspath is abstract')
198
199
def bind(self, other):
200
"""Bind the local branch the other branch.
201
202
:param other: The branch to bind to
203
:type other: Branch
204
"""
205
raise errors.UpgradeRequired(self.base)
206
207
@needs_write_lock
208
def fetch(self, from_branch, last_revision=None, pb=None):
209
"""Copy revisions from from_branch into this branch.
210
211
:param from_branch: Where to copy from.
212
:param last_revision: What revision to stop at (None for at the end
213
of the branch.
214
:param pb: An optional progress bar to use.
215
216
Returns the copied revision count and the failed revisions in a tuple:
217
(copied, failures).
218
"""
219
if self.base == from_branch.base:
220
return (0, [])
221
if pb is None:
222
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
223
pb = nested_pb
296
224
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
225
nested_pb = None
226
227
from_branch.lock_read()
228
try:
229
if last_revision is None:
230
pb.update('get source history')
231
from_history = from_branch.revision_history()
232
if from_history:
233
last_revision = from_history[-1]
234
else:
235
# no history in the source branch
236
last_revision = NULL_REVISION
237
return self.repository.fetch(from_branch.repository,
238
revision_id=last_revision,
239
pb=nested_pb)
240
finally:
241
if nested_pb is not None:
242
nested_pb.finished()
243
from_branch.unlock()
244
245
def get_bound_location(self):
246
"""Return the URL of the branch we are bound to.
247
248
Older format branches cannot bind, please be sure to use a metadir
249
branch.
250
"""
251
return None
252
253
def get_master_branch(self):
254
"""Return the branch we are bound to.
304
255
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.
256
:return: Either a Branch, or None
329
257
"""
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'])
258
return None
339
259
340
260
def get_root_id(self):
341
261
"""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):
262
raise NotImplementedError('get_root_id is abstract')
263
264
def print_file(self, file, revision_id):
480
265
"""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
266
raise NotImplementedError('print_file is abstract')
568
267
569
268
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
269
raise NotImplementedError('append_revision is abstract')
270
271
def set_revision_history(self, rev_history):
272
raise NotImplementedError('set_revision_history is abstract')
679
273
680
274
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
275
"""Return sequence of revision hashes on to this branch."""
276
raise NotImplementedError('revision_history is abstract')
738
277
739
278
def revno(self):
740
279
"""Return current revision number for this branch.
744
283
"""
745
284
return len(self.revision_history())
746
285
286
def unbind(self):
287
"""Older format branches cannot bind or unbind."""
288
raise errors.UpgradeRequired(self.base)
747
289
748
def last_patch(self):
749
"""Return last patch hash, or None if no history.
750
"""
290
def last_revision(self):
291
"""Return last patch hash, or None if no history."""
751
292
ph = self.revision_history()
752
293
if ph:
753
294
return ph[-1]
754
295
else:
755
296
return None
756
297
757
758
298
def missing_revisions(self, other, stop_revision=None):
759
"""
299
"""Return a list of new revisions that would perfectly fit.
300
760
301
If self and other have not diverged, return a list of the revisions
761
302
present in other, but missing from self.
762
763
>>> from bzrlib.commit import commit
764
>>> bzrlib.trace.silent = True
765
>>> br1 = ScratchBranch()
766
>>> br2 = ScratchBranch()
767
>>> br1.missing_revisions(br2)
768
[]
769
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
770
>>> br1.missing_revisions(br2)
771
[u'REVISION-ID-1']
772
>>> br2.missing_revisions(br1)
773
[]
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
775
>>> br1.missing_revisions(br2)
776
[]
777
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
778
>>> br1.missing_revisions(br2)
779
[u'REVISION-ID-2A']
780
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
781
>>> br1.missing_revisions(br2)
782
Traceback (most recent call last):
783
DivergedBranches: These branches have diverged.
784
303
"""
785
304
self_history = self.revision_history()
786
305
self_len = len(self_history)
793
312
794
313
if stop_revision is None:
795
314
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
798
315
else:
316
assert isinstance(stop_revision, int)
317
if stop_revision > other_len:
318
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
319
return other_history[self_len:stop_revision]
800
320
801
802
321
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
322
"""Pull in new perfect-fit revisions.
323
324
:param other: Another Branch to pull from
325
:param stop_revision: Updated until the given revision
326
:return: None
327
"""
328
raise NotImplementedError('update_revisions is abstract')
329
330
def revision_id_to_revno(self, revision_id):
331
"""Given a revision id, return its revno"""
332
if revision_id is None:
333
return 0
334
history = self.revision_history()
335
try:
336
return history.index(revision_id) + 1
337
except ValueError:
338
raise bzrlib.errors.NoSuchRevision(self, revision_id)
339
340
def get_rev_id(self, revno, history=None):
341
"""Find the revision id of the specified revno."""
342
if revno == 0:
343
return None
344
if history is None:
345
history = self.revision_history()
346
elif revno <= 0 or revno > len(history):
347
raise bzrlib.errors.NoSuchRevision(self, revno)
348
return history[revno - 1]
349
350
def pull(self, source, overwrite=False, stop_revision=None):
351
raise NotImplementedError('pull is abstract')
1052
352
1053
353
def basis_tree(self):
1054
354
"""Return `Tree` object for last revision.
1055
355
1056
356
If there are no revisions yet, return an `EmptyTree`.
1057
357
"""
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
358
return self.repository.revision_tree(self.last_revision())
1065
359
1066
360
def rename_one(self, from_rel, to_rel):
1067
361
"""Rename one file.
1068
362
1069
363
This can change the directory or the filename or both.
1070
364
"""
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
365
raise NotImplementedError('rename_one is abstract')
1116
366
1117
367
def move(self, from_paths, to_name):
1118
368
"""Rename files.
1124
374
1125
375
Note that to_name is only the last component of the new name;
1126
376
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)
377
378
This returns a list of (from_path, to_path) pairs for each
379
entry that is moved.
380
"""
381
raise NotImplementedError('move is abstract')
382
383
def get_parent(self):
384
"""Return the parent location of the branch.
385
386
This is the default location for push/pull/missing. The usual
387
pattern is that the user can override it by specifying a
388
location.
389
"""
390
raise NotImplementedError('get_parent is abstract')
391
392
def get_push_location(self):
393
"""Return the None or the location to push this branch to."""
394
raise NotImplementedError('get_push_location is abstract')
395
396
def set_push_location(self, location):
397
"""Set a new push location for this branch."""
398
raise NotImplementedError('set_push_location is abstract')
399
400
def set_parent(self, url):
401
raise NotImplementedError('set_parent is abstract')
402
403
@needs_write_lock
404
def update(self):
405
"""Synchronise this branch with the master branch if any.
406
407
:return: None or the last_revision pivoted out during the update.
408
"""
409
return None
410
411
def check_revno(self, revno):
412
"""\
413
Check whether a revno corresponds to any revision.
414
Zero (the NULL revision) is considered valid.
415
"""
416
if revno != 0:
417
self.check_real_revno(revno)
418
419
def check_real_revno(self, revno):
420
"""\
421
Check whether a revno corresponds to a real revision.
422
Zero (the NULL revision) is considered invalid
423
"""
424
if revno < 1 or revno > self.revno():
425
raise InvalidRevisionNumber(revno)
426
427
@needs_read_lock
428
def clone(self, *args, **kwargs):
429
"""Clone this branch into to_bzrdir preserving all semantic values.
430
431
revision_id: if not None, the revision history in the new branch will
432
be truncated to end with revision_id.
433
"""
434
# for API compatability, until 0.8 releases we provide the old api:
435
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
436
# after 0.8 releases, the *args and **kwargs should be changed:
437
# def clone(self, to_bzrdir, revision_id=None):
438
if (kwargs.get('to_location', None) or
439
kwargs.get('revision', None) or
440
kwargs.get('basis_branch', None) or
441
(len(args) and isinstance(args[0], basestring))):
442
# backwards compatability api:
443
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
444
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
445
# get basis_branch
446
if len(args) > 2:
447
basis_branch = args[2]
448
else:
449
basis_branch = kwargs.get('basis_branch', None)
450
if basis_branch:
451
basis = basis_branch.bzrdir
452
else:
453
basis = None
454
# get revision
455
if len(args) > 1:
456
revision_id = args[1]
457
else:
458
revision_id = kwargs.get('revision', None)
459
# get location
460
if len(args):
461
url = args[0]
462
else:
463
# no default to raise if not provided.
464
url = kwargs.get('to_location')
465
return self.bzrdir.clone(url,
466
revision_id=revision_id,
467
basis=basis).open_branch()
468
# new cleaner api.
469
# generate args by hand
470
if len(args) > 1:
471
revision_id = args[1]
472
else:
473
revision_id = kwargs.get('revision_id', None)
474
if len(args):
475
to_bzrdir = args[0]
476
else:
477
# no default to raise if not provided.
478
to_bzrdir = kwargs.get('to_bzrdir')
479
result = self._format.initialize(to_bzrdir)
480
self.copy_content_into(result, revision_id=revision_id)
481
return result
482
483
@needs_read_lock
484
def sprout(self, to_bzrdir, revision_id=None):
485
"""Create a new line of development from the branch, into to_bzrdir.
486
487
revision_id: if not None, the revision history in the new branch will
488
be truncated to end with revision_id.
489
"""
490
result = self._format.initialize(to_bzrdir)
491
self.copy_content_into(result, revision_id=revision_id)
492
result.set_parent(self.bzrdir.root_transport.base)
493
return result
494
495
@needs_read_lock
496
def copy_content_into(self, destination, revision_id=None):
497
"""Copy the content of self into destination.
498
499
revision_id: if not None, the revision history in the new branch will
500
be truncated to end with revision_id.
501
"""
502
new_history = self.revision_history()
503
if revision_id is not None:
504
try:
505
new_history = new_history[:new_history.index(revision_id) + 1]
506
except ValueError:
507
rev = self.repository.get_revision(revision_id)
508
new_history = rev.get_history(self.repository)[1:]
509
destination.set_revision_history(new_history)
510
parent = self.get_parent()
511
if parent:
512
destination.set_parent(parent)
513
514
515
class BranchFormat(object):
516
"""An encapsulation of the initialization and open routines for a format.
517
518
Formats provide three things:
519
* An initialization routine,
520
* a format string,
521
* an open routine.
522
523
Formats are placed in an dict by their format string for reference
524
during branch opening. Its not required that these be instances, they
525
can be classes themselves with class methods - it simply depends on
526
whether state is needed for a given format or not.
527
528
Once a format is deprecated, just deprecate the initialize and open
529
methods on the format class. Do not deprecate the object, as the
530
object will be created every time regardless.
531
"""
532
533
_default_format = None
534
"""The default format used for new branches."""
535
536
_formats = {}
537
"""The known formats."""
538
539
@classmethod
540
def find_format(klass, a_bzrdir):
541
"""Return the format for the branch object in a_bzrdir."""
542
try:
543
transport = a_bzrdir.get_branch_transport(None)
544
format_string = transport.get("format").read()
545
return klass._formats[format_string]
546
except NoSuchFile:
547
raise NotBranchError(path=transport.base)
548
except KeyError:
549
raise errors.UnknownFormatError(format=format_string)
550
551
@classmethod
552
def get_default_format(klass):
553
"""Return the current default format."""
554
return klass._default_format
555
556
def get_format_string(self):
557
"""Return the ASCII format string that identifies this format."""
558
raise NotImplementedError(self.get_format_string)
559
560
def get_format_description(self):
561
"""Return the short format description for this format."""
562
raise NotImplementedError(self.get_format_string)
563
564
def initialize(self, a_bzrdir):
565
"""Create a branch of this format in a_bzrdir."""
566
raise NotImplementedError(self.initialized)
567
568
def is_supported(self):
569
"""Is this format supported?
570
571
Supported formats can be initialized and opened.
572
Unsupported formats may not support initialization or committing or
573
some other features depending on the reason for not being supported.
574
"""
575
return True
576
577
def open(self, a_bzrdir, _found=False):
578
"""Return the branch object for a_bzrdir
579
580
_found is a private parameter, do not use it. It is used to indicate
581
if format probing has already be done.
582
"""
583
raise NotImplementedError(self.open)
584
585
@classmethod
586
def register_format(klass, format):
587
klass._formats[format.get_format_string()] = format
588
589
@classmethod
590
def set_default_format(klass, format):
591
klass._default_format = format
592
593
@classmethod
594
def unregister_format(klass, format):
595
assert klass._formats[format.get_format_string()] is format
596
del klass._formats[format.get_format_string()]
597
598
def __str__(self):
599
return self.get_format_string().rstrip()
600
601
602
class BzrBranchFormat4(BranchFormat):
603
"""Bzr branch format 4.
604
605
This format has:
606
- a revision-history file.
607
- a branch-lock lock file [ to be shared with the bzrdir ]
608
"""
609
610
def get_format_description(self):
611
"""See BranchFormat.get_format_description()."""
612
return "Branch format 4"
613
614
def initialize(self, a_bzrdir):
615
"""Create a branch of this format in a_bzrdir."""
616
mutter('creating branch in %s', a_bzrdir.transport.base)
617
branch_transport = a_bzrdir.get_branch_transport(self)
618
utf8_files = [('revision-history', ''),
619
('branch-name', ''),
620
]
621
control_files = LockableFiles(branch_transport, 'branch-lock',
622
TransportLock)
623
control_files.create_lock()
624
control_files.lock_write()
625
try:
626
for file, content in utf8_files:
627
control_files.put_utf8(file, content)
628
finally:
629
control_files.unlock()
630
return self.open(a_bzrdir, _found=True)
631
632
def __init__(self):
633
super(BzrBranchFormat4, self).__init__()
634
self._matchingbzrdir = bzrdir.BzrDirFormat6()
635
636
def open(self, a_bzrdir, _found=False):
637
"""Return the branch object for a_bzrdir
638
639
_found is a private parameter, do not use it. It is used to indicate
640
if format probing has already be done.
641
"""
642
if not _found:
643
# we are being called directly and must probe.
644
raise NotImplementedError
645
return BzrBranch(_format=self,
646
_control_files=a_bzrdir._control_files,
647
a_bzrdir=a_bzrdir,
648
_repository=a_bzrdir.open_repository())
649
650
def __str__(self):
651
return "Bazaar-NG branch format 4"
652
653
654
class BzrBranchFormat5(BranchFormat):
655
"""Bzr branch format 5.
656
657
This format has:
658
- a revision-history file.
659
- a format string
660
- a lock dir guarding the branch itself
661
- all of this stored in a branch/ subdirectory
662
- works with shared repositories.
663
664
This format is new in bzr 0.8.
665
"""
666
667
def get_format_string(self):
668
"""See BranchFormat.get_format_string()."""
669
return "Bazaar-NG branch format 5\n"
670
671
def get_format_description(self):
672
"""See BranchFormat.get_format_description()."""
673
return "Branch format 5"
674
675
def initialize(self, a_bzrdir):
676
"""Create a branch of this format in a_bzrdir."""
677
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
678
branch_transport = a_bzrdir.get_branch_transport(self)
679
utf8_files = [('revision-history', ''),
680
('branch-name', ''),
681
]
682
control_files = LockableFiles(branch_transport, 'lock', LockDir)
683
control_files.create_lock()
684
control_files.lock_write()
685
control_files.put_utf8('format', self.get_format_string())
686
try:
687
for file, content in utf8_files:
688
control_files.put_utf8(file, content)
689
finally:
690
control_files.unlock()
691
return self.open(a_bzrdir, _found=True, )
692
693
def __init__(self):
694
super(BzrBranchFormat5, self).__init__()
695
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
696
697
def open(self, a_bzrdir, _found=False):
698
"""Return the branch object for a_bzrdir
699
700
_found is a private parameter, do not use it. It is used to indicate
701
if format probing has already be done.
702
"""
703
if not _found:
704
format = BranchFormat.find_format(a_bzrdir)
705
assert format.__class__ == self.__class__
706
transport = a_bzrdir.get_branch_transport(None)
707
control_files = LockableFiles(transport, 'lock', LockDir)
708
return BzrBranch5(_format=self,
709
_control_files=control_files,
710
a_bzrdir=a_bzrdir,
711
_repository=a_bzrdir.find_repository())
712
713
def __str__(self):
714
return "Bazaar-NG Metadir branch format 5"
715
716
717
class BranchReferenceFormat(BranchFormat):
718
"""Bzr branch reference format.
719
720
Branch references are used in implementing checkouts, they
721
act as an alias to the real branch which is at some other url.
722
723
This format has:
724
- A location file
725
- a format string
726
"""
727
728
def get_format_string(self):
729
"""See BranchFormat.get_format_string()."""
730
return "Bazaar-NG Branch Reference Format 1\n"
731
732
def get_format_description(self):
733
"""See BranchFormat.get_format_description()."""
734
return "Checkout reference format 1"
735
736
def initialize(self, a_bzrdir, target_branch=None):
737
"""Create a branch of this format in a_bzrdir."""
738
if target_branch is None:
739
# this format does not implement branch itself, thus the implicit
740
# creation contract must see it as uninitializable
741
raise errors.UninitializableFormat(self)
742
mutter('creating branch reference in %s', a_bzrdir.transport.base)
743
branch_transport = a_bzrdir.get_branch_transport(self)
744
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
745
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
746
branch_transport.put('format', StringIO(self.get_format_string()))
747
return self.open(a_bzrdir, _found=True)
748
749
def __init__(self):
750
super(BranchReferenceFormat, self).__init__()
751
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
752
753
def _make_reference_clone_function(format, a_branch):
754
"""Create a clone() routine for a branch dynamically."""
755
def clone(to_bzrdir, revision_id=None):
756
"""See Branch.clone()."""
757
return format.initialize(to_bzrdir, a_branch)
758
# cannot obey revision_id limits when cloning a reference ...
759
# FIXME RBC 20060210 either nuke revision_id for clone, or
760
# emit some sort of warning/error to the caller ?!
761
return clone
762
763
def open(self, a_bzrdir, _found=False):
764
"""Return the branch that the branch reference in a_bzrdir points at.
765
766
_found is a private parameter, do not use it. It is used to indicate
767
if format probing has already be done.
768
"""
769
if not _found:
770
format = BranchFormat.find_format(a_bzrdir)
771
assert format.__class__ == self.__class__
772
transport = a_bzrdir.get_branch_transport(None)
773
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
774
result = real_bzrdir.open_branch()
775
# this changes the behaviour of result.clone to create a new reference
776
# rather than a copy of the content of the branch.
777
# I did not use a proxy object because that needs much more extensive
778
# testing, and we are only changing one behaviour at the moment.
779
# If we decide to alter more behaviours - i.e. the implicit nickname
780
# then this should be refactored to introduce a tested proxy branch
781
# and a subclass of that for use in overriding clone() and ....
782
# - RBC 20060210
783
result.clone = self._make_reference_clone_function(result)
784
return result
785
786
787
# formats which have no format string are not discoverable
788
# and not independently creatable, so are not registered.
789
__default_format = BzrBranchFormat5()
790
BranchFormat.register_format(__default_format)
791
BranchFormat.register_format(BranchReferenceFormat())
792
BranchFormat.set_default_format(__default_format)
793
_legacy_formats = [BzrBranchFormat4(),
794
]
795
796
class BzrBranch(Branch):
797
"""A branch stored in the actual filesystem.
798
799
Note that it's "local" in the context of the filesystem; it doesn't
800
really matter if it's on an nfs/smb/afs/coda/... share, as long as
801
it's writable, and can be accessed via the normal filesystem API.
802
"""
803
804
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
805
relax_version_check=DEPRECATED_PARAMETER, _format=None,
806
_control_files=None, a_bzrdir=None, _repository=None):
807
"""Create new branch object at a particular location.
808
809
transport -- A Transport object, defining how to access files.
810
811
init -- If True, create new control files in a previously
812
unversioned directory. If False, the branch must already
813
be versioned.
814
815
relax_version_check -- If true, the usual check for the branch
816
version is not applied. This is intended only for
817
upgrade/recovery type use; it's not guaranteed that
818
all operations will work on old format branches.
819
"""
820
if a_bzrdir is None:
821
self.bzrdir = bzrdir.BzrDir.open(transport.base)
822
else:
823
self.bzrdir = a_bzrdir
824
self._transport = self.bzrdir.transport.clone('..')
825
self._base = self._transport.base
826
self._format = _format
827
if _control_files is None:
828
raise BzrBadParameterMissing('_control_files')
829
self.control_files = _control_files
830
if deprecated_passed(init):
831
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
832
"deprecated as of bzr 0.8. Please use Branch.create().",
833
DeprecationWarning,
834
stacklevel=2)
835
if init:
836
# this is slower than before deprecation, oh well never mind.
837
# -> its deprecated.
838
self._initialize(transport.base)
839
self._check_format(_format)
840
if deprecated_passed(relax_version_check):
841
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
842
"relax_version_check parameter is deprecated as of bzr 0.8. "
843
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
844
"open() method.",
845
DeprecationWarning,
846
stacklevel=2)
847
if (not relax_version_check
848
and not self._format.is_supported()):
849
raise errors.UnsupportedFormatError(format=fmt)
850
if deprecated_passed(transport):
851
warn("BzrBranch.__init__(transport=XXX...): The transport "
852
"parameter is deprecated as of bzr 0.8. "
853
"Please use Branch.open, or bzrdir.open_branch().",
854
DeprecationWarning,
855
stacklevel=2)
856
self.repository = _repository
857
858
def __str__(self):
859
return '%s(%r)' % (self.__class__.__name__, self.base)
860
861
__repr__ = __str__
862
863
def __del__(self):
864
# TODO: It might be best to do this somewhere else,
865
# but it is nice for a Branch object to automatically
866
# cache it's information.
867
# Alternatively, we could have the Transport objects cache requests
868
# See the earlier discussion about how major objects (like Branch)
869
# should never expect their __del__ function to run.
870
# XXX: cache_root seems to be unused, 2006-01-13 mbp
871
if hasattr(self, 'cache_root') and self.cache_root is not None:
872
try:
873
rmtree(self.cache_root)
874
except:
875
pass
876
self.cache_root = None
877
878
def _get_base(self):
879
return self._base
880
881
base = property(_get_base, doc="The URL for the root of this branch.")
882
883
def _finish_transaction(self):
884
"""Exit the current transaction."""
885
return self.control_files._finish_transaction()
886
887
def get_transaction(self):
888
"""Return the current active transaction.
889
890
If no transaction is active, this returns a passthrough object
891
for which all data is immediately flushed and no caching happens.
892
"""
893
# this is an explicit function so that we can do tricky stuff
894
# when the storage in rev_storage is elsewhere.
895
# we probably need to hook the two 'lock a location' and
896
# 'have a transaction' together more delicately, so that
897
# we can have two locks (branch and storage) and one transaction
898
# ... and finishing the transaction unlocks both, but unlocking
899
# does not. - RBC 20051121
900
return self.control_files.get_transaction()
901
902
def _set_transaction(self, transaction):
903
"""Set a new active transaction."""
904
return self.control_files._set_transaction(transaction)
905
906
def abspath(self, name):
907
"""See Branch.abspath."""
908
return self.control_files._transport.abspath(name)
909
910
def _check_format(self, format):
911
"""Identify the branch format if needed.
912
913
The format is stored as a reference to the format object in
914
self._format for code that needs to check it later.
915
916
The format parameter is either None or the branch format class
917
used to open this branch.
918
919
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
920
"""
921
if format is None:
922
format = BzrBranchFormat.find_format(self.bzrdir)
923
self._format = format
924
mutter("got branch format %s", self._format)
925
926
@needs_read_lock
927
def get_root_id(self):
928
"""See Branch.get_root_id."""
929
tree = self.repository.revision_tree(self.last_revision())
930
return tree.inventory.root.file_id
931
932
def is_locked(self):
933
return self.control_files.is_locked()
934
935
def lock_write(self):
936
# TODO: test for failed two phase locks. This is known broken.
937
self.control_files.lock_write()
938
self.repository.lock_write()
939
940
def lock_read(self):
941
# TODO: test for failed two phase locks. This is known broken.
942
self.control_files.lock_read()
943
self.repository.lock_read()
944
945
def unlock(self):
946
# TODO: test for failed two phase locks. This is known broken.
947
try:
948
self.repository.unlock()
949
finally:
950
self.control_files.unlock()
951
952
def peek_lock_mode(self):
953
if self.control_files._lock_count == 0:
954
return None
955
else:
956
return self.control_files._lock_mode
957
958
def get_physical_lock_status(self):
959
return self.control_files.get_physical_lock_status()
960
961
@needs_read_lock
962
def print_file(self, file, revision_id):
963
"""See Branch.print_file."""
964
return self.repository.print_file(file, revision_id)
965
966
@needs_write_lock
967
def append_revision(self, *revision_ids):
968
"""See Branch.append_revision."""
969
for revision_id in revision_ids:
970
mutter("add {%s} to revision-history" % revision_id)
971
rev_history = self.revision_history()
972
rev_history.extend(revision_ids)
973
self.set_revision_history(rev_history)
974
975
@needs_write_lock
976
def set_revision_history(self, rev_history):
977
"""See Branch.set_revision_history."""
978
self.control_files.put_utf8(
979
'revision-history', '\n'.join(rev_history))
980
transaction = self.get_transaction()
981
history = transaction.map.find_revision_history()
982
if history is not None:
983
# update the revision history in the identity map.
984
history[:] = list(rev_history)
985
# this call is disabled because revision_history is
986
# not really an object yet, and the transaction is for objects.
987
# transaction.register_dirty(history)
988
else:
989
transaction.map.add_revision_history(rev_history)
990
# this call is disabled because revision_history is
991
# not really an object yet, and the transaction is for objects.
992
# transaction.register_clean(history)
993
994
def get_revision_delta(self, revno):
995
"""Return the delta for one revision.
996
997
The delta is relative to its mainline predecessor, or the
998
empty tree for revision 1.
999
"""
1000
assert isinstance(revno, int)
1001
rh = self.revision_history()
1002
if not (1 <= revno <= len(rh)):
1003
raise InvalidRevisionNumber(revno)
1004
1005
# revno is 1-based; list is 0-based
1006
1007
new_tree = self.repository.revision_tree(rh[revno-1])
1008
if revno == 1:
1009
old_tree = EmptyTree()
1010
else:
1011
old_tree = self.repository.revision_tree(rh[revno-2])
1012
return compare_trees(old_tree, new_tree)
1013
1014
@needs_read_lock
1015
def revision_history(self):
1016
"""See Branch.revision_history."""
1017
transaction = self.get_transaction()
1018
history = transaction.map.find_revision_history()
1019
if history is not None:
1020
mutter("cache hit for revision-history in %s", self)
1021
return list(history)
1022
history = [l.rstrip('\r\n') for l in
1023
self.control_files.get_utf8('revision-history').readlines()]
1024
transaction.map.add_revision_history(history)
1025
# this call is disabled because revision_history is
1026
# not really an object yet, and the transaction is for objects.
1027
# transaction.register_clean(history, precious=True)
1028
return list(history)
1029
1030
@needs_write_lock
1031
def update_revisions(self, other, stop_revision=None):
1032
"""See Branch.update_revisions."""
1033
other.lock_read()
1034
try:
1035
if stop_revision is None:
1036
stop_revision = other.last_revision()
1037
if stop_revision is None:
1038
# if there are no commits, we're done.
1039
return
1040
# whats the current last revision, before we fetch [and change it
1041
# possibly]
1042
last_rev = self.last_revision()
1043
# we fetch here regardless of whether we need to so that we pickup
1044
# filled in ghosts.
1045
self.fetch(other, stop_revision)
1046
my_ancestry = self.repository.get_ancestry(last_rev)
1047
if stop_revision in my_ancestry:
1048
# last_revision is a descendant of stop_revision
1049
return
1050
# stop_revision must be a descendant of last_revision
1051
stop_graph = self.repository.get_revision_graph(stop_revision)
1052
if last_rev is not None and last_rev not in stop_graph:
1053
# our previous tip is not merged into stop_revision
1054
raise errors.DivergedBranches(self, other)
1055
# make a new revision history from the graph
1056
current_rev_id = stop_revision
1057
new_history = []
1058
while current_rev_id not in (None, NULL_REVISION):
1059
new_history.append(current_rev_id)
1060
current_rev_id_parents = stop_graph[current_rev_id]
1170
1061
try:
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1172
except OSError, e:
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1175
1176
self._write_inventory(inv)
1177
finally:
1178
self.unlock()
1179
1180
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1183
1184
backups
1185
If true (default) backups are made of files before
1186
they're renamed.
1187
"""
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1191
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1196
1197
nids = []
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1200
if not file_id:
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1205
1206
# TODO: Rename back if it was previously at a different location
1207
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1210
1211
# TODO: Make a backup to a temporary file.
1212
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1215
backup_file(fn)
1216
1217
f = AtomicFile(fn, 'wb')
1218
try:
1219
f.write(old_tree.get_file(file_id).read())
1220
f.commit()
1221
finally:
1222
f.close()
1223
1224
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1227
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1230
"""
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1233
return []
1234
p = []
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1237
return p
1238
1239
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1242
1243
validate_revision_id(revision_id)
1244
1245
p = self.pending_merges()
1246
if revision_id in p:
1247
return
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1250
1251
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1254
self.lock_write()
1255
try:
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1257
try:
1258
for l in rev_list:
1259
print >>f, l
1260
f.commit()
1261
finally:
1262
f.close()
1263
finally:
1264
self.unlock()
1265
1266
1267
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1270
1271
>>> b = ScratchBranch()
1272
>>> isdir(b.base)
1273
True
1274
>>> bd = b.base
1275
>>> b.destroy()
1276
>>> isdir(bd)
1277
False
1278
"""
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1281
1282
This creates a temporary directory and runs init-tree in it.
1283
1284
If any files are listed, they are created in the working copy.
1285
"""
1286
from tempfile import mkdtemp
1287
init = False
1288
if base is None:
1289
base = mkdtemp()
1290
init = True
1291
Branch.__init__(self, base, init=init)
1292
for d in dirs:
1293
os.mkdir(self.abspath(d))
1294
1295
for f in files:
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1297
1298
1299
def clone(self):
1300
"""
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1304
False
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
True
1307
"""
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1310
base = mkdtemp()
1311
os.rmdir(base)
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1314
1315
def __del__(self):
1316
self.destroy()
1317
1318
def destroy(self):
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1321
try:
1322
if self.base:
1323
mutter("delete ScratchBranch %s" % self.base)
1324
rmtree(self.base)
1325
except OSError, e:
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1330
for name in files:
1331
os.chmod(os.path.join(root, name), 0700)
1332
rmtree(self.base)
1333
self.base = None
1334
1062
current_rev_id = current_rev_id_parents[0]
1063
except IndexError:
1064
current_rev_id = None
1065
new_history.reverse()
1066
self.set_revision_history(new_history)
1067
finally:
1068
other.unlock()
1069
1070
def basis_tree(self):
1071
"""See Branch.basis_tree."""
1072
return self.repository.revision_tree(self.last_revision())
1073
1074
@deprecated_method(zero_eight)
1075
def working_tree(self):
1076
"""Create a Working tree object for this branch."""
1077
from bzrlib.workingtree import WorkingTree
1078
from bzrlib.transport.local import LocalTransport
1079
if (self.base.find('://') != -1 or
1080
not isinstance(self._transport, LocalTransport)):
1081
raise NoWorkingTree(self.base)
1082
return self.bzrdir.open_workingtree()
1083
1084
@needs_write_lock
1085
def pull(self, source, overwrite=False, stop_revision=None):
1086
"""See Branch.pull."""
1087
source.lock_read()
1088
try:
1089
old_count = len(self.revision_history())
1090
try:
1091
self.update_revisions(source,stop_revision)
1092
except DivergedBranches:
1093
if not overwrite:
1094
raise
1095
if overwrite:
1096
self.set_revision_history(source.revision_history())
1097
new_count = len(self.revision_history())
1098
return new_count - old_count
1099
finally:
1100
source.unlock()
1101
1102
def get_parent(self):
1103
"""See Branch.get_parent."""
1104
import errno
1105
_locs = ['parent', 'pull', 'x-pull']
1106
for l in _locs:
1107
try:
1108
return self.control_files.get_utf8(l).read().strip('\n')
1109
except NoSuchFile:
1110
pass
1111
return None
1112
1113
def get_push_location(self):
1114
"""See Branch.get_push_location."""
1115
config = bzrlib.config.BranchConfig(self)
1116
push_loc = config.get_user_option('push_location')
1117
return push_loc
1118
1119
def set_push_location(self, location):
1120
"""See Branch.set_push_location."""
1121
config = bzrlib.config.LocationConfig(self.base)
1122
config.set_user_option('push_location', location)
1123
1124
@needs_write_lock
1125
def set_parent(self, url):
1126
"""See Branch.set_parent."""
1127
# TODO: Maybe delete old location files?
1128
# URLs should never be unicode, even on the local fs,
1129
# FIXUP this and get_parent in a future branch format bump:
1130
# read and rewrite the file, and have the new format code read
1131
# using .get not .get_utf8. RBC 20060125
1132
if url is None:
1133
self.control_files._transport.delete('parent')
1134
else:
1135
self.control_files.put_utf8('parent', url + '\n')
1136
1137
def tree_config(self):
1138
return TreeConfig(self)
1139
1140
1141
class BzrBranch5(BzrBranch):
1142
"""A format 5 branch. This supports new features over plan branches.
1143
1144
It has support for a master_branch which is the data for bound branches.
1145
"""
1146
1147
def __init__(self,
1148
_format,
1149
_control_files,
1150
a_bzrdir,
1151
_repository):
1152
super(BzrBranch5, self).__init__(_format=_format,
1153
_control_files=_control_files,
1154
a_bzrdir=a_bzrdir,
1155
_repository=_repository)
1156
1157
@needs_write_lock
1158
def pull(self, source, overwrite=False, stop_revision=None):
1159
"""Updates branch.pull to be bound branch aware."""
1160
bound_location = self.get_bound_location()
1161
if source.base != bound_location:
1162
# not pulling from master, so we need to update master.
1163
master_branch = self.get_master_branch()
1164
if master_branch:
1165
master_branch.pull(source)
1166
source = master_branch
1167
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1168
1169
def get_bound_location(self):
1170
try:
1171
return self.control_files.get_utf8('bound').read()[:-1]
1172
except errors.NoSuchFile:
1173
return None
1174
1175
@needs_read_lock
1176
def get_master_branch(self):
1177
"""Return the branch we are bound to.
1178
1179
:return: Either a Branch, or None
1180
1181
This could memoise the branch, but if thats done
1182
it must be revalidated on each new lock.
1183
So for now we just dont memoise it.
1184
# RBC 20060304 review this decision.
1185
"""
1186
bound_loc = self.get_bound_location()
1187
if not bound_loc:
1188
return None
1189
try:
1190
return Branch.open(bound_loc)
1191
except (errors.NotBranchError, errors.ConnectionError), e:
1192
raise errors.BoundBranchConnectionFailure(
1193
self, bound_loc, e)
1194
1195
@needs_write_lock
1196
def set_bound_location(self, location):
1197
"""Set the target where this branch is bound to.
1198
1199
:param location: URL to the target branch
1200
"""
1201
if location:
1202
self.control_files.put_utf8('bound', location+'\n')
1203
else:
1204
try:
1205
self.control_files._transport.delete('bound')
1206
except NoSuchFile:
1207
return False
1208
return True
1209
1210
@needs_write_lock
1211
def bind(self, other):
1212
"""Bind the local branch the other branch.
1213
1214
:param other: The branch to bind to
1215
:type other: Branch
1216
"""
1217
# TODO: jam 20051230 Consider checking if the target is bound
1218
# It is debatable whether you should be able to bind to
1219
# a branch which is itself bound.
1220
# Committing is obviously forbidden,
1221
# but binding itself may not be.
1222
# Since we *have* to check at commit time, we don't
1223
# *need* to check here
1224
self.pull(other)
1225
1226
# we are now equal to or a suffix of other.
1227
1228
# Since we have 'pulled' from the remote location,
1229
# now we should try to pull in the opposite direction
1230
# in case the local tree has more revisions than the
1231
# remote one.
1232
# There may be a different check you could do here
1233
# rather than actually trying to install revisions remotely.
1234
# TODO: capture an exception which indicates the remote branch
1235
# is not writeable.
1236
# If it is up-to-date, this probably should not be a failure
1237
1238
# lock other for write so the revision-history syncing cannot race
1239
other.lock_write()
1240
try:
1241
other.pull(self)
1242
# if this does not error, other now has the same last rev we do
1243
# it can only error if the pull from other was concurrent with
1244
# a commit to other from someone else.
1245
1246
# until we ditch revision-history, we need to sync them up:
1247
self.set_revision_history(other.revision_history())
1248
# now other and self are up to date with each other and have the
1249
# same revision-history.
1250
finally:
1251
other.unlock()
1252
1253
self.set_bound_location(other.base)
1254
1255
@needs_write_lock
1256
def unbind(self):
1257
"""If bound, unbind"""
1258
return self.set_bound_location(None)
1259
1260
@needs_write_lock
1261
def update(self):
1262
"""Synchronise this branch with the master branch if any.
1263
1264
:return: None or the last_revision that was pivoted out during the
1265
update.
1266
"""
1267
master = self.get_master_branch()
1268
if master is not None:
1269
old_tip = self.last_revision()
1270
self.pull(master, overwrite=True)
1271
if old_tip in self.repository.get_ancestry(self.last_revision()):
1272
return None
1273
return old_tip
1274
return None
1275
1276
1277
class BranchTestProviderAdapter(object):
1278
"""A tool to generate a suite testing multiple branch formats at once.
1279
1280
This is done by copying the test once for each transport and injecting
1281
the transport_server, transport_readonly_server, and branch_format
1282
classes into each copy. Each copy is also given a new id() to make it
1283
easy to identify.
1284
"""
1285
1286
def __init__(self, transport_server, transport_readonly_server, formats):
1287
self._transport_server = transport_server
1288
self._transport_readonly_server = transport_readonly_server
1289
self._formats = formats
1335
1290
1291
def adapt(self, test):
1292
result = TestSuite()
1293
for branch_format, bzrdir_format in self._formats:
1294
new_test = deepcopy(test)
1295
new_test.transport_server = self._transport_server
1296
new_test.transport_readonly_server = self._transport_readonly_server
1297
new_test.bzrdir_format = bzrdir_format
1298
new_test.branch_format = branch_format
1299
def make_new_test_id():
1300
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1301
return lambda: new_id
1302
new_test.id = make_new_test_id()
1303
result.addTest(new_test)
1304
return result
1305
1336
1306
1337
1307
######################################################################
1338
1308
# predicates
1339
1309
1340
1310
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
1311
@deprecated_function(zero_eight)
1312
def ScratchBranch(*args, **kwargs):
1313
"""See bzrlib.bzrdir.ScratchDir."""
1314
d = ScratchDir(*args, **kwargs)
1315
return d.open_branch()
1316
1317
1318
@deprecated_function(zero_eight)
1319
def is_control_file(*args, **kwargs):
1320
"""See bzrlib.workingtree.is_control_file."""
1321
return bzrlib.workingtree.is_control_file(*args, **kwargs)
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0