« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1185.33.27
- compare with another revision
- download diff
- download tarball
- view history from revision 1185.33.27
- Committer: Martin Pool
- Date: 2005-11-17 07:45:38 UTC
- mfrom: (1508)
- mto: (1185.74.1 bzr.dev (Main development branch)) (1505.1.18 bound-branch) (1508.1.15) (1526.1.3 run_tests_twice_for_i18n) (1540.1.3 bzr.dev (Main development branch)) (1685.1.1 bzr-encoding) (1534.1.1 integration) (1553.5.1 bzr.dev (Main development branch)) (1608.2.1 bzr.mbp.escape-stores)
- mto: This revision was merged to the branch mainline in revision 1509.
- Revision ID: mbp@sourcefrog.net-20051117074538-5e113b7ad19a3b5d
[merge] much integrated work from robert and john
- files added:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- patches
- tools
- files removed:
- bzrlib/mdiff.py
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- contrib/bash/bzr => contrib/bash/bzr.simple
- bzrlib/newinventory.py => contrib/newinventory.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
from sets import Set
18
import shutil
19
import sys
20
import os
21
import errno
22
from warnings import warn
23
from cStringIO import StringIO
19
24
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
25
24
26
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, \
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"
27
from bzrlib.inventory import InventoryEntry
28
import bzrlib.inventory as inventory
29
from bzrlib.trace import mutter, note
30
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
31
rename, splitpath, sha_file, appendpath,
32
file_kind, abspath)
33
import bzrlib.errors as errors
34
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
35
NoSuchRevision, HistoryMissing, NotBranchError,
36
DivergedBranches, LockError, UnlistableStore,
37
UnlistableBranch, NoSuchFile, NotVersionedError,
38
NoWorkingTree)
39
from bzrlib.textui import show_status
40
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
41
NULL_REVISION)
42
43
from bzrlib.delta import compare_trees
44
from bzrlib.tree import EmptyTree, RevisionTree
45
from bzrlib.inventory import Inventory
46
from bzrlib.store import copy_all
47
from bzrlib.store.text import TextStore
48
from bzrlib.store.weave import WeaveStore
49
from bzrlib.testament import Testament
50
import bzrlib.transactions as transactions
51
from bzrlib.transport import Transport, get_transport
52
import bzrlib.xml5
53
import bzrlib.ui
54
from config import TreeConfig
55
56
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
59
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
39
60
## TODO: Maybe include checks for common corruption of newlines, etc?
40
61
41
62
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
68
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations.
67
68
def find_branch(*ignored, **ignored_too):
69
# XXX: leave this here for about one release, then remove it
70
raise NotImplementedError('find_branch() is not supported anymore, '
71
'please use one of the new branch constructors')
72
73
74
def needs_read_lock(unbound):
75
"""Decorate unbound to take out and release a read lock."""
76
def decorated(self, *args, **kwargs):
77
self.lock_read()
78
try:
79
return unbound(self, *args, **kwargs)
80
finally:
81
self.unlock()
82
return decorated
83
84
85
def needs_write_lock(unbound):
86
"""Decorate unbound to take out and release a write lock."""
87
def decorated(self, *args, **kwargs):
88
self.lock_write()
89
try:
90
return unbound(self, *args, **kwargs)
91
finally:
92
self.unlock()
93
return decorated
69
94
70
95
######################################################################
71
96
# branch objects
72
97
73
class Branch:
98
class Branch(object):
74
99
"""Branch holding a history of revisions.
75
100
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.
88
"""
89
def __init__(self, base, init=False, find_root=True):
101
base
102
Base directory/url of the branch.
103
"""
104
base = None
105
106
def __init__(self, *ignored, **ignored_too):
107
raise NotImplementedError('The Branch class is abstract')
108
109
@staticmethod
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format.
112
113
Only local branches are supported."""
114
return BzrBranch(get_transport(base), relax_version_check=True)
115
116
@staticmethod
117
def open(base):
118
"""Open an existing branch, rooted at 'base' (url)"""
119
t = get_transport(base)
120
mutter("trying to open %r with transport %r", base, t)
121
return BzrBranch(t)
122
123
@staticmethod
124
def open_containing(url):
125
"""Open an existing branch which contains url.
126
127
This probes for a branch at url, and searches upwards from there.
128
129
Basically we keep looking up until we find the control directory or
130
run into the root. If there isn't one, raises NotBranchError.
131
If there is one, it is returned, along with the unused portion of url.
132
"""
133
t = get_transport(url)
134
while True:
135
try:
136
return BzrBranch(t), t.relpath(url)
137
except NotBranchError:
138
pass
139
new_t = t.clone('..')
140
if new_t.base == t.base:
141
# reached the root, whatever that may be
142
raise NotBranchError(path=url)
143
t = new_t
144
145
@staticmethod
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
t = get_transport(base)
149
return BzrBranch(t, init=True)
150
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
154
"""
155
self.cache_root = cache_root
156
157
def _get_nick(self):
158
cfg = self.tree_config()
159
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
160
161
def _set_nick(self, nick):
162
cfg = self.tree_config()
163
cfg.set_option(nick, "nickname")
164
assert cfg.get_option("nickname") == nick
165
166
nick = property(_get_nick, _set_nick)
167
168
def push_stores(self, branch_to):
169
"""Copy the content of this branches store to branch_to."""
170
raise NotImplementedError('push_stores is abstract')
171
172
def get_transaction(self):
173
"""Return the current active transaction.
174
175
If no transaction is active, this returns a passthrough object
176
for which all data is immediately flushed and no caching happens.
177
"""
178
raise NotImplementedError('get_transaction is abstract')
179
180
def lock_write(self):
181
raise NotImplementedError('lock_write is abstract')
182
183
def lock_read(self):
184
raise NotImplementedError('lock_read is abstract')
185
186
def unlock(self):
187
raise NotImplementedError('unlock is abstract')
188
189
def abspath(self, name):
190
"""Return absolute filename for something in the branch
191
192
XXX: Robert Collins 20051017 what is this used for? why is it a branch
193
method and not a tree method.
194
"""
195
raise NotImplementedError('abspath is abstract')
196
197
def controlfilename(self, file_or_path):
198
"""Return location relative to branch."""
199
raise NotImplementedError('controlfilename is abstract')
200
201
def controlfile(self, file_or_path, mode='r'):
202
"""Open a control file for this branch.
203
204
There are two classes of file in the control directory: text
205
and binary. binary files are untranslated byte streams. Text
206
control files are stored with Unix newlines and in UTF-8, even
207
if the platform or locale defaults are different.
208
209
Controlfiles should almost never be opened in write mode but
210
rather should be atomically copied and replaced using atomicfile.
211
"""
212
raise NotImplementedError('controlfile is abstract')
213
214
def put_controlfile(self, path, f, encode=True):
215
"""Write an entry as a controlfile.
216
217
:param path: The path to put the file, relative to the .bzr control
218
directory
219
:param f: A file-like or string object whose contents should be copied.
220
:param encode: If true, encode the contents as utf-8
221
"""
222
raise NotImplementedError('put_controlfile is abstract')
223
224
def put_controlfiles(self, files, encode=True):
225
"""Write several entries as controlfiles.
226
227
:param files: A list of [(path, file)] pairs, where the path is the directory
228
underneath the bzr control directory
229
:param encode: If true, encode the contents as utf-8
230
"""
231
raise NotImplementedError('put_controlfiles is abstract')
232
233
def get_root_id(self):
234
"""Return the id of this branches root"""
235
raise NotImplementedError('get_root_id is abstract')
236
237
def set_root_id(self, file_id):
238
raise NotImplementedError('set_root_id is abstract')
239
240
def add(self, files, ids=None):
241
"""Make files versioned.
242
243
Note that the command line normally calls smart_add instead,
244
which can automatically recurse.
245
246
This puts the files in the Added state, so that they will be
247
recorded by the next commit.
248
249
files
250
List of paths to add, relative to the base of the tree.
251
252
ids
253
If set, use these instead of automatically generated ids.
254
Must be the same length as the list of files, but may
255
contain None for ids that are to be autogenerated.
256
257
TODO: Perhaps have an option to add the ids even if the files do
258
not (yet) exist.
259
260
TODO: Perhaps yield the ids and paths as they're added.
261
"""
262
raise NotImplementedError('add is abstract')
263
264
def print_file(self, file, revno):
265
"""Print `file` to stdout."""
266
raise NotImplementedError('print_file is abstract')
267
268
def unknowns(self):
269
"""Return all unknown files.
270
271
These are files in the working directory that are not versioned or
272
control files or ignored.
273
274
>>> from bzrlib.workingtree import WorkingTree
275
>>> b = ScratchBranch(files=['foo', 'foo~'])
276
>>> map(str, b.unknowns())
277
['foo']
278
>>> b.add('foo')
279
>>> list(b.unknowns())
280
[]
281
>>> WorkingTree(b.base, b).remove('foo')
282
>>> list(b.unknowns())
283
[u'foo']
284
"""
285
raise NotImplementedError('unknowns is abstract')
286
287
def append_revision(self, *revision_ids):
288
raise NotImplementedError('append_revision is abstract')
289
290
def set_revision_history(self, rev_history):
291
raise NotImplementedError('set_revision_history is abstract')
292
293
def has_revision(self, revision_id):
294
"""True if this branch has a copy of the revision.
295
296
This does not necessarily imply the revision is merge
297
or on the mainline."""
298
raise NotImplementedError('has_revision is abstract')
299
300
def get_revision_xml_file(self, revision_id):
301
"""Return XML file object for revision object."""
302
raise NotImplementedError('get_revision_xml_file is abstract')
303
304
def get_revision_xml(self, revision_id):
305
raise NotImplementedError('get_revision_xml is abstract')
306
307
def get_revision(self, revision_id):
308
"""Return the Revision object for a named revision"""
309
raise NotImplementedError('get_revision is abstract')
310
311
def get_revision_delta(self, revno):
312
"""Return the delta for one revision.
313
314
The delta is relative to its mainline predecessor, or the
315
empty tree for revision 1.
316
"""
317
assert isinstance(revno, int)
318
rh = self.revision_history()
319
if not (1 <= revno <= len(rh)):
320
raise InvalidRevisionNumber(revno)
321
322
# revno is 1-based; list is 0-based
323
324
new_tree = self.revision_tree(rh[revno-1])
325
if revno == 1:
326
old_tree = EmptyTree()
327
else:
328
old_tree = self.revision_tree(rh[revno-2])
329
330
return compare_trees(old_tree, new_tree)
331
332
def get_revision_sha1(self, revision_id):
333
"""Hash the stored value of a revision, and return it."""
334
raise NotImplementedError('get_revision_sha1 is abstract')
335
336
def get_ancestry(self, revision_id):
337
"""Return a list of revision-ids integrated by a revision.
338
339
This currently returns a list, but the ordering is not guaranteed:
340
treat it as a set.
341
"""
342
raise NotImplementedError('get_ancestry is abstract')
343
344
def get_inventory(self, revision_id):
345
"""Get Inventory object by hash."""
346
raise NotImplementedError('get_inventory is abstract')
347
348
def get_inventory_xml(self, revision_id):
349
"""Get inventory XML as a file object."""
350
raise NotImplementedError('get_inventory_xml is abstract')
351
352
def get_inventory_sha1(self, revision_id):
353
"""Return the sha1 hash of the inventory entry."""
354
raise NotImplementedError('get_inventory_sha1 is abstract')
355
356
def get_revision_inventory(self, revision_id):
357
"""Return inventory of a past revision."""
358
raise NotImplementedError('get_revision_inventory is abstract')
359
360
def revision_history(self):
361
"""Return sequence of revision hashes on to this branch."""
362
raise NotImplementedError('revision_history is abstract')
363
364
def revno(self):
365
"""Return current revision number for this branch.
366
367
That is equivalent to the number of revisions committed to
368
this branch.
369
"""
370
return len(self.revision_history())
371
372
def last_revision(self):
373
"""Return last patch hash, or None if no history."""
374
ph = self.revision_history()
375
if ph:
376
return ph[-1]
377
else:
378
return None
379
380
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
381
"""Return a list of new revisions that would perfectly fit.
382
383
If self and other have not diverged, return a list of the revisions
384
present in other, but missing from self.
385
386
>>> from bzrlib.commit import commit
387
>>> bzrlib.trace.silent = True
388
>>> br1 = ScratchBranch()
389
>>> br2 = ScratchBranch()
390
>>> br1.missing_revisions(br2)
391
[]
392
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
393
>>> br1.missing_revisions(br2)
394
[u'REVISION-ID-1']
395
>>> br2.missing_revisions(br1)
396
[]
397
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
398
>>> br1.missing_revisions(br2)
399
[]
400
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
401
>>> br1.missing_revisions(br2)
402
[u'REVISION-ID-2A']
403
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
404
>>> br1.missing_revisions(br2)
405
Traceback (most recent call last):
406
DivergedBranches: These branches have diverged.
407
"""
408
self_history = self.revision_history()
409
self_len = len(self_history)
410
other_history = other.revision_history()
411
other_len = len(other_history)
412
common_index = min(self_len, other_len) -1
413
if common_index >= 0 and \
414
self_history[common_index] != other_history[common_index]:
415
raise DivergedBranches(self, other)
416
417
if stop_revision is None:
418
stop_revision = other_len
419
else:
420
assert isinstance(stop_revision, int)
421
if stop_revision > other_len:
422
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
423
return other_history[self_len:stop_revision]
424
425
def update_revisions(self, other, stop_revision=None):
426
"""Pull in new perfect-fit revisions."""
427
raise NotImplementedError('update_revisions is abstract')
428
429
def pullable_revisions(self, other, stop_revision):
430
raise NotImplementedError('pullable_revisions is abstract')
431
432
def revision_id_to_revno(self, revision_id):
433
"""Given a revision id, return its revno"""
434
if revision_id is None:
435
return 0
436
history = self.revision_history()
437
try:
438
return history.index(revision_id) + 1
439
except ValueError:
440
raise bzrlib.errors.NoSuchRevision(self, revision_id)
441
442
def get_rev_id(self, revno, history=None):
443
"""Find the revision id of the specified revno."""
444
if revno == 0:
445
return None
446
if history is None:
447
history = self.revision_history()
448
elif revno <= 0 or revno > len(history):
449
raise bzrlib.errors.NoSuchRevision(self, revno)
450
return history[revno - 1]
451
452
def revision_tree(self, revision_id):
453
"""Return Tree for a revision on this branch.
454
455
`revision_id` may be None for the null revision, in which case
456
an `EmptyTree` is returned."""
457
raise NotImplementedError('revision_tree is abstract')
458
459
def working_tree(self):
460
"""Return a `Tree` for the working copy."""
461
raise NotImplementedError('working_tree is abstract')
462
463
def pull(self, source, overwrite=False):
464
raise NotImplementedError('pull is abstract')
465
466
def basis_tree(self):
467
"""Return `Tree` object for last revision.
468
469
If there are no revisions yet, return an `EmptyTree`.
470
"""
471
return self.revision_tree(self.last_revision())
472
473
def rename_one(self, from_rel, to_rel):
474
"""Rename one file.
475
476
This can change the directory or the filename or both.
477
"""
478
raise NotImplementedError('rename_one is abstract')
479
480
def move(self, from_paths, to_name):
481
"""Rename files.
482
483
to_name must exist as a versioned directory.
484
485
If to_name exists and is a directory, the files are moved into
486
it, keeping their old names. If it is a directory,
487
488
Note that to_name is only the last component of the new name;
489
this doesn't change the directory.
490
491
This returns a list of (from_path, to_path) pairs for each
492
entry that is moved.
493
"""
494
raise NotImplementedError('move is abstract')
495
496
def revert(self, filenames, old_tree=None, backups=True):
497
"""Restore selected files to the versions from a previous tree.
498
499
backups
500
If true (default) backups are made of files before
501
they're renamed.
502
"""
503
raise NotImplementedError('revert is abstract')
504
505
def pending_merges(self):
506
"""Return a list of pending merges.
507
508
These are revisions that have been merged into the working
509
directory but not yet committed.
510
"""
511
raise NotImplementedError('pending_merges is abstract')
512
513
def add_pending_merge(self, *revision_ids):
514
# TODO: Perhaps should check at this point that the
515
# history of the revision is actually present?
516
raise NotImplementedError('add_pending_merge is abstract')
517
518
def set_pending_merges(self, rev_list):
519
raise NotImplementedError('set_pending_merges is abstract')
520
521
def get_parent(self):
522
"""Return the parent location of the branch.
523
524
This is the default location for push/pull/missing. The usual
525
pattern is that the user can override it by specifying a
526
location.
527
"""
528
raise NotImplementedError('get_parent is abstract')
529
530
def get_push_location(self):
531
"""Return the None or the location to push this branch to."""
532
raise NotImplementedError('get_push_location is abstract')
533
534
def set_push_location(self, location):
535
"""Set a new push location for this branch."""
536
raise NotImplementedError('set_push_location is abstract')
537
538
def set_parent(self, url):
539
raise NotImplementedError('set_parent is abstract')
540
541
def check_revno(self, revno):
542
"""\
543
Check whether a revno corresponds to any revision.
544
Zero (the NULL revision) is considered valid.
545
"""
546
if revno != 0:
547
self.check_real_revno(revno)
548
549
def check_real_revno(self, revno):
550
"""\
551
Check whether a revno corresponds to a real revision.
552
Zero (the NULL revision) is considered invalid
553
"""
554
if revno < 1 or revno > self.revno():
555
raise InvalidRevisionNumber(revno)
556
557
def sign_revision(self, revision_id, gpg_strategy):
558
raise NotImplementedError('sign_revision is abstract')
559
560
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
561
raise NotImplementedError('store_revision_signature is abstract')
562
563
class BzrBranch(Branch):
564
"""A branch stored in the actual filesystem.
565
566
Note that it's "local" in the context of the filesystem; it doesn't
567
really matter if it's on an nfs/smb/afs/coda/... share, as long as
568
it's writable, and can be accessed via the normal filesystem API.
569
570
_lock_mode
571
None, or 'r' or 'w'
572
573
_lock_count
574
If _lock_mode is true, a positive count of the number of times the
575
lock has been taken.
576
577
_lock
578
Lock object from bzrlib.lock.
579
"""
580
# We actually expect this class to be somewhat short-lived; part of its
581
# purpose is to try to isolate what bits of the branch logic are tied to
582
# filesystem access, so that in a later step, we can extricate them to
583
# a separarte ("storage") class.
584
_lock_mode = None
585
_lock_count = None
586
_lock = None
587
_inventory_weave = None
588
589
# Map some sort of prefix into a namespace
590
# stuff like "revno:10", "revid:", etc.
591
# This should match a prefix with a function which accepts
592
REVISION_NAMESPACES = {}
593
594
def push_stores(self, branch_to):
595
"""See Branch.push_stores."""
596
if (self._branch_format != branch_to._branch_format
597
or self._branch_format != 4):
598
from bzrlib.fetch import greedy_fetch
599
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
600
self, self._branch_format, branch_to, branch_to._branch_format)
601
greedy_fetch(to_branch=branch_to, from_branch=self,
602
revision=self.last_revision())
603
return
604
605
store_pairs = ((self.text_store, branch_to.text_store),
606
(self.inventory_store, branch_to.inventory_store),
607
(self.revision_store, branch_to.revision_store))
608
try:
609
for from_store, to_store in store_pairs:
610
copy_all(from_store, to_store)
611
except UnlistableStore:
612
raise UnlistableBranch(from_store)
613
614
def __init__(self, transport, init=False,
615
relax_version_check=False):
90
616
"""Create new branch object at a particular location.
91
617
92
base -- Base directory for the branch.
618
transport -- A Transport object, defining how to access files.
93
619
94
620
init -- If True, create new control files in a previously
95
621
unversioned directory. If False, the branch must already
96
622
be versioned.
97
623
98
find_root -- If true and init is false, find the root of the
99
existing branch containing base.
624
relax_version_check -- If true, the usual check for the branch
625
version is not applied. This is intended only for
626
upgrade/recovery type use; it's not guaranteed that
627
all operations will work on old format branches.
100
628
101
629
In the test suite, creation of new trees is tested using the
102
630
`ScratchBranch` class.
103
631
"""
632
assert isinstance(transport, Transport), \
633
"%r is not a Transport" % transport
634
self._transport = transport
104
635
if init:
105
self.base = os.path.realpath(base)
106
636
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
637
self._check_format(relax_version_check)
638
639
def get_store(name, compressed=True, prefixed=False):
640
# FIXME: This approach of assuming stores are all entirely compressed
641
# or entirely uncompressed is tidy, but breaks upgrade from
642
# some existing branches where there's a mixture; we probably
643
# still want the option to look for both.
644
relpath = self._rel_controlfilename(name)
645
store = TextStore(self._transport.clone(relpath),
646
prefixed=prefixed,
647
compressed=compressed)
648
#if self._transport.should_cache():
649
# cache_path = os.path.join(self.cache_root, name)
650
# os.mkdir(cache_path)
651
# store = bzrlib.store.CachedStore(store, cache_path)
652
return store
653
def get_weave(name, prefixed=False):
654
relpath = self._rel_controlfilename(name)
655
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
656
if self._transport.should_cache():
657
ws.enable_cache = True
658
return ws
659
660
if self._branch_format == 4:
661
self.inventory_store = get_store('inventory-store')
662
self.text_store = get_store('text-store')
663
self.revision_store = get_store('revision-store')
664
elif self._branch_format == 5:
665
self.control_weaves = get_weave('')
666
self.weave_store = get_weave('weaves')
667
self.revision_store = get_store('revision-store', compressed=False)
668
elif self._branch_format == 6:
669
self.control_weaves = get_weave('')
670
self.weave_store = get_weave('weaves', prefixed=True)
671
self.revision_store = get_store('revision-store', compressed=False,
672
prefixed=True)
673
self.revision_store.register_suffix('sig')
674
self._transaction = None
121
675
122
676
def __str__(self):
123
return '%s(%r)' % (self.__class__.__name__, self.base)
124
677
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
125
678
126
679
__repr__ = __str__
127
680
681
def __del__(self):
682
if self._lock_mode or self._lock:
683
# XXX: This should show something every time, and be suitable for
684
# headless operation and embedding
685
warn("branch %r was not explicitly unlocked" % self)
686
self._lock.unlock()
687
688
# TODO: It might be best to do this somewhere else,
689
# but it is nice for a Branch object to automatically
690
# cache it's information.
691
# Alternatively, we could have the Transport objects cache requests
692
# See the earlier discussion about how major objects (like Branch)
693
# should never expect their __del__ function to run.
694
if hasattr(self, 'cache_root') and self.cache_root is not None:
695
try:
696
shutil.rmtree(self.cache_root)
697
except:
698
pass
699
self.cache_root = None
700
701
def _get_base(self):
702
if self._transport:
703
return self._transport.base
704
return None
705
706
base = property(_get_base, doc="The URL for the root of this branch.")
707
708
def _finish_transaction(self):
709
"""Exit the current transaction."""
710
if self._transaction is None:
711
raise errors.LockError('Branch %s is not in a transaction' %
712
self)
713
transaction = self._transaction
714
self._transaction = None
715
transaction.finish()
716
717
def get_transaction(self):
718
"""See Branch.get_transaction."""
719
if self._transaction is None:
720
return transactions.PassThroughTransaction()
721
else:
722
return self._transaction
723
724
def _set_transaction(self, new_transaction):
725
"""Set a new active transaction."""
726
if self._transaction is not None:
727
raise errors.LockError('Branch %s is in a transaction already.' %
728
self)
729
self._transaction = new_transaction
730
731
def lock_write(self):
732
mutter("lock write: %s (%s)", self, self._lock_count)
733
# TODO: Upgrade locking to support using a Transport,
734
# and potentially a remote locking protocol
735
if self._lock_mode:
736
if self._lock_mode != 'w':
737
raise LockError("can't upgrade to a write lock from %r" %
738
self._lock_mode)
739
self._lock_count += 1
740
else:
741
self._lock = self._transport.lock_write(
742
self._rel_controlfilename('branch-lock'))
743
self._lock_mode = 'w'
744
self._lock_count = 1
745
self._set_transaction(transactions.PassThroughTransaction())
746
747
def lock_read(self):
748
mutter("lock read: %s (%s)", self, self._lock_count)
749
if self._lock_mode:
750
assert self._lock_mode in ('r', 'w'), \
751
"invalid lock mode %r" % self._lock_mode
752
self._lock_count += 1
753
else:
754
self._lock = self._transport.lock_read(
755
self._rel_controlfilename('branch-lock'))
756
self._lock_mode = 'r'
757
self._lock_count = 1
758
self._set_transaction(transactions.ReadOnlyTransaction())
759
# 5K may be excessive, but hey, its a knob.
760
self.get_transaction().set_cache_size(5000)
761
762
def unlock(self):
763
mutter("unlock: %s (%s)", self, self._lock_count)
764
if not self._lock_mode:
765
raise LockError('branch %r is not locked' % (self))
766
767
if self._lock_count > 1:
768
self._lock_count -= 1
769
else:
770
self._finish_transaction()
771
self._lock.unlock()
772
self._lock = None
773
self._lock_mode = self._lock_count = None
128
774
129
775
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
776
"""See Branch.abspath."""
777
return self._transport.abspath(name)
778
779
def _rel_controlfilename(self, file_or_path):
780
if not isinstance(file_or_path, basestring):
781
file_or_path = '/'.join(file_or_path)
782
if file_or_path == '':
783
return bzrlib.BZRDIR
784
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
146
785
147
786
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
787
"""See Branch.controlfilename."""
788
return self._transport.abspath(self._rel_controlfilename(file_or_path))
153
789
154
790
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)
791
"""See Branch.controlfile."""
792
import codecs
793
794
relpath = self._rel_controlfilename(file_or_path)
795
#TODO: codecs.open() buffers linewise, so it was overloaded with
796
# a much larger buffer, do we need to do the same for getreader/getwriter?
797
if mode == 'rb':
798
return self._transport.get(relpath)
799
elif mode == 'wb':
800
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
801
elif mode == 'r':
802
# XXX: Do we really want errors='replace'? Perhaps it should be
803
# an error, or at least reported, if there's incorrectly-encoded
804
# data inside a file.
805
# <https://launchpad.net/products/bzr/+bug/3823>
806
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
807
elif mode == 'w':
808
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
173
809
else:
174
810
raise BzrError("invalid controlfile mode %r" % mode)
175
811
812
def put_controlfile(self, path, f, encode=True):
813
"""See Branch.put_controlfile."""
814
self.put_controlfiles([(path, f)], encode=encode)
176
815
816
def put_controlfiles(self, files, encode=True):
817
"""See Branch.put_controlfiles."""
818
import codecs
819
ctrl_files = []
820
for path, f in files:
821
if encode:
822
if isinstance(f, basestring):
823
f = f.encode('utf-8', 'replace')
824
else:
825
f = codecs.getwriter('utf-8')(f, errors='replace')
826
path = self._rel_controlfilename(path)
827
ctrl_files.append((path, f))
828
self._transport.put_multi(ctrl_files)
177
829
178
830
def _make_control(self):
179
os.mkdir(self.controlfilename([]))
180
self.controlfile('README', 'w').write(
831
from bzrlib.inventory import Inventory
832
from bzrlib.weavefile import write_weave_v5
833
from bzrlib.weave import Weave
834
835
# Create an empty inventory
836
sio = StringIO()
837
# if we want per-tree root ids then this is the place to set
838
# them; they're not needed for now and so ommitted for
839
# simplicity.
840
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
841
empty_inv = sio.getvalue()
842
sio = StringIO()
843
bzrlib.weavefile.write_weave_v5(Weave(), sio)
844
empty_weave = sio.getvalue()
845
846
dirs = [[], 'revision-store', 'weaves']
847
files = [('README',
181
848
"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):
849
"Do not change any files in this directory.\n"),
850
('branch-format', BZR_BRANCH_FORMAT_6),
851
('revision-history', ''),
852
('branch-name', ''),
853
('branch-lock', ''),
854
('pending-merges', ''),
855
('inventory', empty_inv),
856
('inventory.weave', empty_weave),
857
('ancestry.weave', empty_weave)
858
]
859
cfn = self._rel_controlfilename
860
self._transport.mkdir_multi([cfn(d) for d in dirs])
861
self.put_controlfiles(files)
862
mutter('created control directory in ' + self._transport.base)
863
864
def _check_format(self, relax_version_check):
194
865
"""Check this branch format is supported.
195
866
196
The current tool only supports the current unstable format.
867
The format level is stored, as an integer, in
868
self._branch_format for code that needs to check it later.
197
869
198
870
In the future, we might need different in-memory Branch
199
871
classes to support downlevel branches. But not yet.
200
872
"""
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
873
try:
874
fmt = self.controlfile('branch-format', 'r').read()
875
except NoSuchFile:
876
raise NotBranchError(path=self.base)
877
mutter("got branch format %r", fmt)
878
if fmt == BZR_BRANCH_FORMAT_6:
879
self._branch_format = 6
880
elif fmt == BZR_BRANCH_FORMAT_5:
881
self._branch_format = 5
882
elif fmt == BZR_BRANCH_FORMAT_4:
883
self._branch_format = 4
884
885
if (not relax_version_check
886
and self._branch_format not in (5, 6)):
887
raise errors.UnsupportedFormatError(
888
'sorry, branch format %r not supported' % fmt,
889
['use a different bzr version',
890
'or remove the .bzr directory'
891
' and "bzr init" again'])
892
893
def get_root_id(self):
894
"""See Branch.get_root_id."""
895
inv = self.get_inventory(self.last_revision())
896
return inv.root.file_id
897
898
@needs_write_lock
899
def set_root_id(self, file_id):
900
"""See Branch.set_root_id."""
901
inv = self.working_tree().read_working_inventory()
902
orig_root_id = inv.root.file_id
903
del inv._byid[inv.root.file_id]
904
inv.root.file_id = file_id
905
inv._byid[inv.root.file_id] = inv.root
906
for fid in inv:
907
entry = inv[fid]
908
if entry.parent_id in (None, orig_root_id):
909
entry.parent_id = inv.root.file_id
910
self._write_inventory(inv)
911
912
@needs_write_lock
913
def add(self, files, ids=None):
914
"""See Branch.add."""
289
915
# TODO: Re-adding a file that is removed in the working copy
290
916
# should probably put it back with the previous ID.
291
if isinstance(files, types.StringTypes):
917
if isinstance(files, basestring):
918
assert(ids is None or isinstance(ids, basestring))
292
919
files = [files]
293
294
inv = self.read_working_inventory()
295
for f in files:
920
if ids is not None:
921
ids = [ids]
922
923
if ids is None:
924
ids = [None] * len(files)
925
else:
926
assert(len(ids) == len(files))
927
928
inv = self.working_tree().read_working_inventory()
929
for f,file_id in zip(files, ids):
296
930
if is_control_file(f):
297
bailout("cannot add control file %s" % quotefn(f))
931
raise BzrError("cannot add control file %s" % quotefn(f))
298
932
299
933
fp = splitpath(f)
300
934
301
935
if len(fp) == 0:
302
bailout("cannot add top-level %r" % f)
303
936
raise BzrError("cannot add top-level %r" % f)
937
304
938
fullpath = os.path.normpath(self.abspath(f))
305
939
306
940
try:
307
941
kind = file_kind(fullpath)
308
942
except OSError:
309
943
# 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)
944
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
945
946
if not InventoryEntry.versionable_kind(kind):
947
raise BzrError('cannot add: not a versionable file ('
948
'i.e. regular file, symlink or directory): %s' % quotefn(f))
949
950
if file_id is None:
951
file_id = gen_file_id(f)
316
952
inv.add_path(f, kind=kind, file_id=file_id)
317
953
318
if verbose:
319
show_status('A', kind, quotefn(f))
320
321
954
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
322
323
self._write_inventory(inv)
324
325
955
956
self.working_tree()._write_inventory(inv)
957
958
@needs_read_lock
326
959
def print_file(self, file, revno):
327
"""Print `file` to stdout."""
328
tree = self.revision_tree(self.lookup_revision(revno))
960
"""See Branch.print_file."""
961
tree = self.revision_tree(self.get_rev_id(revno))
329
962
# use inventory as it was in that revision
330
963
file_id = tree.inventory.path2id(file)
331
964
if not file_id:
332
bailout("%r is not present in revision %d" % (file, revno))
965
raise BzrError("%r is not present in revision %s" % (file, revno))
333
966
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
967
399
968
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
"""
969
"""See Branch.unknowns."""
415
970
return self.working_tree().unknowns()
416
971
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)
972
@needs_write_lock
973
def append_revision(self, *revision_ids):
974
"""See Branch.append_revision."""
975
for revision_id in revision_ids:
976
mutter("add {%s} to revision-history" % revision_id)
590
977
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
978
rev_history.extend(revision_ids)
979
self.set_revision_history(rev_history)
980
981
@needs_write_lock
982
def set_revision_history(self, rev_history):
983
"""See Branch.set_revision_history."""
984
self.put_controlfile('revision-history', '\n'.join(rev_history))
985
986
def has_revision(self, revision_id):
987
"""See Branch.has_revision."""
988
return (revision_id is None
989
or self.revision_store.has_id(revision_id))
990
991
@needs_read_lock
992
def get_revision_xml_file(self, revision_id):
993
"""See Branch.get_revision_xml_file."""
994
if not revision_id or not isinstance(revision_id, basestring):
995
raise InvalidRevisionId(revision_id=revision_id, branch=self)
996
try:
997
return self.revision_store.get(revision_id)
998
except (IndexError, KeyError):
999
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1000
1001
#deprecated
1002
get_revision_xml = get_revision_xml_file
1003
1004
def get_revision_xml(self, revision_id):
1005
"""See Branch.get_revision_xml."""
1006
return self.get_revision_xml_file(revision_id).read()
605
1007
606
1008
607
1009
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])
1010
"""See Branch.get_revision."""
1011
xml_file = self.get_revision_xml_file(revision_id)
1012
1013
try:
1014
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
1015
except SyntaxError, e:
1016
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
1017
[revision_id,
1018
str(e)])
1019
610
1020
assert r.revision_id == revision_id
611
1021
return r
612
1022
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
631
632
def revision_history(self):
633
"""Return sequence of revision hashes on to this branch.
634
635
>>> ScratchBranch().revision_history()
636
[]
637
"""
638
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
639
640
641
def revno(self):
642
"""Return current revision number for this branch.
643
644
That is equivalent to the number of revisions committed to
645
this branch.
646
647
>>> b = ScratchBranch()
648
>>> b.revno()
649
0
650
>>> b.commit('no foo')
651
>>> b.revno()
652
1
653
"""
654
return len(self.revision_history())
655
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
"""
663
ph = self.revision_history()
664
if ph:
665
return ph[-1]
666
else:
667
return None
668
669
670
def lookup_revision(self, revno):
671
"""Return revision hash for revision number."""
672
if revno == 0:
673
return None
674
1023
def get_revision_sha1(self, revision_id):
1024
"""See Branch.get_revision_sha1."""
1025
# In the future, revision entries will be signed. At that
1026
# point, it is probably best *not* to include the signature
1027
# in the revision hash. Because that lets you re-sign
1028
# the revision, (add signatures/remove signatures) and still
1029
# have all hash pointers stay consistent.
1030
# But for now, just hash the contents.
1031
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
1032
1033
def get_ancestry(self, revision_id):
1034
"""See Branch.get_ancestry."""
1035
if revision_id is None:
1036
return [None]
1037
w = self._get_inventory_weave()
1038
return [None] + map(w.idx_to_name,
1039
w.inclusions([w.lookup(revision_id)]))
1040
1041
def _get_inventory_weave(self):
1042
return self.control_weaves.get_weave('inventory',
1043
self.get_transaction())
1044
1045
def get_inventory(self, revision_id):
1046
"""See Branch.get_inventory."""
1047
xml = self.get_inventory_xml(revision_id)
1048
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1049
1050
def get_inventory_xml(self, revision_id):
1051
"""See Branch.get_inventory_xml."""
675
1052
try:
676
# list is 0-based; revisions are 1-based
677
return self.revision_history()[revno-1]
1053
assert isinstance(revision_id, basestring), type(revision_id)
1054
iw = self._get_inventory_weave()
1055
return iw.get_text(iw.lookup(revision_id))
678
1056
except IndexError:
679
raise BzrError("no such revision %s" % revno)
680
1057
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
1058
1059
def get_inventory_sha1(self, revision_id):
1060
"""See Branch.get_inventory_sha1."""
1061
return self.get_revision(revision_id).inventory_sha1
1062
1063
def get_revision_inventory(self, revision_id):
1064
"""See Branch.get_revision_inventory."""
1065
# TODO: Unify this with get_inventory()
1066
# bzr 0.0.6 and later imposes the constraint that the inventory_id
1067
# must be the same as its revision, so this is trivial.
1068
if revision_id == None:
1069
# This does not make sense: if there is no revision,
1070
# then it is the current tree inventory surely ?!
1071
# and thus get_root_id() is something that looks at the last
1072
# commit on the branch, and the get_root_id is an inventory check.
1073
raise NotImplementedError
1074
# return Inventory(self.get_root_id())
1075
else:
1076
return self.get_inventory(revision_id)
1077
1078
@needs_read_lock
1079
def revision_history(self):
1080
"""See Branch.revision_history."""
1081
transaction = self.get_transaction()
1082
history = transaction.map.find_revision_history()
1083
if history is not None:
1084
mutter("cache hit for revision-history in %s", self)
1085
return list(history)
1086
history = [l.rstrip('\r\n') for l in
1087
self.controlfile('revision-history', 'r').readlines()]
1088
transaction.map.add_revision_history(history)
1089
# this call is disabled because revision_history is
1090
# not really an object yet, and the transaction is for objects.
1091
# transaction.register_clean(history, precious=True)
1092
return list(history)
1093
1094
def update_revisions(self, other, stop_revision=None):
1095
"""See Branch.update_revisions."""
1096
from bzrlib.fetch import greedy_fetch
1097
if stop_revision is None:
1098
stop_revision = other.last_revision()
1099
### Should this be checking is_ancestor instead of revision_history?
1100
if (stop_revision is not None and
1101
stop_revision in self.revision_history()):
1102
return
1103
greedy_fetch(to_branch=self, from_branch=other,
1104
revision=stop_revision)
1105
pullable_revs = self.pullable_revisions(other, stop_revision)
1106
if len(pullable_revs) > 0:
1107
self.append_revision(*pullable_revs)
1108
1109
def pullable_revisions(self, other, stop_revision):
1110
"""See Branch.pullable_revisions."""
1111
other_revno = other.revision_id_to_revno(stop_revision)
1112
try:
1113
return self.missing_revisions(other, other_revno)
1114
except DivergedBranches, e:
1115
try:
1116
pullable_revs = get_intervening_revisions(self.last_revision(),
1117
stop_revision, self)
1118
assert self.last_revision() not in pullable_revs
1119
return pullable_revs
1120
except bzrlib.errors.NotAncestor:
1121
if is_ancestor(self.last_revision(), stop_revision, self):
1122
return []
1123
else:
1124
raise e
1125
1126
def revision_id_to_revno(self, revision_id):
1127
"""Given a revision id, return its revno"""
1128
if revision_id is None:
1129
return 0
1130
history = self.revision_history()
1131
try:
1132
return history.index(revision_id) + 1
1133
except ValueError:
1134
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1135
1136
def get_rev_id(self, revno, history=None):
1137
"""Find the revision id of the specified revno."""
1138
if revno == 0:
1139
return None
1140
if history is None:
1141
history = self.revision_history()
1142
elif revno <= 0 or revno > len(history):
1143
raise bzrlib.errors.NoSuchRevision(self, revno)
1144
return history[revno - 1]
681
1145
682
1146
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:
1147
"""See Branch.revision_tree."""
1148
# TODO: refactor this to use an existing revision object
1149
# so we don't need to read it in twice.
1150
if revision_id == None or revision_id == NULL_REVISION:
689
1151
return EmptyTree()
690
1152
else:
691
1153
inv = self.get_revision_inventory(revision_id)
692
return RevisionTree(self.text_store, inv)
693
1154
return RevisionTree(self.weave_store, inv, revision_id)
694
1155
695
1156
def working_tree(self):
696
"""Return a `Tree` for the working copy."""
697
return WorkingTree(self.base, self.read_working_inventory())
698
699
700
def basis_tree(self):
701
"""Return `Tree` object for last revision.
702
703
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
"""
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
769
1157
"""See Branch.working_tree."""
1158
from bzrlib.workingtree import WorkingTree
1159
# TODO: In the future, perhaps WorkingTree should utilize Transport
1160
# RobertCollins 20051003 - I don't think it should - working trees are
1161
# much more complex to keep consistent than our careful .bzr subset.
1162
# instead, we should say that working trees are local only, and optimise
1163
# for that.
1164
if self._transport.base.find('://') != -1:
1165
raise NoWorkingTree(self.base)
1166
return WorkingTree(self.base, branch=self)
1167
1168
@needs_write_lock
1169
def pull(self, source, overwrite=False):
1170
"""See Branch.pull."""
1171
source.lock_read()
1172
try:
1173
try:
1174
self.update_revisions(source)
1175
except DivergedBranches:
1176
if not overwrite:
1177
raise
1178
self.set_revision_history(source.revision_history())
1179
finally:
1180
source.unlock()
1181
1182
@needs_write_lock
770
1183
def rename_one(self, from_rel, to_rel):
771
"""Rename one file.
772
773
This can change the directory or the filename or both.
774
"""
1184
"""See Branch.rename_one."""
775
1185
tree = self.working_tree()
776
1186
inv = tree.inventory
777
1187
if not tree.has_filename(from_rel):
778
bailout("can't rename: old working file %r does not exist" % from_rel)
1188
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
779
1189
if tree.has_filename(to_rel):
780
bailout("can't rename: new working file %r already exists" % to_rel)
781
1190
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1191
782
1192
file_id = inv.path2id(from_rel)
783
1193
if file_id == None:
784
bailout("can't rename: old name %r is not versioned" % from_rel)
1194
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
785
1195
786
1196
if inv.path2id(to_rel):
787
bailout("can't rename: new name %r is already versioned" % to_rel)
1197
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
788
1198
789
1199
to_dir, to_tail = os.path.split(to_rel)
790
1200
to_dir_id = inv.path2id(to_dir)
791
1201
if to_dir_id == None and to_dir != '':
792
bailout("can't determine destination directory id for %r" % to_dir)
1202
raise BzrError("can't determine destination directory id for %r" % to_dir)
793
1203
794
1204
mutter("rename_one:")
795
1205
mutter(" file_id {%s}" % file_id)
797
1207
mutter(" to_rel %r" % to_rel)
798
1208
mutter(" to_dir %r" % to_dir)
799
1209
mutter(" to_dir_id {%s}" % to_dir_id)
800
1210
801
1211
inv.rename(file_id, to_dir_id, to_tail)
802
1212
803
print "%s => %s" % (from_rel, to_rel)
804
805
1213
from_abs = self.abspath(from_rel)
806
1214
to_abs = self.abspath(to_rel)
807
1215
try:
808
os.rename(from_abs, to_abs)
1216
rename(from_abs, to_abs)
809
1217
except OSError, e:
810
bailout("failed to rename %r to %r: %s"
1218
raise BzrError("failed to rename %r to %r: %s"
811
1219
% (from_abs, to_abs, e[1]),
812
1220
["rename rolled back"])
813
1221
814
self._write_inventory(inv)
815
816
817
1222
self.working_tree()._write_inventory(inv)
1223
1224
@needs_write_lock
818
1225
def move(self, from_paths, to_name):
819
"""Rename files.
820
821
to_name must exist as a versioned directory.
822
823
If to_name exists and is a directory, the files are moved into
824
it, keeping their old names. If it is a directory,
825
826
Note that to_name is only the last component of the new name;
827
this doesn't change the directory.
828
"""
1226
"""See Branch.move."""
1227
result = []
829
1228
## TODO: Option to move IDs only
830
1229
assert not isinstance(from_paths, basestring)
831
1230
tree = self.working_tree()
832
1231
inv = tree.inventory
833
1232
to_abs = self.abspath(to_name)
834
1233
if not isdir(to_abs):
835
bailout("destination %r is not a directory" % to_abs)
1234
raise BzrError("destination %r is not a directory" % to_abs)
836
1235
if not tree.has_filename(to_name):
837
bailout("destination %r not in working directory" % to_abs)
1236
raise BzrError("destination %r not in working directory" % to_abs)
838
1237
to_dir_id = inv.path2id(to_name)
839
1238
if to_dir_id == None and to_name != '':
840
bailout("destination %r is not a versioned directory" % to_name)
1239
raise BzrError("destination %r is not a versioned directory" % to_name)
841
1240
to_dir_ie = inv[to_dir_id]
842
1241
if to_dir_ie.kind not in ('directory', 'root_directory'):
843
bailout("destination %r is not a directory" % to_abs)
1242
raise BzrError("destination %r is not a directory" % to_abs)
844
1243
845
to_idpath = Set(inv.get_idpath(to_dir_id))
1244
to_idpath = inv.get_idpath(to_dir_id)
846
1245
847
1246
for f in from_paths:
848
1247
if not tree.has_filename(f):
849
bailout("%r does not exist in working tree" % f)
1248
raise BzrError("%r does not exist in working tree" % f)
850
1249
f_id = inv.path2id(f)
851
1250
if f_id == None:
852
bailout("%r is not versioned" % f)
1251
raise BzrError("%r is not versioned" % f)
853
1252
name_tail = splitpath(f)[-1]
854
1253
dest_path = appendpath(to_name, name_tail)
855
1254
if tree.has_filename(dest_path):
856
bailout("destination %r already exists" % dest_path)
1255
raise BzrError("destination %r already exists" % dest_path)
857
1256
if f_id in to_idpath:
858
bailout("can't move %r to a subdirectory of itself" % f)
1257
raise BzrError("can't move %r to a subdirectory of itself" % f)
859
1258
860
1259
# OK, so there's a race here, it's possible that someone will
861
1260
# create a file in this interval and then the rename might be
864
1263
for f in from_paths:
865
1264
name_tail = splitpath(f)[-1]
866
1265
dest_path = appendpath(to_name, name_tail)
867
print "%s => %s" % (f, dest_path)
1266
result.append((f, dest_path))
868
1267
inv.rename(inv.path2id(f), to_dir_id, name_tail)
869
1268
try:
870
os.rename(self.abspath(f), self.abspath(dest_path))
1269
rename(self.abspath(f), self.abspath(dest_path))
871
1270
except OSError, e:
872
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1271
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
873
1272
["rename rolled back"])
874
1273
875
self._write_inventory(inv)
876
877
878
879
def show_status(self, show_all=False):
880
"""Display single-line status for non-ignored working files.
881
882
The list is show sorted in order by file name.
883
884
>>> b = ScratchBranch(files=['foo', 'foo~'])
885
>>> b.show_status()
886
? foo
887
>>> b.add('foo')
888
>>> b.show_status()
889
A foo
890
>>> b.commit("add foo")
891
>>> b.show_status()
892
>>> os.unlink(b.abspath('foo'))
893
>>> b.show_status()
894
D foo
1274
self.working_tree()._write_inventory(inv)
1275
return result
1276
1277
def get_parent(self):
1278
"""See Branch.get_parent."""
1279
import errno
1280
_locs = ['parent', 'pull', 'x-pull']
1281
for l in _locs:
1282
try:
1283
return self.controlfile(l, 'r').read().strip('\n')
1284
except IOError, e:
1285
if e.errno != errno.ENOENT:
1286
raise
1287
return None
1288
1289
def get_push_location(self):
1290
"""See Branch.get_push_location."""
1291
config = bzrlib.config.BranchConfig(self)
1292
push_loc = config.get_user_option('push_location')
1293
return push_loc
1294
1295
def set_push_location(self, location):
1296
"""See Branch.set_push_location."""
1297
config = bzrlib.config.LocationConfig(self.base)
1298
config.set_user_option('push_location', location)
1299
1300
@needs_write_lock
1301
def set_parent(self, url):
1302
"""See Branch.set_parent."""
1303
# TODO: Maybe delete old location files?
1304
from bzrlib.atomicfile import AtomicFile
1305
f = AtomicFile(self.controlfilename('parent'))
1306
try:
1307
f.write(url + '\n')
1308
f.commit()
1309
finally:
1310
f.close()
1311
1312
def tree_config(self):
1313
return TreeConfig(self)
1314
1315
def check_revno(self, revno):
1316
"""\
1317
Check whether a revno corresponds to any revision.
1318
Zero (the NULL revision) is considered valid.
1319
"""
1320
if revno != 0:
1321
self.check_real_revno(revno)
1322
1323
def check_real_revno(self, revno):
1324
"""\
1325
Check whether a revno corresponds to a real revision.
1326
Zero (the NULL revision) is considered invalid
1327
"""
1328
if revno < 1 or revno > self.revno():
1329
raise InvalidRevisionNumber(revno)
895
1330
896
TODO: Get state for single files.
897
"""
898
899
# We have to build everything into a list first so that it can
900
# sorted by name, incorporating all the different sources.
901
902
# FIXME: Rather than getting things in random order and then sorting,
903
# just step through in order.
904
905
# Interesting case: the old ID for a file has been removed,
906
# but a new file has been created under that name.
907
908
old = self.basis_tree()
909
new = self.working_tree()
910
911
for fs, fid, oldname, newname, kind in diff_trees(old, new):
912
if fs == 'R':
913
show_status(fs, kind,
914
oldname + ' => ' + newname)
915
elif fs == 'A' or fs == 'M':
916
show_status(fs, kind, newname)
917
elif fs == 'D':
918
show_status(fs, kind, oldname)
919
elif fs == '.':
920
if show_all:
921
show_status(fs, kind, newname)
922
elif fs == 'I':
923
if show_all:
924
show_status(fs, kind, newname)
925
elif fs == '?':
926
show_status(fs, kind, newname)
927
else:
928
bailout("weird file state %r" % ((fs, fid),))
929
930
931
932
class ScratchBranch(Branch):
1331
def sign_revision(self, revision_id, gpg_strategy):
1332
"""See Branch.sign_revision."""
1333
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1334
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1335
1336
@needs_write_lock
1337
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1338
"""See Branch.store_revision_signature."""
1339
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1340
revision_id, "sig")
1341
1342
1343
class ScratchBranch(BzrBranch):
933
1344
"""Special test class: a branch that cleans up after itself.
934
1345
935
1346
>>> b = ScratchBranch()
936
1347
>>> isdir(b.base)
937
1348
True
938
1349
>>> bd = b.base
939
>>> del b
1350
>>> b._transport.__del__()
940
1351
>>> isdir(bd)
941
1352
False
942
1353
"""
943
def __init__(self, files=[], dirs=[]):
1354
1355
def __init__(self, files=[], dirs=[], transport=None):
944
1356
"""Make a test branch.
945
1357
946
1358
This creates a temporary directory and runs init-tree in it.
947
1359
948
1360
If any files are listed, they are created in the working copy.
949
1361
"""
950
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1362
if transport is None:
1363
transport = bzrlib.transport.local.ScratchTransport()
1364
super(ScratchBranch, self).__init__(transport, init=True)
1365
else:
1366
super(ScratchBranch, self).__init__(transport)
1367
951
1368
for d in dirs:
952
os.mkdir(self.abspath(d))
1369
self._transport.mkdir(d)
953
1370
954
1371
for f in files:
955
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
956
957
958
def __del__(self):
959
"""Destroy the test branch, removing the scratch directory."""
960
try:
961
shutil.rmtree(self.base)
962
except OSError:
963
# Work around for shutil.rmtree failing on Windows when
964
# readonly files are encountered
965
for root, dirs, files in os.walk(self.base, topdown=False):
966
for name in files:
967
os.chmod(os.path.join(root, name), 0700)
968
shutil.rmtree(self.base)
969
1372
self._transport.put(f, 'content of %s' % f)
1373
1374
1375
def clone(self):
1376
"""
1377
>>> orig = ScratchBranch(files=["file1", "file2"])
1378
>>> clone = orig.clone()
1379
>>> if os.name != 'nt':
1380
... os.path.samefile(orig.base, clone.base)
1381
... else:
1382
... orig.base == clone.base
1383
...
1384
False
1385
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1386
True
1387
"""
1388
from shutil import copytree
1389
from tempfile import mkdtemp
1390
base = mkdtemp()
1391
os.rmdir(base)
1392
copytree(self.base, base, symlinks=True)
1393
return ScratchBranch(
1394
transport=bzrlib.transport.local.ScratchTransport(base))
970
1395
971
1396
972
1397
######################################################################
988
1413
989
1414
990
1415
991
def _gen_revision_id(when):
992
"""Return new revision-id."""
993
s = '%s-%s-' % (user_email(), compact_date(when))
994
s += hexlify(rand_bytes(8))
995
return s
996
997
998
1416
def gen_file_id(name):
999
1417
"""Return new file id.
1000
1418
1001
1419
This should probably generate proper UUIDs, but for the moment we
1002
1420
cope with just randomness because running uuidgen every time is
1003
1421
slow."""
1422
import re
1423
from binascii import hexlify
1424
from time import time
1425
1426
# get last component
1004
1427
idx = name.rfind('/')
1005
1428
if idx != -1:
1006
1429
name = name[idx+1 : ]
1008
1431
if idx != -1:
1009
1432
name = name[idx+1 : ]
1010
1433
1434
# make it not a hidden file
1011
1435
name = name.lstrip('.')
1012
1436
1437
# remove any wierd characters; we don't escape them but rather
1438
# just pull them out
1439
name = re.sub(r'[^\w.]', '', name)
1440
1013
1441
s = hexlify(rand_bytes(8))
1014
return '-'.join((name, compact_date(time.time()), s))
1442
return '-'.join((name, compact_date(time()), s))
1443
1444
1445
def gen_root_id():
1446
"""Return a new tree-root file id."""
1447
return gen_file_id('TREE_ROOT')
1448
1449
Loggerhead is a web-based interface for Breezy
Version: 2.0.1