/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-08-12 15:37:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050812153701-ee26769ddc584e66
- merge john's "missing" command

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