To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 0.200.231
- compare with another revision
- download diff
- download tarball
- view history from revision 0.200.231
- Committer: Jelmer Vernooij
- Date: 2009-02-12 02:31:01 UTC
- mto: (0.312.1 master) (6883.23.1 bundle-git)
- mto: This revision was merged to the branch mainline in revision 6960.
- Revision ID: jelmer@samba.org-20090212023101-s7vcsvibldg5enz2
Partially fix pull.
- files added:
- .bzrignore
- foreign
- notes
- tests
- files removed:
- .bzrignore
- bzrlib
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- doc
- notes
- patches
- tools
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
18
import sys
19
import os
20
21
import bzrlib
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
28
import bzrlib.errors
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.xml import unpack_xml
32
from bzrlib.delta import compare_trees
33
from bzrlib.tree import EmptyTree, RevisionTree
34
import bzrlib.ui
35
36
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
# TODO: Some operations like log might retrieve the same revisions
43
# repeatedly to calculate deltas. We could perhaps have a weakref
44
# cache in memory to make this faster.
45
46
# TODO: please move the revision-string syntax stuff out of the branch
47
# object; it's clutter
48
49
50
def find_branch(f, **args):
51
if f and (f.startswith('http://') or f.startswith('https://')):
52
import remotebranch
53
return remotebranch.RemoteBranch(f, **args)
54
else:
55
return Branch(f, **args)
56
57
58
def find_cached_branch(f, cache_root, **args):
59
from remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from meta_store import CachedStore
63
cache_path = os.path.join(cache_root, store_name)
64
os.mkdir(cache_path)
65
new_store = CachedStore(getattr(br, store_name), cache_path)
66
setattr(br, store_name, new_store)
67
68
if isinstance(br, RemoteBranch):
69
cacheify(br, 'inventory_store')
70
cacheify(br, 'text_store')
71
cacheify(br, 'revision_store')
72
return br
73
74
75
def _relpath(base, path):
76
"""Return path relative to base, or raise exception.
77
78
The path may be either an absolute path or a path relative to the
79
current working directory.
80
81
Lifted out of Branch.relpath for ease of testing.
82
83
os.path.commonprefix (python2.4) has a bad bug that it works just
84
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
85
avoids that problem."""
86
rp = os.path.abspath(path)
87
88
s = []
89
head = rp
90
while len(head) >= len(base):
91
if head == base:
92
break
93
head, tail = os.path.split(head)
94
if tail:
95
s.insert(0, tail)
96
else:
97
from errors import NotBranchError
98
raise NotBranchError("path %r is not within branch %r" % (rp, base))
99
100
return os.sep.join(s)
101
102
103
def find_branch_root(f=None):
104
"""Find the branch root enclosing f, or pwd.
105
106
f may be a filename or a URL.
107
108
It is not necessary that f exists.
109
110
Basically we keep looking up until we find the control directory or
111
run into the root. If there isn't one, raises NotBranchError.
112
"""
113
if f == None:
114
f = os.getcwd()
115
elif hasattr(os.path, 'realpath'):
116
f = os.path.realpath(f)
117
else:
118
f = os.path.abspath(f)
119
if not os.path.exists(f):
120
raise BzrError('%r does not exist' % f)
121
122
123
orig_f = f
124
125
while True:
126
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
127
return f
128
head, tail = os.path.split(f)
129
if head == f:
130
# reached the root, whatever that may be
131
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
132
f = head
133
134
135
136
# XXX: move into bzrlib.errors; subclass BzrError
137
class DivergedBranches(Exception):
138
def __init__(self, branch1, branch2):
139
self.branch1 = branch1
140
self.branch2 = branch2
141
Exception.__init__(self, "These branches have diverged.")
142
143
144
######################################################################
145
# branch objects
146
147
class Branch(object):
148
"""Branch holding a history of revisions.
149
150
base
151
Base directory of the branch.
152
153
_lock_mode
154
None, or 'r' or 'w'
155
156
_lock_count
157
If _lock_mode is true, a positive count of the number of times the
158
lock has been taken.
159
160
_lock
161
Lock object from bzrlib.lock.
162
"""
163
base = None
164
_lock_mode = None
165
_lock_count = None
166
_lock = None
167
168
# Map some sort of prefix into a namespace
169
# stuff like "revno:10", "revid:", etc.
170
# This should match a prefix with a function which accepts
171
REVISION_NAMESPACES = {}
172
173
def __init__(self, base, init=False, find_root=True):
174
"""Create new branch object at a particular location.
175
176
base -- Base directory for the branch.
177
178
init -- If True, create new control files in a previously
179
unversioned directory. If False, the branch must already
180
be versioned.
181
182
find_root -- If true and init is false, find the root of the
183
existing branch containing base.
184
185
In the test suite, creation of new trees is tested using the
186
`ScratchBranch` class.
187
"""
188
from bzrlib.store import ImmutableStore
189
if init:
190
self.base = os.path.realpath(base)
191
self._make_control()
192
elif find_root:
193
self.base = find_branch_root(base)
194
else:
195
self.base = os.path.realpath(base)
196
if not isdir(self.controlfilename('.')):
197
from errors import NotBranchError
198
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
199
['use "bzr init" to initialize a new working tree',
200
'current bzr can only operate from top-of-tree'])
201
self._check_format()
202
203
self.text_store = ImmutableStore(self.controlfilename('text-store'))
204
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
205
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
206
207
208
def __str__(self):
209
return '%s(%r)' % (self.__class__.__name__, self.base)
210
211
212
__repr__ = __str__
213
214
215
def __del__(self):
216
if self._lock_mode or self._lock:
217
from warnings import warn
218
warn("branch %r was not explicitly unlocked" % self)
219
self._lock.unlock()
220
221
222
def lock_write(self):
223
if self._lock_mode:
224
if self._lock_mode != 'w':
225
from errors import LockError
226
raise LockError("can't upgrade to a write lock from %r" %
227
self._lock_mode)
228
self._lock_count += 1
229
else:
230
from bzrlib.lock import WriteLock
231
232
self._lock = WriteLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'w'
234
self._lock_count = 1
235
236
237
def lock_read(self):
238
if self._lock_mode:
239
assert self._lock_mode in ('r', 'w'), \
240
"invalid lock mode %r" % self._lock_mode
241
self._lock_count += 1
242
else:
243
from bzrlib.lock import ReadLock
244
245
self._lock = ReadLock(self.controlfilename('branch-lock'))
246
self._lock_mode = 'r'
247
self._lock_count = 1
248
249
def unlock(self):
250
if not self._lock_mode:
251
from errors import LockError
252
raise LockError('branch %r is not locked' % (self))
253
254
if self._lock_count > 1:
255
self._lock_count -= 1
256
else:
257
self._lock.unlock()
258
self._lock = None
259
self._lock_mode = self._lock_count = None
260
261
def abspath(self, name):
262
"""Return absolute filename for something in the branch"""
263
return os.path.join(self.base, name)
264
265
def relpath(self, path):
266
"""Return path relative to this branch of something inside it.
267
268
Raises an error if path is not in this branch."""
269
return _relpath(self.base, path)
270
271
def controlfilename(self, file_or_path):
272
"""Return location relative to branch."""
273
if isinstance(file_or_path, basestring):
274
file_or_path = [file_or_path]
275
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
276
277
278
def controlfile(self, file_or_path, mode='r'):
279
"""Open a control file for this branch.
280
281
There are two classes of file in the control directory: text
282
and binary. binary files are untranslated byte streams. Text
283
control files are stored with Unix newlines and in UTF-8, even
284
if the platform or locale defaults are different.
285
286
Controlfiles should almost never be opened in write mode but
287
rather should be atomically copied and replaced using atomicfile.
288
"""
289
290
fn = self.controlfilename(file_or_path)
291
292
if mode == 'rb' or mode == 'wb':
293
return file(fn, mode)
294
elif mode == 'r' or mode == 'w':
295
# open in binary mode anyhow so there's no newline translation;
296
# codecs uses line buffering by default; don't want that.
297
import codecs
298
return codecs.open(fn, mode + 'b', 'utf-8',
299
buffering=60000)
300
else:
301
raise BzrError("invalid controlfile mode %r" % mode)
302
303
def _make_control(self):
304
from bzrlib.inventory import Inventory
305
from bzrlib.xml import pack_xml
306
307
os.mkdir(self.controlfilename([]))
308
self.controlfile('README', 'w').write(
309
"This is a Bazaar-NG control directory.\n"
310
"Do not change any files in this directory.\n")
311
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
312
for d in ('text-store', 'inventory-store', 'revision-store'):
313
os.mkdir(self.controlfilename(d))
314
for f in ('revision-history', 'merged-patches',
315
'pending-merged-patches', 'branch-name',
316
'branch-lock',
317
'pending-merges'):
318
self.controlfile(f, 'w').write('')
319
mutter('created control directory in ' + self.base)
320
321
# if we want per-tree root ids then this is the place to set
322
# them; they're not needed for now and so ommitted for
323
# simplicity.
324
pack_xml(Inventory(), self.controlfile('inventory','w'))
325
326
def _check_format(self):
327
"""Check this branch format is supported.
328
329
The current tool only supports the current unstable format.
330
331
In the future, we might need different in-memory Branch
332
classes to support downlevel branches. But not yet.
333
"""
334
# This ignores newlines so that we can open branches created
335
# on Windows from Linux and so on. I think it might be better
336
# to always make all internal files in unix format.
337
fmt = self.controlfile('branch-format', 'r').read()
338
fmt.replace('\r\n', '')
339
if fmt != BZR_BRANCH_FORMAT:
340
raise BzrError('sorry, branch format %r not supported' % fmt,
341
['use a different bzr version',
342
'or remove the .bzr directory and "bzr init" again'])
343
344
def get_root_id(self):
345
"""Return the id of this branches root"""
346
inv = self.read_working_inventory()
347
return inv.root.file_id
348
349
def set_root_id(self, file_id):
350
inv = self.read_working_inventory()
351
orig_root_id = inv.root.file_id
352
del inv._byid[inv.root.file_id]
353
inv.root.file_id = file_id
354
inv._byid[inv.root.file_id] = inv.root
355
for fid in inv:
356
entry = inv[fid]
357
if entry.parent_id in (None, orig_root_id):
358
entry.parent_id = inv.root.file_id
359
self._write_inventory(inv)
360
361
def read_working_inventory(self):
362
"""Read the working inventory."""
363
from bzrlib.inventory import Inventory
364
from bzrlib.xml import unpack_xml
365
from time import time
366
before = time()
367
self.lock_read()
368
try:
369
# ElementTree does its own conversion from UTF-8, so open in
370
# binary.
371
inv = unpack_xml(Inventory,
372
self.controlfile('inventory', 'rb'))
373
mutter("loaded inventory of %d items in %f"
374
% (len(inv), time() - before))
375
return inv
376
finally:
377
self.unlock()
378
379
380
def _write_inventory(self, inv):
381
"""Update the working inventory.
382
383
That is to say, the inventory describing changes underway, that
384
will be committed to the next revision.
385
"""
386
from bzrlib.atomicfile import AtomicFile
387
from bzrlib.xml import pack_xml
388
389
self.lock_write()
390
try:
391
f = AtomicFile(self.controlfilename('inventory'), 'wb')
392
try:
393
pack_xml(inv, f)
394
f.commit()
395
finally:
396
f.close()
397
finally:
398
self.unlock()
399
400
mutter('wrote working inventory')
401
402
403
inventory = property(read_working_inventory, _write_inventory, None,
404
"""Inventory for the working copy.""")
405
406
407
def add(self, files, ids=None):
408
"""Make files versioned.
409
410
Note that the command line normally calls smart_add instead,
411
which can automatically recurse.
412
413
This puts the files in the Added state, so that they will be
414
recorded by the next commit.
415
416
files
417
List of paths to add, relative to the base of the tree.
418
419
ids
420
If set, use these instead of automatically generated ids.
421
Must be the same length as the list of files, but may
422
contain None for ids that are to be autogenerated.
423
424
TODO: Perhaps have an option to add the ids even if the files do
425
not (yet) exist.
426
427
TODO: Perhaps yield the ids and paths as they're added.
428
"""
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
433
files = [files]
434
if ids is not None:
435
ids = [ids]
436
437
if ids is None:
438
ids = [None] * len(files)
439
else:
440
assert(len(ids) == len(files))
441
442
self.lock_write()
443
try:
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
448
449
fp = splitpath(f)
450
451
if len(fp) == 0:
452
raise BzrError("cannot add top-level %r" % f)
453
454
fullpath = os.path.normpath(self.abspath(f))
455
456
try:
457
kind = file_kind(fullpath)
458
except OSError:
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
465
if file_id is None:
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
468
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
470
471
self._write_inventory(inv)
472
finally:
473
self.unlock()
474
475
476
def print_file(self, file, revno):
477
"""Print `file` to stdout."""
478
self.lock_read()
479
try:
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
483
if not file_id:
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
486
finally:
487
self.unlock()
488
489
490
def remove(self, files, verbose=False):
491
"""Mark nominated files for removal from the inventory.
492
493
This does not remove their text. This does not run on
494
495
TODO: Refuse to remove modified files unless --force is given?
496
497
TODO: Do something useful with directories.
498
499
TODO: Should this remove the text or not? Tough call; not
500
removing may be useful and the user can just use use rm, and
501
is the opposite of add. Removing it is consistent with most
502
other tools. Maybe an option.
503
"""
504
## TODO: Normalize names
505
## TODO: Remove nested loops; better scalability
506
if isinstance(files, basestring):
507
files = [files]
508
509
self.lock_write()
510
511
try:
512
tree = self.working_tree()
513
inv = tree.inventory
514
515
# do this before any modifications
516
for f in files:
517
fid = inv.path2id(f)
518
if not fid:
519
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
520
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
521
if verbose:
522
# having remove it, it must be either ignored or unknown
523
if tree.is_ignored(f):
524
new_status = 'I'
525
else:
526
new_status = '?'
527
show_status(new_status, inv[fid].kind, quotefn(f))
528
del inv[fid]
529
530
self._write_inventory(inv)
531
finally:
532
self.unlock()
533
534
535
# FIXME: this doesn't need to be a branch method
536
def set_inventory(self, new_inventory_list):
537
from bzrlib.inventory import Inventory, InventoryEntry
538
inv = Inventory(self.get_root_id())
539
for path, file_id, parent, kind in new_inventory_list:
540
name = os.path.basename(path)
541
if name == "":
542
continue
543
inv.add(InventoryEntry(file_id, name, kind, parent))
544
self._write_inventory(inv)
545
546
547
def unknowns(self):
548
"""Return all unknown files.
549
550
These are files in the working directory that are not versioned or
551
control files or ignored.
552
553
>>> b = ScratchBranch(files=['foo', 'foo~'])
554
>>> list(b.unknowns())
555
['foo']
556
>>> b.add('foo')
557
>>> list(b.unknowns())
558
[]
559
>>> b.remove('foo')
560
>>> list(b.unknowns())
561
['foo']
562
"""
563
return self.working_tree().unknowns()
564
565
566
def append_revision(self, *revision_ids):
567
from bzrlib.atomicfile import AtomicFile
568
569
for revision_id in revision_ids:
570
mutter("add {%s} to revision-history" % revision_id)
571
572
rev_history = self.revision_history()
573
rev_history.extend(revision_ids)
574
575
f = AtomicFile(self.controlfilename('revision-history'))
576
try:
577
for rev_id in rev_history:
578
print >>f, rev_id
579
f.commit()
580
finally:
581
f.close()
582
583
584
def get_revision_xml(self, revision_id):
585
"""Return XML file object for revision object."""
586
if not revision_id or not isinstance(revision_id, basestring):
587
raise InvalidRevisionId(revision_id)
588
589
self.lock_read()
590
try:
591
try:
592
return self.revision_store[revision_id]
593
except IndexError:
594
raise bzrlib.errors.NoSuchRevision(self, revision_id)
595
finally:
596
self.unlock()
597
598
599
def get_revision(self, revision_id):
600
"""Return the Revision object for a named revision"""
601
xml_file = self.get_revision_xml(revision_id)
602
603
try:
604
r = unpack_xml(Revision, xml_file)
605
except SyntaxError, e:
606
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
607
[revision_id,
608
str(e)])
609
610
assert r.revision_id == revision_id
611
return r
612
613
614
def get_revision_delta(self, revno):
615
"""Return the delta for one revision.
616
617
The delta is relative to its mainline predecessor, or the
618
empty tree for revision 1.
619
"""
620
assert isinstance(revno, int)
621
rh = self.revision_history()
622
if not (1 <= revno <= len(rh)):
623
raise InvalidRevisionNumber(revno)
624
625
# revno is 1-based; list is 0-based
626
627
new_tree = self.revision_tree(rh[revno-1])
628
if revno == 1:
629
old_tree = EmptyTree()
630
else:
631
old_tree = self.revision_tree(rh[revno-2])
632
633
return compare_trees(old_tree, new_tree)
634
635
636
637
def get_revision_sha1(self, revision_id):
638
"""Hash the stored value of a revision, and return it."""
639
# In the future, revision entries will be signed. At that
640
# point, it is probably best *not* to include the signature
641
# in the revision hash. Because that lets you re-sign
642
# the revision, (add signatures/remove signatures) and still
643
# have all hash pointers stay consistent.
644
# But for now, just hash the contents.
645
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
646
647
648
def get_inventory(self, inventory_id):
649
"""Get Inventory object by hash.
650
651
TODO: Perhaps for this and similar methods, take a revision
652
parameter which can be either an integer revno or a
653
string hash."""
654
from bzrlib.inventory import Inventory
655
from bzrlib.xml import unpack_xml
656
657
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
658
659
660
def get_inventory_xml(self, inventory_id):
661
"""Get inventory XML as a file object."""
662
return self.inventory_store[inventory_id]
663
664
665
def get_inventory_sha1(self, inventory_id):
666
"""Return the sha1 hash of the inventory entry
667
"""
668
return sha_file(self.get_inventory_xml(inventory_id))
669
670
671
def get_revision_inventory(self, revision_id):
672
"""Return inventory of a past revision."""
673
# bzr 0.0.6 imposes the constraint that the inventory_id
674
# must be the same as its revision, so this is trivial.
675
if revision_id == None:
676
from bzrlib.inventory import Inventory
677
return Inventory(self.get_root_id())
678
else:
679
return self.get_inventory(revision_id)
680
681
682
def revision_history(self):
683
"""Return sequence of revision hashes on to this branch.
684
685
>>> ScratchBranch().revision_history()
686
[]
687
"""
688
self.lock_read()
689
try:
690
return [l.rstrip('\r\n') for l in
691
self.controlfile('revision-history', 'r').readlines()]
692
finally:
693
self.unlock()
694
695
696
def common_ancestor(self, other, self_revno=None, other_revno=None):
697
"""
698
>>> import commit
699
>>> sb = ScratchBranch(files=['foo', 'foo~'])
700
>>> sb.common_ancestor(sb) == (None, None)
701
True
702
>>> commit.commit(sb, "Committing first revision", verbose=False)
703
>>> sb.common_ancestor(sb)[0]
704
1
705
>>> clone = sb.clone()
706
>>> commit.commit(sb, "Committing second revision", verbose=False)
707
>>> sb.common_ancestor(sb)[0]
708
2
709
>>> sb.common_ancestor(clone)[0]
710
1
711
>>> commit.commit(clone, "Committing divergent second revision",
712
... verbose=False)
713
>>> sb.common_ancestor(clone)[0]
714
1
715
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
716
True
717
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
718
True
719
>>> clone2 = sb.clone()
720
>>> sb.common_ancestor(clone2)[0]
721
2
722
>>> sb.common_ancestor(clone2, self_revno=1)[0]
723
1
724
>>> sb.common_ancestor(clone2, other_revno=1)[0]
725
1
726
"""
727
my_history = self.revision_history()
728
other_history = other.revision_history()
729
if self_revno is None:
730
self_revno = len(my_history)
731
if other_revno is None:
732
other_revno = len(other_history)
733
indices = range(min((self_revno, other_revno)))
734
indices.reverse()
735
for r in indices:
736
if my_history[r] == other_history[r]:
737
return r+1, my_history[r]
738
return None, None
739
740
741
def revno(self):
742
"""Return current revision number for this branch.
743
744
That is equivalent to the number of revisions committed to
745
this branch.
746
"""
747
return len(self.revision_history())
748
749
750
def last_patch(self):
751
"""Return last patch hash, or None if no history.
752
"""
753
ph = self.revision_history()
754
if ph:
755
return ph[-1]
756
else:
757
return None
758
759
760
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
761
"""
762
If self and other have not diverged, return a list of the revisions
763
present in other, but missing from self.
764
765
>>> from bzrlib.commit import commit
766
>>> bzrlib.trace.silent = True
767
>>> br1 = ScratchBranch()
768
>>> br2 = ScratchBranch()
769
>>> br1.missing_revisions(br2)
770
[]
771
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
772
>>> br1.missing_revisions(br2)
773
[u'REVISION-ID-1']
774
>>> br2.missing_revisions(br1)
775
[]
776
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
777
>>> br1.missing_revisions(br2)
778
[]
779
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
780
>>> br1.missing_revisions(br2)
781
[u'REVISION-ID-2A']
782
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
783
>>> br1.missing_revisions(br2)
784
Traceback (most recent call last):
785
DivergedBranches: These branches have diverged.
786
"""
787
self_history = self.revision_history()
788
self_len = len(self_history)
789
other_history = other.revision_history()
790
other_len = len(other_history)
791
common_index = min(self_len, other_len) -1
792
if common_index >= 0 and \
793
self_history[common_index] != other_history[common_index]:
794
raise DivergedBranches(self, other)
795
796
if stop_revision is None:
797
stop_revision = other_len
798
elif stop_revision > other_len:
799
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
800
801
return other_history[self_len:stop_revision]
802
803
804
def update_revisions(self, other, stop_revision=None):
805
"""Pull in all new revisions from other branch.
806
"""
807
from bzrlib.fetch import greedy_fetch
808
809
pb = bzrlib.ui.ui_factory.progress_bar()
810
pb.update('comparing histories')
811
812
revision_ids = self.missing_revisions(other, stop_revision)
813
814
if len(revision_ids) > 0:
815
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
816
else:
817
count = 0
818
self.append_revision(*revision_ids)
819
## note("Added %d revisions." % count)
820
pb.clear()
821
822
def install_revisions(self, other, revision_ids, pb):
823
if hasattr(other.revision_store, "prefetch"):
824
other.revision_store.prefetch(revision_ids)
825
if hasattr(other.inventory_store, "prefetch"):
826
inventory_ids = [other.get_revision(r).inventory_id
827
for r in revision_ids]
828
other.inventory_store.prefetch(inventory_ids)
829
830
if pb is None:
831
pb = bzrlib.ui.ui_factory.progress_bar()
832
833
revisions = []
834
needed_texts = set()
835
i = 0
836
837
failures = set()
838
for i, rev_id in enumerate(revision_ids):
839
pb.update('fetching revision', i+1, len(revision_ids))
840
try:
841
rev = other.get_revision(rev_id)
842
except bzrlib.errors.NoSuchRevision:
843
failures.add(rev_id)
844
continue
845
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
850
continue
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
853
854
pb.clear()
855
856
count, cp_fail = self.text_store.copy_multi(other.text_store,
857
needed_texts)
858
#print "Added %d texts." % count
859
inventory_ids = [ f.inventory_id for f in revisions ]
860
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
861
inventory_ids)
862
#print "Added %d inventories." % count
863
revision_ids = [ f.revision_id for f in revisions]
864
865
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
866
revision_ids,
867
permit_failure=True)
868
assert len(cp_fail) == 0
869
return count, failures
870
871
872
def commit(self, *args, **kw):
873
from bzrlib.commit import commit
874
commit(self, *args, **kw)
875
876
877
def lookup_revision(self, revision):
878
"""Return the revision identifier for a given revision information."""
879
revno, info = self.get_revision_info(revision)
880
return info
881
882
883
def revision_id_to_revno(self, revision_id):
884
"""Given a revision id, return its revno"""
885
history = self.revision_history()
886
try:
887
return history.index(revision_id) + 1
888
except ValueError:
889
raise bzrlib.errors.NoSuchRevision(self, revision_id)
890
891
892
def get_revision_info(self, revision):
893
"""Return (revno, revision id) for revision identifier.
894
895
revision can be an integer, in which case it is assumed to be revno (though
896
this will translate negative values into positive ones)
897
revision can also be a string, in which case it is parsed for something like
898
'date:' or 'revid:' etc.
899
"""
900
if revision is None:
901
return 0, None
902
revno = None
903
try:# Convert to int if possible
904
revision = int(revision)
905
except ValueError:
906
pass
907
revs = self.revision_history()
908
if isinstance(revision, int):
909
if revision == 0:
910
return 0, None
911
# Mabye we should do this first, but we don't need it if revision == 0
912
if revision < 0:
913
revno = len(revs) + revision + 1
914
else:
915
revno = revision
916
elif isinstance(revision, basestring):
917
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
918
if revision.startswith(prefix):
919
revno = func(self, revs, revision)
920
break
921
else:
922
raise BzrError('No namespace registered for string: %r' % revision)
923
924
if revno is None or revno <= 0 or revno > len(revs):
925
raise BzrError("no such revision %s" % revision)
926
return revno, revs[revno-1]
927
928
def _namespace_revno(self, revs, revision):
929
"""Lookup a revision by revision number"""
930
assert revision.startswith('revno:')
931
try:
932
return int(revision[6:])
933
except ValueError:
934
return None
935
REVISION_NAMESPACES['revno:'] = _namespace_revno
936
937
def _namespace_revid(self, revs, revision):
938
assert revision.startswith('revid:')
939
try:
940
return revs.index(revision[6:]) + 1
941
except ValueError:
942
return None
943
REVISION_NAMESPACES['revid:'] = _namespace_revid
944
945
def _namespace_last(self, revs, revision):
946
assert revision.startswith('last:')
947
try:
948
offset = int(revision[5:])
949
except ValueError:
950
return None
951
else:
952
if offset <= 0:
953
raise BzrError('You must supply a positive value for --revision last:XXX')
954
return len(revs) - offset + 1
955
REVISION_NAMESPACES['last:'] = _namespace_last
956
957
def _namespace_tag(self, revs, revision):
958
assert revision.startswith('tag:')
959
raise BzrError('tag: namespace registered, but not implemented.')
960
REVISION_NAMESPACES['tag:'] = _namespace_tag
961
962
def _namespace_date(self, revs, revision):
963
assert revision.startswith('date:')
964
import datetime
965
# Spec for date revisions:
966
# date:value
967
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
968
# it can also start with a '+/-/='. '+' says match the first
969
# entry after the given date. '-' is match the first entry before the date
970
# '=' is match the first entry after, but still on the given date.
971
#
972
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
973
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
974
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
975
# May 13th, 2005 at 0:00
976
#
977
# So the proper way of saying 'give me all entries for today' is:
978
# -r {date:+today}:{date:-tomorrow}
979
# The default is '=' when not supplied
980
val = revision[5:]
981
match_style = '='
982
if val[:1] in ('+', '-', '='):
983
match_style = val[:1]
984
val = val[1:]
985
986
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
987
if val.lower() == 'yesterday':
988
dt = today - datetime.timedelta(days=1)
989
elif val.lower() == 'today':
990
dt = today
991
elif val.lower() == 'tomorrow':
992
dt = today + datetime.timedelta(days=1)
993
else:
994
import re
995
# This should be done outside the function to avoid recompiling it.
996
_date_re = re.compile(
997
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
998
r'(,|T)?\s*'
999
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1000
)
1001
m = _date_re.match(val)
1002
if not m or (not m.group('date') and not m.group('time')):
1003
raise BzrError('Invalid revision date %r' % revision)
1004
1005
if m.group('date'):
1006
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1007
else:
1008
year, month, day = today.year, today.month, today.day
1009
if m.group('time'):
1010
hour = int(m.group('hour'))
1011
minute = int(m.group('minute'))
1012
if m.group('second'):
1013
second = int(m.group('second'))
1014
else:
1015
second = 0
1016
else:
1017
hour, minute, second = 0,0,0
1018
1019
dt = datetime.datetime(year=year, month=month, day=day,
1020
hour=hour, minute=minute, second=second)
1021
first = dt
1022
last = None
1023
reversed = False
1024
if match_style == '-':
1025
reversed = True
1026
elif match_style == '=':
1027
last = dt + datetime.timedelta(days=1)
1028
1029
if reversed:
1030
for i in range(len(revs)-1, -1, -1):
1031
r = self.get_revision(revs[i])
1032
# TODO: Handle timezone.
1033
dt = datetime.datetime.fromtimestamp(r.timestamp)
1034
if first >= dt and (last is None or dt >= last):
1035
return i+1
1036
else:
1037
for i in range(len(revs)):
1038
r = self.get_revision(revs[i])
1039
# TODO: Handle timezone.
1040
dt = datetime.datetime.fromtimestamp(r.timestamp)
1041
if first <= dt and (last is None or dt <= last):
1042
return i+1
1043
REVISION_NAMESPACES['date:'] = _namespace_date
1044
1045
def revision_tree(self, revision_id):
1046
"""Return Tree for a revision on this branch.
1047
1048
`revision_id` may be None for the null revision, in which case
1049
an `EmptyTree` is returned."""
1050
# TODO: refactor this to use an existing revision object
1051
# so we don't need to read it in twice.
1052
if revision_id == None:
1053
return EmptyTree()
1054
else:
1055
inv = self.get_revision_inventory(revision_id)
1056
return RevisionTree(self.text_store, inv)
1057
1058
1059
def working_tree(self):
1060
"""Return a `Tree` for the working copy."""
1061
from workingtree import WorkingTree
1062
return WorkingTree(self.base, self.read_working_inventory())
1063
1064
1065
def basis_tree(self):
1066
"""Return `Tree` object for last revision.
1067
1068
If there are no revisions yet, return an `EmptyTree`.
1069
"""
1070
r = self.last_patch()
1071
if r == None:
1072
return EmptyTree()
1073
else:
1074
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1075
1076
1077
1078
def rename_one(self, from_rel, to_rel):
1079
"""Rename one file.
1080
1081
This can change the directory or the filename or both.
1082
"""
1083
self.lock_write()
1084
try:
1085
tree = self.working_tree()
1086
inv = tree.inventory
1087
if not tree.has_filename(from_rel):
1088
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1089
if tree.has_filename(to_rel):
1090
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1091
1092
file_id = inv.path2id(from_rel)
1093
if file_id == None:
1094
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1095
1096
if inv.path2id(to_rel):
1097
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1098
1099
to_dir, to_tail = os.path.split(to_rel)
1100
to_dir_id = inv.path2id(to_dir)
1101
if to_dir_id == None and to_dir != '':
1102
raise BzrError("can't determine destination directory id for %r" % to_dir)
1103
1104
mutter("rename_one:")
1105
mutter(" file_id {%s}" % file_id)
1106
mutter(" from_rel %r" % from_rel)
1107
mutter(" to_rel %r" % to_rel)
1108
mutter(" to_dir %r" % to_dir)
1109
mutter(" to_dir_id {%s}" % to_dir_id)
1110
1111
inv.rename(file_id, to_dir_id, to_tail)
1112
1113
from_abs = self.abspath(from_rel)
1114
to_abs = self.abspath(to_rel)
1115
try:
1116
os.rename(from_abs, to_abs)
1117
except OSError, e:
1118
raise BzrError("failed to rename %r to %r: %s"
1119
% (from_abs, to_abs, e[1]),
1120
["rename rolled back"])
1121
1122
self._write_inventory(inv)
1123
finally:
1124
self.unlock()
1125
1126
1127
def move(self, from_paths, to_name):
1128
"""Rename files.
1129
1130
to_name must exist as a versioned directory.
1131
1132
If to_name exists and is a directory, the files are moved into
1133
it, keeping their old names. If it is a directory,
1134
1135
Note that to_name is only the last component of the new name;
1136
this doesn't change the directory.
1137
1138
This returns a list of (from_path, to_path) pairs for each
1139
entry that is moved.
1140
"""
1141
result = []
1142
self.lock_write()
1143
try:
1144
## TODO: Option to move IDs only
1145
assert not isinstance(from_paths, basestring)
1146
tree = self.working_tree()
1147
inv = tree.inventory
1148
to_abs = self.abspath(to_name)
1149
if not isdir(to_abs):
1150
raise BzrError("destination %r is not a directory" % to_abs)
1151
if not tree.has_filename(to_name):
1152
raise BzrError("destination %r not in working directory" % to_abs)
1153
to_dir_id = inv.path2id(to_name)
1154
if to_dir_id == None and to_name != '':
1155
raise BzrError("destination %r is not a versioned directory" % to_name)
1156
to_dir_ie = inv[to_dir_id]
1157
if to_dir_ie.kind not in ('directory', 'root_directory'):
1158
raise BzrError("destination %r is not a directory" % to_abs)
1159
1160
to_idpath = inv.get_idpath(to_dir_id)
1161
1162
for f in from_paths:
1163
if not tree.has_filename(f):
1164
raise BzrError("%r does not exist in working tree" % f)
1165
f_id = inv.path2id(f)
1166
if f_id == None:
1167
raise BzrError("%r is not versioned" % f)
1168
name_tail = splitpath(f)[-1]
1169
dest_path = appendpath(to_name, name_tail)
1170
if tree.has_filename(dest_path):
1171
raise BzrError("destination %r already exists" % dest_path)
1172
if f_id in to_idpath:
1173
raise BzrError("can't move %r to a subdirectory of itself" % f)
1174
1175
# OK, so there's a race here, it's possible that someone will
1176
# create a file in this interval and then the rename might be
1177
# left half-done. But we should have caught most problems.
1178
1179
for f in from_paths:
1180
name_tail = splitpath(f)[-1]
1181
dest_path = appendpath(to_name, name_tail)
1182
result.append((f, dest_path))
1183
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1184
try:
1185
os.rename(self.abspath(f), self.abspath(dest_path))
1186
except OSError, e:
1187
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1188
["rename rolled back"])
1189
1190
self._write_inventory(inv)
1191
finally:
1192
self.unlock()
1193
1194
return result
1195
1196
1197
def revert(self, filenames, old_tree=None, backups=True):
1198
"""Restore selected files to the versions from a previous tree.
1199
1200
backups
1201
If true (default) backups are made of files before
1202
they're renamed.
1203
"""
1204
from bzrlib.errors import NotVersionedError, BzrError
1205
from bzrlib.atomicfile import AtomicFile
1206
from bzrlib.osutils import backup_file
1207
1208
inv = self.read_working_inventory()
1209
if old_tree is None:
1210
old_tree = self.basis_tree()
1211
old_inv = old_tree.inventory
1212
1213
nids = []
1214
for fn in filenames:
1215
file_id = inv.path2id(fn)
1216
if not file_id:
1217
raise NotVersionedError("not a versioned file", fn)
1218
if not old_inv.has_id(file_id):
1219
raise BzrError("file not present in old tree", fn, file_id)
1220
nids.append((fn, file_id))
1221
1222
# TODO: Rename back if it was previously at a different location
1223
1224
# TODO: If given a directory, restore the entire contents from
1225
# the previous version.
1226
1227
# TODO: Make a backup to a temporary file.
1228
1229
# TODO: If the file previously didn't exist, delete it?
1230
for fn, file_id in nids:
1231
backup_file(fn)
1232
1233
f = AtomicFile(fn, 'wb')
1234
try:
1235
f.write(old_tree.get_file(file_id).read())
1236
f.commit()
1237
finally:
1238
f.close()
1239
1240
1241
def pending_merges(self):
1242
"""Return a list of pending merges.
1243
1244
These are revisions that have been merged into the working
1245
directory but not yet committed.
1246
"""
1247
cfn = self.controlfilename('pending-merges')
1248
if not os.path.exists(cfn):
1249
return []
1250
p = []
1251
for l in self.controlfile('pending-merges', 'r').readlines():
1252
p.append(l.rstrip('\n'))
1253
return p
1254
1255
1256
def add_pending_merge(self, revision_id):
1257
from bzrlib.revision import validate_revision_id
1258
1259
validate_revision_id(revision_id)
1260
1261
p = self.pending_merges()
1262
if revision_id in p:
1263
return
1264
p.append(revision_id)
1265
self.set_pending_merges(p)
1266
1267
1268
def set_pending_merges(self, rev_list):
1269
from bzrlib.atomicfile import AtomicFile
1270
self.lock_write()
1271
try:
1272
f = AtomicFile(self.controlfilename('pending-merges'))
1273
try:
1274
for l in rev_list:
1275
print >>f, l
1276
f.commit()
1277
finally:
1278
f.close()
1279
finally:
1280
self.unlock()
1281
1282
1283
def get_parent(self):
1284
"""Return the parent location of the branch.
1285
1286
This is the default location for push/pull/missing. The usual
1287
pattern is that the user can override it by specifying a
1288
location.
1289
"""
1290
import errno
1291
_locs = ['parent', 'pull', 'x-pull']
1292
for l in _locs:
1293
try:
1294
return self.controlfile(l, 'r').read().strip('\n')
1295
except IOError, e:
1296
if e.errno != errno.ENOENT:
1297
raise
1298
return None
1299
1300
1301
def set_parent(self, url):
1302
# TODO: Maybe delete old location files?
1303
from bzrlib.atomicfile import AtomicFile
1304
self.lock_write()
1305
try:
1306
f = AtomicFile(self.controlfilename('parent'))
1307
try:
1308
f.write(url + '\n')
1309
f.commit()
1310
finally:
1311
f.close()
1312
finally:
1313
self.unlock()
1314
1315
1316
1317
1318
class ScratchBranch(Branch):
1319
"""Special test class: a branch that cleans up after itself.
1320
1321
>>> b = ScratchBranch()
1322
>>> isdir(b.base)
1323
True
1324
>>> bd = b.base
1325
>>> b.destroy()
1326
>>> isdir(bd)
1327
False
1328
"""
1329
def __init__(self, files=[], dirs=[], base=None):
1330
"""Make a test branch.
1331
1332
This creates a temporary directory and runs init-tree in it.
1333
1334
If any files are listed, they are created in the working copy.
1335
"""
1336
from tempfile import mkdtemp
1337
init = False
1338
if base is None:
1339
base = mkdtemp()
1340
init = True
1341
Branch.__init__(self, base, init=init)
1342
for d in dirs:
1343
os.mkdir(self.abspath(d))
1344
1345
for f in files:
1346
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1347
1348
1349
def clone(self):
1350
"""
1351
>>> orig = ScratchBranch(files=["file1", "file2"])
1352
>>> clone = orig.clone()
1353
>>> os.path.samefile(orig.base, clone.base)
1354
False
1355
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1356
True
1357
"""
1358
from shutil import copytree
1359
from tempfile import mkdtemp
1360
base = mkdtemp()
1361
os.rmdir(base)
1362
copytree(self.base, base, symlinks=True)
1363
return ScratchBranch(base=base)
1364
1365
1366
1367
def __del__(self):
1368
self.destroy()
1369
1370
def destroy(self):
1371
"""Destroy the test branch, removing the scratch directory."""
1372
from shutil import rmtree
1373
try:
1374
if self.base:
1375
mutter("delete ScratchBranch %s" % self.base)
1376
rmtree(self.base)
1377
except OSError, e:
1378
# Work around for shutil.rmtree failing on Windows when
1379
# readonly files are encountered
1380
mutter("hit exception in destroying ScratchBranch: %s" % e)
1381
for root, dirs, files in os.walk(self.base, topdown=False):
1382
for name in files:
1383
os.chmod(os.path.join(root, name), 0700)
1384
rmtree(self.base)
1385
self.base = None
1386
1387
1388
1389
######################################################################
1390
# predicates
1391
1392
1393
def is_control_file(filename):
1394
## FIXME: better check
1395
filename = os.path.normpath(filename)
1396
while filename != '':
1397
head, tail = os.path.split(filename)
1398
## mutter('check %r for control file' % ((head, tail), ))
1399
if tail == bzrlib.BZRDIR:
1400
return True
1401
if filename == head:
1402
break
1403
filename = head
1404
return False
1405
1406
1407
1408
def gen_file_id(name):
1409
"""Return new file id.
1410
1411
This should probably generate proper UUIDs, but for the moment we
1412
cope with just randomness because running uuidgen every time is
1413
slow."""
1414
import re
1415
from binascii import hexlify
1416
from time import time
1417
1418
# get last component
1419
idx = name.rfind('/')
1420
if idx != -1:
1421
name = name[idx+1 : ]
1422
idx = name.rfind('\\')
1423
if idx != -1:
1424
name = name[idx+1 : ]
1425
1426
# make it not a hidden file
1427
name = name.lstrip('.')
1428
1429
# remove any wierd characters; we don't escape them but rather
1430
# just pull them out
1431
name = re.sub(r'[^\w.]', '', name)
1432
1433
s = hexlify(rand_bytes(8))
1434
return '-'.join((name, compact_date(time()), s))
1435
1436
1437
def gen_root_id():
1438
"""Return a new tree-root file id."""
1439
return gen_file_id('TREE_ROOT')
1440
1441
1442
def pull_loc(branch):
1443
# TODO: Should perhaps just make attribute be 'base' in
1444
# RemoteBranch and Branch?
1445
if hasattr(branch, "baseurl"):
1446
return branch.baseurl
1447
else:
1448
return branch.base
1449
1450
1451
def copy_branch(branch_from, to_location, revision=None):
1452
"""Copy branch_from into the existing directory to_location.
1453
1454
revision
1455
If not None, only revisions up to this point will be copied.
1456
The head of the new branch will be that revision.
1457
1458
to_location
1459
The name of a local directory that exists but is empty.
1460
"""
1461
from bzrlib.merge import merge
1462
from bzrlib.branch import Branch
1463
1464
assert isinstance(branch_from, Branch)
1465
assert isinstance(to_location, basestring)
1466
1467
br_to = Branch(to_location, init=True)
1468
br_to.set_root_id(branch_from.get_root_id())
1469
if revision is None:
1470
revno = branch_from.revno()
1471
else:
1472
revno, rev_id = branch_from.get_revision_info(revision)
1473
br_to.update_revisions(branch_from, stop_revision=revno)
1474
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1475
check_clean=False, ignore_zero=True)
1476
1477
from_location = pull_loc(branch_from)
1478
br_to.set_parent(pull_loc(branch_from))
1479
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0