« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1563.2.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1563.2.1
- Committer: Robert Collins
- Date: 2006-02-22 10:35:05 UTC
- mto: (1594.2.4 integration)
- mto: This revision was merged to the branch mainline in revision 1596.
- Revision ID: robertc@robertcollins.net-20060222103505-bddb211d353f2543
Merge in a variation of the versionedfile api from versioned-file.
- files added:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- tools
- tools/doc_generate
- files removed:
- bzrlib/mdiff.py
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
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
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
from sets import Set
18
from copy import deepcopy
19
from cStringIO import StringIO
20
import errno
21
import os
22
import shutil
23
import sys
24
from unittest import TestSuite
25
from warnings import warn
26
try:
27
import xml.sax.saxutils
28
except ImportError:
29
raise ImportError("We were unable to import 'xml.sax.saxutils',"
30
" most likely you have an xml.pyc or xml.pyo file"
31
" lying around in your bzrlib directory."
32
" Please remove it.")
19
33
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
23
34
24
35
import bzrlib
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
36
from diff import diff_trees
37
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
40
41
42
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
45
46
It is not necessary that f exists.
47
48
Basically we keep looking up until we find the control directory or
49
run into the root."""
50
if f == None:
51
f = os.getcwd()
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
54
else:
55
f = os.path.abspath(f)
56
57
orig_f = f
58
59
while True:
60
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
61
return f
62
head, tail = os.path.split(f)
63
if head == f:
64
# reached the root, whatever that may be
65
raise BzrError('%r is not in a branch' % orig_f)
66
f = head
67
36
import bzrlib.bzrdir as bzrdir
37
from bzrlib.config import TreeConfig
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.delta import compare_trees
40
import bzrlib.errors as errors
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
42
NoSuchRevision, HistoryMissing, NotBranchError,
43
DivergedBranches, LockError,
44
UninitializableFormat,
45
UnlistableStore,
46
UnlistableBranch, NoSuchFile, NotVersionedError,
47
NoWorkingTree)
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles
51
from bzrlib.osutils import (isdir, quotefn,
52
rename, splitpath, sha_file,
53
file_kind, abspath, normpath, pathjoin,
54
safe_unicode,
55
)
56
from bzrlib.textui import show_status
57
from bzrlib.trace import mutter, note
58
from bzrlib.tree import EmptyTree, RevisionTree
59
from bzrlib.repository import Repository
60
from bzrlib.revision import (
61
get_intervening_revisions,
62
is_ancestor,
63
NULL_REVISION,
64
Revision,
65
)
66
from bzrlib.store import copy_all
67
from bzrlib.symbol_versioning import *
68
import bzrlib.transactions as transactions
69
from bzrlib.transport import Transport, get_transport
70
from bzrlib.tree import EmptyTree, RevisionTree
71
import bzrlib.ui
72
import bzrlib.xml5
73
74
75
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
76
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
77
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
78
79
80
# TODO: Maybe include checks for common corruption of newlines, etc?
81
82
# TODO: Some operations like log might retrieve the same revisions
83
# repeatedly to calculate deltas. We could perhaps have a weakref
84
# cache in memory to make this faster. In general anything can be
85
# cached in memory between lock and unlock operations. .. nb thats
86
# what the transaction identity map provides
68
87
69
88
70
89
######################################################################
71
90
# branch objects
72
91
73
class Branch:
92
class Branch(object):
74
93
"""Branch holding a history of revisions.
75
94
76
TODO: Perhaps use different stores for different classes of object,
77
so that we can keep track of how much space each one uses,
78
or garbage-collect them.
79
80
TODO: Add a RemoteBranch subclass. For the basic case of read-only
81
HTTP access this should be very easy by,
82
just redirecting controlfile access into HTTP requests.
83
We would need a RemoteStore working similarly.
84
85
TODO: Keep the on-disk branch locked while the object exists.
86
87
TODO: mkdir() method.
95
base
96
Base directory/url of the branch.
88
97
"""
89
def __init__(self, base, init=False, find_root=True):
90
"""Create new branch object at a particular location.
91
92
base -- Base directory for the branch.
93
94
init -- If True, create new control files in a previously
95
unversioned directory. If False, the branch must already
96
be versioned.
97
98
find_root -- If true and init is false, find the root of the
99
existing branch containing base.
100
101
In the test suite, creation of new trees is tested using the
102
`ScratchBranch` class.
103
"""
104
if init:
105
self.base = os.path.realpath(base)
106
self._make_control()
107
elif find_root:
108
self.base = find_branch_root(base)
109
else:
110
self.base = os.path.realpath(base)
111
if not isdir(self.controlfilename('.')):
112
bailout("not a bzr branch: %s" % quotefn(base),
113
['use "bzr init" to initialize a new working tree',
114
'current bzr can only operate from top-of-tree'])
115
self._check_format()
116
117
self.text_store = ImmutableStore(self.controlfilename('text-store'))
118
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
119
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
120
121
122
def __str__(self):
123
return '%s(%r)' % (self.__class__.__name__, self.base)
124
125
126
__repr__ = __str__
127
98
# this is really an instance variable - FIXME move it there
99
# - RBC 20060112
100
base = None
101
102
def __init__(self, *ignored, **ignored_too):
103
raise NotImplementedError('The Branch class is abstract')
104
105
@staticmethod
106
@deprecated_method(zero_eight)
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format."""
109
return Branch.open(base, _unsupported=True)
110
111
@staticmethod
112
def open(base, _unsupported=False):
113
"""Open the repository rooted at base.
114
115
For instance, if the repository is at URL/.bzr/repository,
116
Repository.open(URL) -> a Repository instance.
117
"""
118
control = bzrdir.BzrDir.open(base, _unsupported)
119
return control.open_branch(_unsupported)
120
121
@staticmethod
122
def open_containing(url):
123
"""Open an existing branch which contains url.
124
125
This probes for a branch at url, and searches upwards from there.
126
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
132
"""
133
control, relpath = bzrdir.BzrDir.open_containing(url)
134
return control.open_branch(), relpath
135
136
@staticmethod
137
@deprecated_function(zero_eight)
138
def initialize(base):
139
"""Create a new working tree and branch, rooted at 'base' (url)
140
141
NOTE: This will soon be deprecated in favour of creation
142
through a BzrDir.
143
"""
144
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
145
146
def setup_caching(self, cache_root):
147
"""Subclasses that care about caching should override this, and set
148
up cached stores located under cache_root.
149
"""
150
# seems to be unused, 2006-01-13 mbp
151
warn('%s is deprecated' % self.setup_caching)
152
self.cache_root = cache_root
153
154
def _get_nick(self):
155
cfg = self.tree_config()
156
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
157
158
def _set_nick(self, nick):
159
cfg = self.tree_config()
160
cfg.set_option(nick, "nickname")
161
assert cfg.get_option("nickname") == nick
162
163
nick = property(_get_nick, _set_nick)
164
165
def lock_write(self):
166
raise NotImplementedError('lock_write is abstract')
167
168
def lock_read(self):
169
raise NotImplementedError('lock_read is abstract')
170
171
def unlock(self):
172
raise NotImplementedError('unlock is abstract')
173
174
def peek_lock_mode(self):
175
"""Return lock mode for the Branch: 'r', 'w' or None"""
176
raise NotImplementedError(self.peek_lock_mode)
128
177
129
178
def abspath(self, name):
130
"""Return absolute filename for something in the branch"""
131
return os.path.join(self.base, name)
132
133
134
def relpath(self, path):
135
"""Return path relative to this branch of something inside it.
136
137
Raises an error if path is not in this branch."""
138
rp = os.path.realpath(path)
139
# FIXME: windows
140
if not rp.startswith(self.base):
141
bailout("path %r is not within branch %r" % (rp, self.base))
142
rp = rp[len(self.base):]
143
rp = rp.lstrip(os.sep)
144
return rp
145
146
147
def controlfilename(self, file_or_path):
148
"""Return location relative to branch."""
149
if isinstance(file_or_path, types.StringTypes):
150
file_or_path = [file_or_path]
151
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
152
153
154
def controlfile(self, file_or_path, mode='r'):
155
"""Open a control file for this branch.
156
157
There are two classes of file in the control directory: text
158
and binary. binary files are untranslated byte streams. Text
159
control files are stored with Unix newlines and in UTF-8, even
160
if the platform or locale defaults are different.
161
"""
162
163
fn = self.controlfilename(file_or_path)
164
165
if mode == 'rb' or mode == 'wb':
166
return file(fn, mode)
167
elif mode == 'r' or mode == 'w':
168
# open in binary mode anyhow so there's no newline translation;
169
# codecs uses line buffering by default; don't want that.
170
import codecs
171
return codecs.open(fn, mode + 'b', 'utf-8',
172
buffering=60000)
173
else:
174
raise BzrError("invalid controlfile mode %r" % mode)
175
176
177
178
def _make_control(self):
179
os.mkdir(self.controlfilename([]))
180
self.controlfile('README', 'w').write(
181
"This is a Bazaar-NG control directory.\n"
182
"Do not change any files in this directory.")
183
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
184
for d in ('text-store', 'inventory-store', 'revision-store'):
185
os.mkdir(self.controlfilename(d))
186
for f in ('revision-history', 'merged-patches',
187
'pending-merged-patches', 'branch-name'):
188
self.controlfile(f, 'w').write('')
189
mutter('created control directory in ' + self.base)
190
Inventory().write_xml(self.controlfile('inventory','w'))
191
192
193
def _check_format(self):
194
"""Check this branch format is supported.
195
196
The current tool only supports the current unstable format.
197
198
In the future, we might need different in-memory Branch
199
classes to support downlevel branches. But not yet.
200
"""
201
# This ignores newlines so that we can open branches created
202
# on Windows from Linux and so on. I think it might be better
203
# to always make all internal files in unix format.
204
fmt = self.controlfile('branch-format', 'r').read()
205
fmt.replace('\r\n', '')
206
if fmt != BZR_BRANCH_FORMAT:
207
bailout('sorry, branch format %r not supported' % fmt,
208
['use a different bzr version',
209
'or remove the .bzr directory and "bzr init" again'])
210
211
212
def read_working_inventory(self):
213
"""Read the working inventory."""
214
before = time.time()
215
# ElementTree does its own conversion from UTF-8, so open in
216
# binary.
217
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
218
mutter("loaded inventory of %d items in %f"
219
% (len(inv), time.time() - before))
220
return inv
221
222
223
def _write_inventory(self, inv):
224
"""Update the working inventory.
225
226
That is to say, the inventory describing changes underway, that
227
will be committed to the next revision.
228
"""
229
## TODO: factor out to atomicfile? is rename safe on windows?
230
## TODO: Maybe some kind of clean/dirty marker on inventory?
231
tmpfname = self.controlfilename('inventory.tmp')
232
tmpf = file(tmpfname, 'wb')
233
inv.write_xml(tmpf)
234
tmpf.close()
235
inv_fname = self.controlfilename('inventory')
236
if sys.platform == 'win32':
237
os.remove(inv_fname)
238
os.rename(tmpfname, inv_fname)
239
mutter('wrote working inventory')
240
241
242
inventory = property(read_working_inventory, _write_inventory, None,
243
"""Inventory for the working copy.""")
244
245
246
def add(self, files, verbose=False):
247
"""Make files versioned.
248
249
Note that the command line normally calls smart_add instead.
250
251
This puts the files in the Added state, so that they will be
252
recorded by the next commit.
253
254
TODO: Perhaps have an option to add the ids even if the files do
255
not (yet) exist.
256
257
TODO: Perhaps return the ids of the files? But then again it
258
is easy to retrieve them if they're needed.
259
260
TODO: Option to specify file id.
261
262
TODO: Adding a directory should optionally recurse down and
263
add all non-ignored children. Perhaps do that in a
264
higher-level method.
265
266
>>> b = ScratchBranch(files=['foo'])
267
>>> 'foo' in b.unknowns()
268
True
269
>>> b.show_status()
270
? foo
271
>>> b.add('foo')
272
>>> 'foo' in b.unknowns()
273
False
274
>>> bool(b.inventory.path2id('foo'))
275
True
276
>>> b.show_status()
277
A foo
278
279
>>> b.add('foo')
280
Traceback (most recent call last):
281
...
282
BzrError: ('foo is already versioned', [])
283
284
>>> b.add(['nothere'])
285
Traceback (most recent call last):
286
BzrError: ('cannot add: not a regular file or directory: nothere', [])
287
"""
288
289
# TODO: Re-adding a file that is removed in the working copy
290
# should probably put it back with the previous ID.
291
if isinstance(files, types.StringTypes):
292
files = [files]
179
"""Return absolute filename for something in the branch
293
180
294
inv = self.read_working_inventory()
295
for f in files:
296
if is_control_file(f):
297
bailout("cannot add control file %s" % quotefn(f))
298
299
fp = splitpath(f)
300
301
if len(fp) == 0:
302
bailout("cannot add top-level %r" % f)
303
304
fullpath = os.path.normpath(self.abspath(f))
305
306
try:
307
kind = file_kind(fullpath)
308
except OSError:
309
# maybe something better?
310
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
311
312
if kind != 'file' and kind != 'directory':
313
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
314
315
file_id = gen_file_id(f)
316
inv.add_path(f, kind=kind, file_id=file_id)
317
318
if verbose:
319
show_status('A', kind, quotefn(f))
320
321
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
322
323
self._write_inventory(inv)
324
325
326
def print_file(self, file, revno):
181
XXX: Robert Collins 20051017 what is this used for? why is it a branch
182
method and not a tree method.
183
"""
184
raise NotImplementedError('abspath is abstract')
185
186
@needs_write_lock
187
def fetch(self, from_branch, last_revision=None, pb=None):
188
"""Copy revisions from from_branch into this branch.
189
190
:param from_branch: Where to copy from.
191
:param last_revision: What revision to stop at (None for at the end
192
of the branch.
193
:param pb: An optional progress bar to use.
194
195
Returns the copied revision count and the failed revisions in a tuple:
196
(copied, failures).
197
"""
198
if self.base == from_branch.base:
199
raise Exception("can't fetch from a branch to itself %s, %s" %
200
(self.base, to_branch.base))
201
if pb is None:
202
pb = bzrlib.ui.ui_factory.progress_bar()
203
204
from_branch.lock_read()
205
try:
206
if last_revision is None:
207
pb.update('get source history')
208
from_history = from_branch.revision_history()
209
if from_history:
210
last_revision = from_history[-1]
211
else:
212
# no history in the source branch
213
last_revision = NULL_REVISION
214
return self.repository.fetch(from_branch.repository,
215
revision_id=last_revision,
216
pb=pb)
217
finally:
218
from_branch.unlock()
219
220
def get_root_id(self):
221
"""Return the id of this branches root"""
222
raise NotImplementedError('get_root_id is abstract')
223
224
def print_file(self, file, revision_id):
327
225
"""Print `file` to stdout."""
328
tree = self.revision_tree(self.lookup_revision(revno))
329
# use inventory as it was in that revision
330
file_id = tree.inventory.path2id(file)
331
if not file_id:
332
bailout("%r is not present in revision %d" % (file, revno))
333
tree.print_file(file_id)
334
335
336
def remove(self, files, verbose=False):
337
"""Mark nominated files for removal from the inventory.
338
339
This does not remove their text. This does not run on
340
341
TODO: Refuse to remove modified files unless --force is given?
342
343
>>> b = ScratchBranch(files=['foo'])
344
>>> b.add('foo')
345
>>> b.inventory.has_filename('foo')
346
True
347
>>> b.remove('foo')
348
>>> b.working_tree().has_filename('foo')
349
True
350
>>> b.inventory.has_filename('foo')
351
False
352
353
>>> b = ScratchBranch(files=['foo'])
354
>>> b.add('foo')
355
>>> b.commit('one')
356
>>> b.remove('foo')
357
>>> b.commit('two')
358
>>> b.inventory.has_filename('foo')
359
False
360
>>> b.basis_tree().has_filename('foo')
361
False
362
>>> b.working_tree().has_filename('foo')
363
True
364
365
TODO: Do something useful with directories.
366
367
TODO: Should this remove the text or not? Tough call; not
368
removing may be useful and the user can just use use rm, and
369
is the opposite of add. Removing it is consistent with most
370
other tools. Maybe an option.
371
"""
372
## TODO: Normalize names
373
## TODO: Remove nested loops; better scalability
374
375
if isinstance(files, types.StringTypes):
376
files = [files]
377
378
tree = self.working_tree()
379
inv = tree.inventory
380
381
# do this before any modifications
382
for f in files:
383
fid = inv.path2id(f)
384
if not fid:
385
bailout("cannot remove unversioned file %s" % quotefn(f))
386
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
387
if verbose:
388
# having remove it, it must be either ignored or unknown
389
if tree.is_ignored(f):
390
new_status = 'I'
391
else:
392
new_status = '?'
393
show_status(new_status, inv[fid].kind, quotefn(f))
394
del inv[fid]
395
396
self._write_inventory(inv)
397
398
399
def unknowns(self):
400
"""Return all unknown files.
401
402
These are files in the working directory that are not versioned or
403
control files or ignored.
404
405
>>> b = ScratchBranch(files=['foo', 'foo~'])
406
>>> list(b.unknowns())
407
['foo']
408
>>> b.add('foo')
409
>>> list(b.unknowns())
410
[]
411
>>> b.remove('foo')
412
>>> list(b.unknowns())
413
['foo']
414
"""
415
return self.working_tree().unknowns()
416
417
418
def commit(self, message, timestamp=None, timezone=None,
419
committer=None,
420
verbose=False):
421
"""Commit working copy as a new revision.
422
423
The basic approach is to add all the file texts into the
424
store, then the inventory, then make a new revision pointing
425
to that inventory and store that.
426
427
This is not quite safe if the working copy changes during the
428
commit; for the moment that is simply not allowed. A better
429
approach is to make a temporary copy of the files before
430
computing their hashes, and then add those hashes in turn to
431
the inventory. This should mean at least that there are no
432
broken hash pointers. There is no way we can get a snapshot
433
of the whole directory at an instant. This would also have to
434
be robust against files disappearing, moving, etc. So the
435
whole thing is a bit hard.
436
437
timestamp -- if not None, seconds-since-epoch for a
438
postdated/predated commit.
439
"""
440
441
## TODO: Show branch names
442
443
# TODO: Don't commit if there are no changes, unless forced?
444
445
# First walk over the working inventory; and both update that
446
# and also build a new revision inventory. The revision
447
# inventory needs to hold the text-id, sha1 and size of the
448
# actual file versions committed in the revision. (These are
449
# not present in the working inventory.) We also need to
450
# detect missing/deleted files, and remove them from the
451
# working inventory.
452
453
work_inv = self.read_working_inventory()
454
inv = Inventory()
455
basis = self.basis_tree()
456
basis_inv = basis.inventory
457
missing_ids = []
458
for path, entry in work_inv.iter_entries():
459
## TODO: Cope with files that have gone missing.
460
461
## TODO: Check that the file kind has not changed from the previous
462
## revision of this file (if any).
463
464
entry = entry.copy()
465
466
p = self.abspath(path)
467
file_id = entry.file_id
468
mutter('commit prep file %s, id %r ' % (p, file_id))
469
470
if not os.path.exists(p):
471
mutter(" file is missing, removing from inventory")
472
if verbose:
473
show_status('D', entry.kind, quotefn(path))
474
missing_ids.append(file_id)
475
continue
476
477
# TODO: Handle files that have been deleted
478
479
# TODO: Maybe a special case for empty files? Seems a
480
# waste to store them many times.
481
482
inv.add(entry)
483
484
if basis_inv.has_id(file_id):
485
old_kind = basis_inv[file_id].kind
486
if old_kind != entry.kind:
487
bailout("entry %r changed kind from %r to %r"
488
% (file_id, old_kind, entry.kind))
489
490
if entry.kind == 'directory':
491
if not isdir(p):
492
bailout("%s is entered as directory but not a directory" % quotefn(p))
493
elif entry.kind == 'file':
494
if not isfile(p):
495
bailout("%s is entered as file but is not a file" % quotefn(p))
496
497
content = file(p, 'rb').read()
498
499
entry.text_sha1 = sha_string(content)
500
entry.text_size = len(content)
501
502
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
503
if (old_ie
504
and (old_ie.text_size == entry.text_size)
505
and (old_ie.text_sha1 == entry.text_sha1)):
506
## assert content == basis.get_file(file_id).read()
507
entry.text_id = basis_inv[file_id].text_id
508
mutter(' unchanged from previous text_id {%s}' %
509
entry.text_id)
510
511
else:
512
entry.text_id = gen_file_id(entry.name)
513
self.text_store.add(content, entry.text_id)
514
mutter(' stored with text_id {%s}' % entry.text_id)
515
if verbose:
516
if not old_ie:
517
state = 'A'
518
elif (old_ie.name == entry.name
519
and old_ie.parent_id == entry.parent_id):
520
state = 'M'
521
else:
522
state = 'R'
523
524
show_status(state, entry.kind, quotefn(path))
525
526
for file_id in missing_ids:
527
# have to do this later so we don't mess up the iterator.
528
# since parents may be removed before their children we
529
# have to test.
530
531
# FIXME: There's probably a better way to do this; perhaps
532
# the workingtree should know how to filter itself.
533
if work_inv.has_id(file_id):
534
del work_inv[file_id]
535
536
537
inv_id = rev_id = _gen_revision_id(time.time())
538
539
inv_tmp = tempfile.TemporaryFile()
540
inv.write_xml(inv_tmp)
541
inv_tmp.seek(0)
542
self.inventory_store.add(inv_tmp, inv_id)
543
mutter('new inventory_id is {%s}' % inv_id)
544
545
self._write_inventory(work_inv)
546
547
if timestamp == None:
548
timestamp = time.time()
549
550
if committer == None:
551
committer = username()
552
553
if timezone == None:
554
timezone = local_time_offset()
555
556
mutter("building commit log message")
557
rev = Revision(timestamp=timestamp,
558
timezone=timezone,
559
committer=committer,
560
precursor = self.last_patch(),
561
message = message,
562
inventory_id=inv_id,
563
revision_id=rev_id)
564
565
rev_tmp = tempfile.TemporaryFile()
566
rev.write_xml(rev_tmp)
567
rev_tmp.seek(0)
568
self.revision_store.add(rev_tmp, rev_id)
569
mutter("new revision_id is {%s}" % rev_id)
570
571
## XXX: Everything up to here can simply be orphaned if we abort
572
## the commit; it will leave junk files behind but that doesn't
573
## matter.
574
575
## TODO: Read back the just-generated changeset, and make sure it
576
## applies and recreates the right state.
577
578
## TODO: Also calculate and store the inventory SHA1
579
mutter("committing patch r%d" % (self.revno() + 1))
580
581
582
self.append_revision(rev_id)
583
584
if verbose:
585
note("commited r%d" % self.revno())
586
587
588
def append_revision(self, revision_id):
589
mutter("add {%s} to revision-history" % revision_id)
590
rev_history = self.revision_history()
591
592
tmprhname = self.controlfilename('revision-history.tmp')
593
rhname = self.controlfilename('revision-history')
594
595
f = file(tmprhname, 'wt')
596
rev_history.append(revision_id)
597
f.write('\n'.join(rev_history))
598
f.write('\n')
599
f.close()
600
601
if sys.platform == 'win32':
602
os.remove(rhname)
603
os.rename(tmprhname, rhname)
604
605
606
607
def get_revision(self, revision_id):
608
"""Return the Revision object for a named revision"""
609
r = Revision.read_xml(self.revision_store[revision_id])
610
assert r.revision_id == revision_id
611
return r
612
613
614
def get_inventory(self, inventory_id):
615
"""Get Inventory object by hash.
616
617
TODO: Perhaps for this and similar methods, take a revision
618
parameter which can be either an integer revno or a
619
string hash."""
620
i = Inventory.read_xml(self.inventory_store[inventory_id])
621
return i
622
623
624
def get_revision_inventory(self, revision_id):
625
"""Return inventory of a past revision."""
626
if revision_id == None:
627
return Inventory()
628
else:
629
return self.get_inventory(self.get_revision(revision_id).inventory_id)
630
226
raise NotImplementedError('print_file is abstract')
227
228
def append_revision(self, *revision_ids):
229
raise NotImplementedError('append_revision is abstract')
230
231
def set_revision_history(self, rev_history):
232
raise NotImplementedError('set_revision_history is abstract')
631
233
632
234
def revision_history(self):
633
"""Return sequence of revision hashes on to this branch.
634
635
>>> ScratchBranch().revision_history()
636
[]
637
"""
638
return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]
639
235
"""Return sequence of revision hashes on to this branch."""
236
raise NotImplementedError('revision_history is abstract')
640
237
641
238
def revno(self):
642
239
"""Return current revision number for this branch.
643
240
644
241
That is equivalent to the number of revisions committed to
645
242
this branch.
646
647
>>> b = ScratchBranch()
648
>>> b.revno()
649
0
650
>>> b.commit('no foo')
651
>>> b.revno()
652
1
653
243
"""
654
244
return len(self.revision_history())
655
245
656
657
def last_patch(self):
658
"""Return last patch hash, or None if no history.
659
660
>>> ScratchBranch().last_patch() == None
661
True
662
"""
246
def last_revision(self):
247
"""Return last patch hash, or None if no history."""
663
248
ph = self.revision_history()
664
249
if ph:
665
250
return ph[-1]
666
251
else:
667
252
return None
668
669
670
def lookup_revision(self, revno):
671
"""Return revision hash for revision number."""
253
254
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
255
"""Return a list of new revisions that would perfectly fit.
256
257
If self and other have not diverged, return a list of the revisions
258
present in other, but missing from self.
259
260
>>> from bzrlib.workingtree import WorkingTree
261
>>> bzrlib.trace.silent = True
262
>>> d1 = bzrdir.ScratchDir()
263
>>> br1 = d1.open_branch()
264
>>> wt1 = d1.open_workingtree()
265
>>> d2 = bzrdir.ScratchDir()
266
>>> br2 = d2.open_branch()
267
>>> wt2 = d2.open_workingtree()
268
>>> br1.missing_revisions(br2)
269
[]
270
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
271
>>> br1.missing_revisions(br2)
272
[u'REVISION-ID-1']
273
>>> br2.missing_revisions(br1)
274
[]
275
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
276
>>> br1.missing_revisions(br2)
277
[]
278
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
279
>>> br1.missing_revisions(br2)
280
[u'REVISION-ID-2A']
281
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
282
>>> br1.missing_revisions(br2)
283
Traceback (most recent call last):
284
DivergedBranches: These branches have diverged. Try merge.
285
"""
286
self_history = self.revision_history()
287
self_len = len(self_history)
288
other_history = other.revision_history()
289
other_len = len(other_history)
290
common_index = min(self_len, other_len) -1
291
if common_index >= 0 and \
292
self_history[common_index] != other_history[common_index]:
293
raise DivergedBranches(self, other)
294
295
if stop_revision is None:
296
stop_revision = other_len
297
else:
298
assert isinstance(stop_revision, int)
299
if stop_revision > other_len:
300
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
301
return other_history[self_len:stop_revision]
302
303
def update_revisions(self, other, stop_revision=None):
304
"""Pull in new perfect-fit revisions."""
305
raise NotImplementedError('update_revisions is abstract')
306
307
def pullable_revisions(self, other, stop_revision):
308
raise NotImplementedError('pullable_revisions is abstract')
309
310
def revision_id_to_revno(self, revision_id):
311
"""Given a revision id, return its revno"""
312
if revision_id is None:
313
return 0
314
history = self.revision_history()
315
try:
316
return history.index(revision_id) + 1
317
except ValueError:
318
raise bzrlib.errors.NoSuchRevision(self, revision_id)
319
320
def get_rev_id(self, revno, history=None):
321
"""Find the revision id of the specified revno."""
672
322
if revno == 0:
673
323
return None
674
675
try:
676
# list is 0-based; revisions are 1-based
677
return self.revision_history()[revno-1]
678
except IndexError:
679
raise BzrError("no such revision %s" % revno)
680
681
682
def revision_tree(self, revision_id):
683
"""Return Tree for a revision on this branch.
684
685
`revision_id` may be None for the null revision, in which case
686
an `EmptyTree` is returned."""
687
688
if revision_id == None:
689
return EmptyTree()
690
else:
691
inv = self.get_revision_inventory(revision_id)
692
return RevisionTree(self.text_store, inv)
693
694
695
def working_tree(self):
696
"""Return a `Tree` for the working copy."""
697
return WorkingTree(self.base, self.read_working_inventory())
698
324
if history is None:
325
history = self.revision_history()
326
elif revno <= 0 or revno > len(history):
327
raise bzrlib.errors.NoSuchRevision(self, revno)
328
return history[revno - 1]
329
330
def pull(self, source, overwrite=False, stop_revision=None):
331
raise NotImplementedError('pull is abstract')
699
332
700
333
def basis_tree(self):
701
334
"""Return `Tree` object for last revision.
702
335
703
336
If there are no revisions yet, return an `EmptyTree`.
704
705
>>> b = ScratchBranch(files=['foo'])
706
>>> b.basis_tree().has_filename('foo')
707
False
708
>>> b.working_tree().has_filename('foo')
709
True
710
>>> b.add('foo')
711
>>> b.commit('add foo')
712
>>> b.basis_tree().has_filename('foo')
713
True
714
337
"""
715
r = self.last_patch()
716
if r == None:
717
return EmptyTree()
718
else:
719
return RevisionTree(self.text_store, self.get_revision_inventory(r))
720
721
722
723
def write_log(self, show_timezone='original', verbose=False):
724
"""Write out human-readable log of commits to this branch
725
726
utc -- If true, show dates in universal time, not local time."""
727
## TODO: Option to choose either original, utc or local timezone
728
revno = 1
729
precursor = None
730
for p in self.revision_history():
731
print '-' * 40
732
print 'revno:', revno
733
## TODO: Show hash if --id is given.
734
##print 'revision-hash:', p
735
rev = self.get_revision(p)
736
print 'committer:', rev.committer
737
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
738
show_timezone))
739
740
## opportunistic consistency check, same as check_patch_chaining
741
if rev.precursor != precursor:
742
bailout("mismatched precursor!")
743
744
print 'message:'
745
if not rev.message:
746
print ' (no message)'
747
else:
748
for l in rev.message.split('\n'):
749
print ' ' + l
750
751
if verbose == True and precursor != None:
752
print 'changed files:'
753
tree = self.revision_tree(p)
754
prevtree = self.revision_tree(precursor)
755
756
for file_state, fid, old_name, new_name, kind in \
757
diff_trees(prevtree, tree, ):
758
if file_state == 'A' or file_state == 'M':
759
show_status(file_state, kind, new_name)
760
elif file_state == 'D':
761
show_status(file_state, kind, old_name)
762
elif file_state == 'R':
763
show_status(file_state, kind,
764
old_name + ' => ' + new_name)
765
766
revno += 1
767
precursor = p
768
338
return self.repository.revision_tree(self.last_revision())
769
339
770
340
def rename_one(self, from_rel, to_rel):
771
tree = self.working_tree()
772
inv = tree.inventory
773
if not tree.has_filename(from_rel):
774
bailout("can't rename: old working file %r does not exist" % from_rel)
775
if tree.has_filename(to_rel):
776
bailout("can't rename: new working file %r already exists" % to_rel)
777
778
file_id = inv.path2id(from_rel)
779
if file_id == None:
780
bailout("can't rename: old name %r is not versioned" % from_rel)
781
782
if inv.path2id(to_rel):
783
bailout("can't rename: new name %r is already versioned" % to_rel)
784
785
to_dir, to_tail = os.path.split(to_rel)
786
to_dir_id = inv.path2id(to_dir)
787
if to_dir_id == None and to_dir != '':
788
bailout("can't determine destination directory id for %r" % to_dir)
789
790
mutter("rename_one:")
791
mutter(" file_id {%s}" % file_id)
792
mutter(" from_rel %r" % from_rel)
793
mutter(" to_rel %r" % to_rel)
794
mutter(" to_dir %r" % to_dir)
795
mutter(" to_dir_id {%s}" % to_dir_id)
796
797
inv.rename(file_id, to_dir_id, to_tail)
798
799
print "%s => %s" % (from_rel, to_rel)
800
801
from_abs = self.abspath(from_rel)
802
to_abs = self.abspath(to_rel)
803
try:
804
os.rename(from_abs, to_abs)
805
except OSError, e:
806
bailout("failed to rename %r to %r: %s"
807
% (from_abs, to_abs, e[1]),
808
["rename rolled back"])
809
810
self._write_inventory(inv)
811
812
341
"""Rename one file.
342
343
This can change the directory or the filename or both.
344
"""
345
raise NotImplementedError('rename_one is abstract')
813
346
814
347
def move(self, from_paths, to_name):
815
348
"""Rename files.
821
354
822
355
Note that to_name is only the last component of the new name;
823
356
this doesn't change the directory.
824
"""
825
## TODO: Option to move IDs only
826
assert not isinstance(from_paths, basestring)
827
tree = self.working_tree()
828
inv = tree.inventory
829
to_abs = self.abspath(to_name)
830
if not isdir(to_abs):
831
bailout("destination %r is not a directory" % to_abs)
832
if not tree.has_filename(to_name):
833
bailout("destination %r not in working directory" % to_abs)
834
to_dir_id = inv.path2id(to_name)
835
if to_dir_id == None and to_name != '':
836
bailout("destination %r is not a versioned directory" % to_name)
837
to_dir_ie = inv[to_dir_id]
838
if to_dir_ie.kind not in ('directory', 'root_directory'):
839
bailout("destination %r is not a directory" % to_abs)
840
841
to_idpath = Set(inv.get_idpath(to_dir_id))
842
843
for f in from_paths:
844
if not tree.has_filename(f):
845
bailout("%r does not exist in working tree" % f)
846
f_id = inv.path2id(f)
847
if f_id == None:
848
bailout("%r is not versioned" % f)
849
name_tail = splitpath(f)[-1]
850
dest_path = appendpath(to_name, name_tail)
851
if tree.has_filename(dest_path):
852
bailout("destination %r already exists" % dest_path)
853
if f_id in to_idpath:
854
bailout("can't move %r to a subdirectory of itself" % f)
855
856
# OK, so there's a race here, it's possible that someone will
857
# create a file in this interval and then the rename might be
858
# left half-done. But we should have caught most problems.
859
860
for f in from_paths:
861
name_tail = splitpath(f)[-1]
862
dest_path = appendpath(to_name, name_tail)
863
print "%s => %s" % (f, dest_path)
864
inv.rename(inv.path2id(f), to_dir_id, name_tail)
357
358
This returns a list of (from_path, to_path) pairs for each
359
entry that is moved.
360
"""
361
raise NotImplementedError('move is abstract')
362
363
def get_parent(self):
364
"""Return the parent location of the branch.
365
366
This is the default location for push/pull/missing. The usual
367
pattern is that the user can override it by specifying a
368
location.
369
"""
370
raise NotImplementedError('get_parent is abstract')
371
372
def get_push_location(self):
373
"""Return the None or the location to push this branch to."""
374
raise NotImplementedError('get_push_location is abstract')
375
376
def set_push_location(self, location):
377
"""Set a new push location for this branch."""
378
raise NotImplementedError('set_push_location is abstract')
379
380
def set_parent(self, url):
381
raise NotImplementedError('set_parent is abstract')
382
383
def check_revno(self, revno):
384
"""\
385
Check whether a revno corresponds to any revision.
386
Zero (the NULL revision) is considered valid.
387
"""
388
if revno != 0:
389
self.check_real_revno(revno)
390
391
def check_real_revno(self, revno):
392
"""\
393
Check whether a revno corresponds to a real revision.
394
Zero (the NULL revision) is considered invalid
395
"""
396
if revno < 1 or revno > self.revno():
397
raise InvalidRevisionNumber(revno)
398
399
@needs_read_lock
400
def clone(self, *args, **kwargs):
401
"""Clone this branch into to_bzrdir preserving all semantic values.
402
403
revision_id: if not None, the revision history in the new branch will
404
be truncated to end with revision_id.
405
"""
406
# for API compatability, until 0.8 releases we provide the old api:
407
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
408
# after 0.8 releases, the *args and **kwargs should be changed:
409
# def clone(self, to_bzrdir, revision_id=None):
410
if (kwargs.get('to_location', None) or
411
kwargs.get('revision', None) or
412
kwargs.get('basis_branch', None) or
413
(len(args) and isinstance(args[0], basestring))):
414
# backwards compatability api:
415
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
416
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
417
# get basis_branch
418
if len(args) > 2:
419
basis_branch = args[2]
420
else:
421
basis_branch = kwargs.get('basis_branch', None)
422
if basis_branch:
423
basis = basis_branch.bzrdir
424
else:
425
basis = None
426
# get revision
427
if len(args) > 1:
428
revision_id = args[1]
429
else:
430
revision_id = kwargs.get('revision', None)
431
# get location
432
if len(args):
433
url = args[0]
434
else:
435
# no default to raise if not provided.
436
url = kwargs.get('to_location')
437
return self.bzrdir.clone(url,
438
revision_id=revision_id,
439
basis=basis).open_branch()
440
# new cleaner api.
441
# generate args by hand
442
if len(args) > 1:
443
revision_id = args[1]
444
else:
445
revision_id = kwargs.get('revision_id', None)
446
if len(args):
447
to_bzrdir = args[0]
448
else:
449
# no default to raise if not provided.
450
to_bzrdir = kwargs.get('to_bzrdir')
451
result = self._format.initialize(to_bzrdir)
452
self.copy_content_into(result, revision_id=revision_id)
453
return result
454
455
@needs_read_lock
456
def sprout(self, to_bzrdir, revision_id=None):
457
"""Create a new line of development from the branch, into to_bzrdir.
458
459
revision_id: if not None, the revision history in the new branch will
460
be truncated to end with revision_id.
461
"""
462
result = self._format.initialize(to_bzrdir)
463
self.copy_content_into(result, revision_id=revision_id)
464
result.set_parent(self.bzrdir.root_transport.base)
465
return result
466
467
@needs_read_lock
468
def copy_content_into(self, destination, revision_id=None):
469
"""Copy the content of self into destination.
470
471
revision_id: if not None, the revision history in the new branch will
472
be truncated to end with revision_id.
473
"""
474
new_history = self.revision_history()
475
if revision_id is not None:
865
476
try:
866
os.rename(self.abspath(f), self.abspath(dest_path))
867
except OSError, e:
868
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
869
["rename rolled back"])
870
871
self._write_inventory(inv)
872
873
874
875
def show_status(self, show_all=False):
876
"""Display single-line status for non-ignored working files.
877
878
The list is show sorted in order by file name.
879
880
>>> b = ScratchBranch(files=['foo', 'foo~'])
881
>>> b.show_status()
882
? foo
883
>>> b.add('foo')
884
>>> b.show_status()
885
A foo
886
>>> b.commit("add foo")
887
>>> b.show_status()
888
>>> os.unlink(b.abspath('foo'))
889
>>> b.show_status()
890
D foo
891
892
TODO: Get state for single files.
893
"""
894
895
# We have to build everything into a list first so that it can
896
# sorted by name, incorporating all the different sources.
897
898
# FIXME: Rather than getting things in random order and then sorting,
899
# just step through in order.
900
901
# Interesting case: the old ID for a file has been removed,
902
# but a new file has been created under that name.
903
904
old = self.basis_tree()
905
new = self.working_tree()
906
907
for fs, fid, oldname, newname, kind in diff_trees(old, new):
908
if fs == 'R':
909
show_status(fs, kind,
910
oldname + ' => ' + newname)
911
elif fs == 'A' or fs == 'M':
912
show_status(fs, kind, newname)
913
elif fs == 'D':
914
show_status(fs, kind, oldname)
915
elif fs == '.':
916
if show_all:
917
show_status(fs, kind, newname)
918
elif fs == 'I':
919
if show_all:
920
show_status(fs, kind, newname)
921
elif fs == '?':
922
show_status(fs, kind, newname)
923
else:
924
bailout("weird file state %r" % ((fs, fid),))
925
926
927
928
class ScratchBranch(Branch):
929
"""Special test class: a branch that cleans up after itself.
930
931
>>> b = ScratchBranch()
932
>>> isdir(b.base)
933
True
934
>>> bd = b.base
935
>>> del b
936
>>> isdir(bd)
937
False
938
"""
939
def __init__(self, files=[], dirs=[]):
940
"""Make a test branch.
941
942
This creates a temporary directory and runs init-tree in it.
943
944
If any files are listed, they are created in the working copy.
945
"""
946
Branch.__init__(self, tempfile.mkdtemp(), init=True)
947
for d in dirs:
948
os.mkdir(self.abspath(d))
949
950
for f in files:
951
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
952
477
new_history = new_history[:new_history.index(revision_id) + 1]
478
except ValueError:
479
rev = self.repository.get_revision(revision_id)
480
new_history = rev.get_history(self.repository)[1:]
481
destination.set_revision_history(new_history)
482
parent = self.get_parent()
483
if parent:
484
destination.set_parent(parent)
485
486
487
class BranchFormat(object):
488
"""An encapsulation of the initialization and open routines for a format.
489
490
Formats provide three things:
491
* An initialization routine,
492
* a format string,
493
* an open routine.
494
495
Formats are placed in an dict by their format string for reference
496
during branch opening. Its not required that these be instances, they
497
can be classes themselves with class methods - it simply depends on
498
whether state is needed for a given format or not.
499
500
Once a format is deprecated, just deprecate the initialize and open
501
methods on the format class. Do not deprecate the object, as the
502
object will be created every time regardless.
503
"""
504
505
_default_format = None
506
"""The default format used for new branches."""
507
508
_formats = {}
509
"""The known formats."""
510
511
@classmethod
512
def find_format(klass, a_bzrdir):
513
"""Return the format for the branch object in a_bzrdir."""
514
try:
515
transport = a_bzrdir.get_branch_transport(None)
516
format_string = transport.get("format").read()
517
return klass._formats[format_string]
518
except NoSuchFile:
519
raise NotBranchError(path=transport.base)
520
except KeyError:
521
raise errors.UnknownFormatError(format_string)
522
523
@classmethod
524
def get_default_format(klass):
525
"""Return the current default format."""
526
return klass._default_format
527
528
def get_format_string(self):
529
"""Return the ASCII format string that identifies this format."""
530
raise NotImplementedError(self.get_format_string)
531
532
def initialize(self, a_bzrdir):
533
"""Create a branch of this format in a_bzrdir."""
534
raise NotImplementedError(self.initialized)
535
536
def is_supported(self):
537
"""Is this format supported?
538
539
Supported formats can be initialized and opened.
540
Unsupported formats may not support initialization or committing or
541
some other features depending on the reason for not being supported.
542
"""
543
return True
544
545
def open(self, a_bzrdir, _found=False):
546
"""Return the branch object for a_bzrdir
547
548
_found is a private parameter, do not use it. It is used to indicate
549
if format probing has already be done.
550
"""
551
raise NotImplementedError(self.open)
552
553
@classmethod
554
def register_format(klass, format):
555
klass._formats[format.get_format_string()] = format
556
557
@classmethod
558
def set_default_format(klass, format):
559
klass._default_format = format
560
561
@classmethod
562
def unregister_format(klass, format):
563
assert klass._formats[format.get_format_string()] is format
564
del klass._formats[format.get_format_string()]
565
566
567
class BzrBranchFormat4(BranchFormat):
568
"""Bzr branch format 4.
569
570
This format has:
571
- a revision-history file.
572
- a branch-lock lock file [ to be shared with the bzrdir ]
573
"""
574
575
def initialize(self, a_bzrdir):
576
"""Create a branch of this format in a_bzrdir."""
577
mutter('creating branch in %s', a_bzrdir.transport.base)
578
branch_transport = a_bzrdir.get_branch_transport(self)
579
utf8_files = [('revision-history', ''),
580
('branch-name', ''),
581
]
582
control_files = LockableFiles(branch_transport, 'branch-lock')
583
control_files.lock_write()
584
try:
585
for file, content in utf8_files:
586
control_files.put_utf8(file, content)
587
finally:
588
control_files.unlock()
589
return self.open(a_bzrdir, _found=True)
590
591
def __init__(self):
592
super(BzrBranchFormat4, self).__init__()
593
self._matchingbzrdir = bzrdir.BzrDirFormat6()
594
595
def open(self, a_bzrdir, _found=False):
596
"""Return the branch object for a_bzrdir
597
598
_found is a private parameter, do not use it. It is used to indicate
599
if format probing has already be done.
600
"""
601
if not _found:
602
# we are being called directly and must probe.
603
raise NotImplementedError
604
return BzrBranch(_format=self,
605
_control_files=a_bzrdir._control_files,
606
a_bzrdir=a_bzrdir,
607
_repository=a_bzrdir.open_repository())
608
609
610
class BzrBranchFormat5(BranchFormat):
611
"""Bzr branch format 5.
612
613
This format has:
614
- a revision-history file.
615
- a format string
616
- a lock file.
617
- works with shared repositories.
618
"""
619
620
def get_format_string(self):
621
"""See BranchFormat.get_format_string()."""
622
return "Bazaar-NG branch format 5\n"
623
624
def initialize(self, a_bzrdir):
625
"""Create a branch of this format in a_bzrdir."""
626
mutter('creating branch in %s', a_bzrdir.transport.base)
627
branch_transport = a_bzrdir.get_branch_transport(self)
628
629
utf8_files = [('revision-history', ''),
630
('branch-name', ''),
631
]
632
lock_file = 'lock'
633
branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
634
control_files = LockableFiles(branch_transport, 'lock')
635
control_files.lock_write()
636
control_files.put_utf8('format', self.get_format_string())
637
try:
638
for file, content in utf8_files:
639
control_files.put_utf8(file, content)
640
finally:
641
control_files.unlock()
642
return self.open(a_bzrdir, _found=True, )
643
644
def __init__(self):
645
super(BzrBranchFormat5, self).__init__()
646
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
647
648
def open(self, a_bzrdir, _found=False):
649
"""Return the branch object for a_bzrdir
650
651
_found is a private parameter, do not use it. It is used to indicate
652
if format probing has already be done.
653
"""
654
if not _found:
655
format = BranchFormat.find_format(a_bzrdir)
656
assert format.__class__ == self.__class__
657
transport = a_bzrdir.get_branch_transport(None)
658
control_files = LockableFiles(transport, 'lock')
659
return BzrBranch(_format=self,
660
_control_files=control_files,
661
a_bzrdir=a_bzrdir,
662
_repository=a_bzrdir.find_repository())
663
664
665
class BranchReferenceFormat(BranchFormat):
666
"""Bzr branch reference format.
667
668
Branch references are used in implementing checkouts, they
669
act as an alias to the real branch which is at some other url.
670
671
This format has:
672
- A location file
673
- a format string
674
"""
675
676
def get_format_string(self):
677
"""See BranchFormat.get_format_string()."""
678
return "Bazaar-NG Branch Reference Format 1\n"
679
680
def initialize(self, a_bzrdir, target_branch=None):
681
"""Create a branch of this format in a_bzrdir."""
682
if target_branch is None:
683
# this format does not implement branch itself, thus the implicit
684
# creation contract must see it as uninitializable
685
raise errors.UninitializableFormat(self)
686
mutter('creating branch reference in %s', a_bzrdir.transport.base)
687
branch_transport = a_bzrdir.get_branch_transport(self)
688
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
689
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
690
branch_transport.put('format', StringIO(self.get_format_string()))
691
return self.open(a_bzrdir, _found=True)
692
693
def __init__(self):
694
super(BranchReferenceFormat, self).__init__()
695
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
696
697
def _make_reference_clone_function(format, a_branch):
698
"""Create a clone() routine for a branch dynamically."""
699
def clone(to_bzrdir, revision_id=None):
700
"""See Branch.clone()."""
701
return format.initialize(to_bzrdir, a_branch)
702
# cannot obey revision_id limits when cloning a reference ...
703
# FIXME RBC 20060210 either nuke revision_id for clone, or
704
# emit some sort of warning/error to the caller ?!
705
return clone
706
707
def open(self, a_bzrdir, _found=False):
708
"""Return the branch that the branch reference in a_bzrdir points at.
709
710
_found is a private parameter, do not use it. It is used to indicate
711
if format probing has already be done.
712
"""
713
if not _found:
714
format = BranchFormat.find_format(a_bzrdir)
715
assert format.__class__ == self.__class__
716
transport = a_bzrdir.get_branch_transport(None)
717
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
718
result = real_bzrdir.open_branch()
719
# this changes the behaviour of result.clone to create a new reference
720
# rather than a copy of the content of the branch.
721
# I did not use a proxy object because that needs much more extensive
722
# testing, and we are only changing one behaviour at the moment.
723
# If we decide to alter more behaviours - i.e. the implicit nickname
724
# then this should be refactored to introduce a tested proxy branch
725
# and a subclass of that for use in overriding clone() and ....
726
# - RBC 20060210
727
result.clone = self._make_reference_clone_function(result)
728
return result
729
730
731
# formats which have no format string are not discoverable
732
# and not independently creatable, so are not registered.
733
__default_format = BzrBranchFormat5()
734
BranchFormat.register_format(__default_format)
735
BranchFormat.register_format(BranchReferenceFormat())
736
BranchFormat.set_default_format(__default_format)
737
_legacy_formats = [BzrBranchFormat4(),
738
]
739
740
class BzrBranch(Branch):
741
"""A branch stored in the actual filesystem.
742
743
Note that it's "local" in the context of the filesystem; it doesn't
744
really matter if it's on an nfs/smb/afs/coda/... share, as long as
745
it's writable, and can be accessed via the normal filesystem API.
746
"""
747
# We actually expect this class to be somewhat short-lived; part of its
748
# purpose is to try to isolate what bits of the branch logic are tied to
749
# filesystem access, so that in a later step, we can extricate them to
750
# a separarte ("storage") class.
751
_inventory_weave = None
752
753
# Map some sort of prefix into a namespace
754
# stuff like "revno:10", "revid:", etc.
755
# This should match a prefix with a function which accepts
756
REVISION_NAMESPACES = {}
757
758
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
759
relax_version_check=DEPRECATED_PARAMETER, _format=None,
760
_control_files=None, a_bzrdir=None, _repository=None):
761
"""Create new branch object at a particular location.
762
763
transport -- A Transport object, defining how to access files.
764
765
init -- If True, create new control files in a previously
766
unversioned directory. If False, the branch must already
767
be versioned.
768
769
relax_version_check -- If true, the usual check for the branch
770
version is not applied. This is intended only for
771
upgrade/recovery type use; it's not guaranteed that
772
all operations will work on old format branches.
773
"""
774
if a_bzrdir is None:
775
self.bzrdir = bzrdir.BzrDir.open(transport.base)
776
else:
777
self.bzrdir = a_bzrdir
778
self._transport = self.bzrdir.transport.clone('..')
779
self._base = self._transport.base
780
self._format = _format
781
if _control_files is None:
782
raise BzrBadParameterMissing('_control_files')
783
self.control_files = _control_files
784
if deprecated_passed(init):
785
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
786
"deprecated as of bzr 0.8. Please use Branch.create().",
787
DeprecationWarning,
788
stacklevel=2)
789
if init:
790
# this is slower than before deprecation, oh well never mind.
791
# -> its deprecated.
792
self._initialize(transport.base)
793
self._check_format(_format)
794
if deprecated_passed(relax_version_check):
795
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
796
"relax_version_check parameter is deprecated as of bzr 0.8. "
797
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
798
"open() method.",
799
DeprecationWarning,
800
stacklevel=2)
801
if (not relax_version_check
802
and not self._format.is_supported()):
803
raise errors.UnsupportedFormatError(
804
'sorry, branch format %r not supported' % fmt,
805
['use a different bzr version',
806
'or remove the .bzr directory'
807
' and "bzr init" again'])
808
if deprecated_passed(transport):
809
warn("BzrBranch.__init__(transport=XXX...): The transport "
810
"parameter is deprecated as of bzr 0.8. "
811
"Please use Branch.open, or bzrdir.open_branch().",
812
DeprecationWarning,
813
stacklevel=2)
814
self.repository = _repository
815
816
def __str__(self):
817
return '%s(%r)' % (self.__class__.__name__, self.base)
818
819
__repr__ = __str__
953
820
954
821
def __del__(self):
955
"""Destroy the test branch, removing the scratch directory."""
956
try:
957
shutil.rmtree(self.base)
958
except OSError:
959
# Work around for shutil.rmtree failing on Windows when
960
# readonly files are encountered
961
for root, dirs, files in os.walk(self.base, topdown=False):
962
for name in files:
963
os.chmod(os.path.join(root, name), 0700)
964
shutil.rmtree(self.base)
965
822
# TODO: It might be best to do this somewhere else,
823
# but it is nice for a Branch object to automatically
824
# cache it's information.
825
# Alternatively, we could have the Transport objects cache requests
826
# See the earlier discussion about how major objects (like Branch)
827
# should never expect their __del__ function to run.
828
# XXX: cache_root seems to be unused, 2006-01-13 mbp
829
if hasattr(self, 'cache_root') and self.cache_root is not None:
830
try:
831
shutil.rmtree(self.cache_root)
832
except:
833
pass
834
self.cache_root = None
835
836
def _get_base(self):
837
return self._base
838
839
base = property(_get_base, doc="The URL for the root of this branch.")
840
841
def _finish_transaction(self):
842
"""Exit the current transaction."""
843
return self.control_files._finish_transaction()
844
845
def get_transaction(self):
846
"""Return the current active transaction.
847
848
If no transaction is active, this returns a passthrough object
849
for which all data is immediately flushed and no caching happens.
850
"""
851
# this is an explicit function so that we can do tricky stuff
852
# when the storage in rev_storage is elsewhere.
853
# we probably need to hook the two 'lock a location' and
854
# 'have a transaction' together more delicately, so that
855
# we can have two locks (branch and storage) and one transaction
856
# ... and finishing the transaction unlocks both, but unlocking
857
# does not. - RBC 20051121
858
return self.control_files.get_transaction()
859
860
def _set_transaction(self, transaction):
861
"""Set a new active transaction."""
862
return self.control_files._set_transaction(transaction)
863
864
def abspath(self, name):
865
"""See Branch.abspath."""
866
return self.control_files._transport.abspath(name)
867
868
def _check_format(self, format):
869
"""Identify the branch format if needed.
870
871
The format is stored as a reference to the format object in
872
self._format for code that needs to check it later.
873
874
The format parameter is either None or the branch format class
875
used to open this branch.
876
877
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
878
"""
879
if format is None:
880
format = BzrBranchFormat.find_format(self.bzrdir)
881
self._format = format
882
mutter("got branch format %s", self._format)
883
884
@needs_read_lock
885
def get_root_id(self):
886
"""See Branch.get_root_id."""
887
tree = self.repository.revision_tree(self.last_revision())
888
return tree.inventory.root.file_id
889
890
def lock_write(self):
891
# TODO: test for failed two phase locks. This is known broken.
892
self.control_files.lock_write()
893
self.repository.lock_write()
894
895
def lock_read(self):
896
# TODO: test for failed two phase locks. This is known broken.
897
self.control_files.lock_read()
898
self.repository.lock_read()
899
900
def unlock(self):
901
# TODO: test for failed two phase locks. This is known broken.
902
self.repository.unlock()
903
self.control_files.unlock()
904
905
def peek_lock_mode(self):
906
if self.control_files._lock_count == 0:
907
return None
908
else:
909
return self.control_files._lock_mode
910
911
@needs_read_lock
912
def print_file(self, file, revision_id):
913
"""See Branch.print_file."""
914
return self.repository.print_file(file, revision_id)
915
916
@needs_write_lock
917
def append_revision(self, *revision_ids):
918
"""See Branch.append_revision."""
919
for revision_id in revision_ids:
920
mutter("add {%s} to revision-history" % revision_id)
921
rev_history = self.revision_history()
922
rev_history.extend(revision_ids)
923
self.set_revision_history(rev_history)
924
925
@needs_write_lock
926
def set_revision_history(self, rev_history):
927
"""See Branch.set_revision_history."""
928
self.control_files.put_utf8(
929
'revision-history', '\n'.join(rev_history))
930
931
def get_revision_delta(self, revno):
932
"""Return the delta for one revision.
933
934
The delta is relative to its mainline predecessor, or the
935
empty tree for revision 1.
936
"""
937
assert isinstance(revno, int)
938
rh = self.revision_history()
939
if not (1 <= revno <= len(rh)):
940
raise InvalidRevisionNumber(revno)
941
942
# revno is 1-based; list is 0-based
943
944
new_tree = self.repository.revision_tree(rh[revno-1])
945
if revno == 1:
946
old_tree = EmptyTree()
947
else:
948
old_tree = self.repository.revision_tree(rh[revno-2])
949
return compare_trees(old_tree, new_tree)
950
951
@needs_read_lock
952
def revision_history(self):
953
"""See Branch.revision_history."""
954
# FIXME are transactions bound to control files ? RBC 20051121
955
transaction = self.get_transaction()
956
history = transaction.map.find_revision_history()
957
if history is not None:
958
mutter("cache hit for revision-history in %s", self)
959
return list(history)
960
history = [l.rstrip('\r\n') for l in
961
self.control_files.get_utf8('revision-history').readlines()]
962
transaction.map.add_revision_history(history)
963
# this call is disabled because revision_history is
964
# not really an object yet, and the transaction is for objects.
965
# transaction.register_clean(history, precious=True)
966
return list(history)
967
968
def update_revisions(self, other, stop_revision=None):
969
"""See Branch.update_revisions."""
970
if stop_revision is None:
971
stop_revision = other.last_revision()
972
### Should this be checking is_ancestor instead of revision_history?
973
if (stop_revision is not None and
974
stop_revision in self.revision_history()):
975
return
976
self.fetch(other, stop_revision)
977
pullable_revs = self.pullable_revisions(other, stop_revision)
978
if len(pullable_revs) > 0:
979
self.append_revision(*pullable_revs)
980
981
def pullable_revisions(self, other, stop_revision):
982
"""See Branch.pullable_revisions."""
983
other_revno = other.revision_id_to_revno(stop_revision)
984
try:
985
return self.missing_revisions(other, other_revno)
986
except DivergedBranches, e:
987
try:
988
pullable_revs = get_intervening_revisions(self.last_revision(),
989
stop_revision,
990
self.repository)
991
assert self.last_revision() not in pullable_revs
992
return pullable_revs
993
except bzrlib.errors.NotAncestor:
994
if is_ancestor(self.last_revision(), stop_revision, self):
995
return []
996
else:
997
raise e
998
999
def basis_tree(self):
1000
"""See Branch.basis_tree."""
1001
return self.repository.revision_tree(self.last_revision())
1002
1003
@deprecated_method(zero_eight)
1004
def working_tree(self):
1005
"""Create a Working tree object for this branch."""
1006
from bzrlib.workingtree import WorkingTree
1007
from bzrlib.transport.local import LocalTransport
1008
if (self.base.find('://') != -1 or
1009
not isinstance(self._transport, LocalTransport)):
1010
raise NoWorkingTree(self.base)
1011
return self.bzrdir.open_workingtree()
1012
1013
@needs_write_lock
1014
def pull(self, source, overwrite=False, stop_revision=None):
1015
"""See Branch.pull."""
1016
source.lock_read()
1017
try:
1018
old_count = len(self.revision_history())
1019
try:
1020
self.update_revisions(source,stop_revision)
1021
except DivergedBranches:
1022
if not overwrite:
1023
raise
1024
if overwrite:
1025
self.set_revision_history(source.revision_history())
1026
new_count = len(self.revision_history())
1027
return new_count - old_count
1028
finally:
1029
source.unlock()
1030
1031
def get_parent(self):
1032
"""See Branch.get_parent."""
1033
import errno
1034
_locs = ['parent', 'pull', 'x-pull']
1035
for l in _locs:
1036
try:
1037
return self.control_files.get_utf8(l).read().strip('\n')
1038
except NoSuchFile:
1039
pass
1040
return None
1041
1042
def get_push_location(self):
1043
"""See Branch.get_push_location."""
1044
config = bzrlib.config.BranchConfig(self)
1045
push_loc = config.get_user_option('push_location')
1046
return push_loc
1047
1048
def set_push_location(self, location):
1049
"""See Branch.set_push_location."""
1050
config = bzrlib.config.LocationConfig(self.base)
1051
config.set_user_option('push_location', location)
1052
1053
@needs_write_lock
1054
def set_parent(self, url):
1055
"""See Branch.set_parent."""
1056
# TODO: Maybe delete old location files?
1057
# URLs should never be unicode, even on the local fs,
1058
# FIXUP this and get_parent in a future branch format bump:
1059
# read and rewrite the file, and have the new format code read
1060
# using .get not .get_utf8. RBC 20060125
1061
self.control_files.put_utf8('parent', url + '\n')
1062
1063
def tree_config(self):
1064
return TreeConfig(self)
1065
1066
def _get_truncated_history(self, revision_id):
1067
history = self.revision_history()
1068
if revision_id is None:
1069
return history
1070
try:
1071
idx = history.index(revision_id)
1072
except ValueError:
1073
raise InvalidRevisionId(revision_id=revision, branch=self)
1074
return history[:idx+1]
1075
1076
@needs_read_lock
1077
def _clone_weave(self, to_location, revision=None, basis_branch=None):
1078
# prevent leakage
1079
from bzrlib.workingtree import WorkingTree
1080
assert isinstance(to_location, basestring)
1081
if basis_branch is not None:
1082
note("basis_branch is not supported for fast weave copy yet.")
1083
1084
history = self._get_truncated_history(revision)
1085
if not bzrlib.osutils.lexists(to_location):
1086
os.mkdir(to_location)
1087
bzrdir_to = self.bzrdir._format.initialize(to_location)
1088
self.repository.clone(bzrdir_to)
1089
branch_to = bzrdir_to.create_branch()
1090
mutter("copy branch from %s to %s", self, branch_to)
1091
1092
# FIXME duplicate code with base .clone().
1093
# .. would template method be useful here? RBC 20051207
1094
branch_to.set_parent(self.base)
1095
branch_to.append_revision(*history)
1096
WorkingTree.create(branch_to, branch_to.base)
1097
mutter("copied")
1098
return branch_to
1099
1100
1101
class BranchTestProviderAdapter(object):
1102
"""A tool to generate a suite testing multiple branch formats at once.
1103
1104
This is done by copying the test once for each transport and injecting
1105
the transport_server, transport_readonly_server, and branch_format
1106
classes into each copy. Each copy is also given a new id() to make it
1107
easy to identify.
1108
"""
1109
1110
def __init__(self, transport_server, transport_readonly_server, formats):
1111
self._transport_server = transport_server
1112
self._transport_readonly_server = transport_readonly_server
1113
self._formats = formats
966
1114
1115
def adapt(self, test):
1116
result = TestSuite()
1117
for branch_format, bzrdir_format in self._formats:
1118
new_test = deepcopy(test)
1119
new_test.transport_server = self._transport_server
1120
new_test.transport_readonly_server = self._transport_readonly_server
1121
new_test.bzrdir_format = bzrdir_format
1122
new_test.branch_format = branch_format
1123
def make_new_test_id():
1124
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1125
return lambda: new_id
1126
new_test.id = make_new_test_id()
1127
result.addTest(new_test)
1128
return result
1129
967
1130
968
1131
######################################################################
969
1132
# predicates
970
1133
971
1134
972
def is_control_file(filename):
973
## FIXME: better check
974
filename = os.path.normpath(filename)
975
while filename != '':
976
head, tail = os.path.split(filename)
977
## mutter('check %r for control file' % ((head, tail), ))
978
if tail == bzrlib.BZRDIR:
979
return True
980
if filename == head:
981
break
982
filename = head
983
return False
984
985
986
987
def _gen_revision_id(when):
988
"""Return new revision-id."""
989
s = '%s-%s-' % (user_email(), compact_date(when))
990
s += hexlify(rand_bytes(8))
991
return s
992
993
994
def gen_file_id(name):
995
"""Return new file id.
996
997
This should probably generate proper UUIDs, but for the moment we
998
cope with just randomness because running uuidgen every time is
999
slow."""
1000
idx = name.rfind('/')
1001
if idx != -1:
1002
name = name[idx+1 : ]
1003
idx = name.rfind('\\')
1004
if idx != -1:
1005
name = name[idx+1 : ]
1006
1007
name = name.lstrip('.')
1008
1009
s = hexlify(rand_bytes(8))
1010
return '-'.join((name, compact_date(time.time()), s))
1135
@deprecated_function(zero_eight)
1136
def ScratchBranch(*args, **kwargs):
1137
"""See bzrlib.bzrdir.ScratchDir."""
1138
d = ScratchDir(*args, **kwargs)
1139
return d.open_branch()
1140
1141
1142
@deprecated_function(zero_eight)
1143
def is_control_file(*args, **kwargs):
1144
"""See bzrlib.workingtree.is_control_file."""
1145
return bzrlib.workingtree.is_control_file(*args, **kwargs)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1