/brz/remove-bazaar

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

  • Committer: Martin Pool
  • Date: 2005-09-13 05:04:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050913050405-9c2289581c7de552
- new method WeaveStore.get_weave_or_empty

Show diffs side-by-side

added added

removed removed

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