/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: Robert Collins
  • Date: 2005-08-25 01:13:32 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050825011331-6d549d5de7edcec1
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list

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
 
 
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
 
28
import bzrlib.errors
 
29
from bzrlib.textui import show_status
 
30
from bzrlib.revision import Revision
 
31
from bzrlib.xml import unpack_xml
 
32
from bzrlib.delta import compare_trees
 
33
from bzrlib.tree import EmptyTree, RevisionTree
 
34
import bzrlib.ui
 
35
 
 
36
 
 
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
38
## TODO: Maybe include checks for common corruption of newlines, etc?
 
39
 
 
40
 
 
41
# TODO: Some operations like log might retrieve the same revisions
 
42
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
43
# cache in memory to make this faster.
 
44
 
 
45
# TODO: please move the revision-string syntax stuff out of the branch
 
46
# object; it's clutter
 
47
 
 
48
 
 
49
def find_branch(f, **args):
 
50
    if f and (f.startswith('http://') or f.startswith('https://')):
 
51
        import remotebranch 
 
52
        return remotebranch.RemoteBranch(f, **args)
 
53
    else:
 
54
        return Branch(f, **args)
 
55
 
 
56
 
 
57
def find_cached_branch(f, cache_root, **args):
 
58
    from remotebranch import RemoteBranch
 
59
    br = find_branch(f, **args)
 
60
    def cacheify(br, store_name):
 
61
        from meta_store import CachedStore
 
62
        cache_path = os.path.join(cache_root, store_name)
 
63
        os.mkdir(cache_path)
 
64
        new_store = CachedStore(getattr(br, store_name), cache_path)
 
65
        setattr(br, store_name, new_store)
 
66
 
 
67
    if isinstance(br, RemoteBranch):
 
68
        cacheify(br, 'inventory_store')
 
69
        cacheify(br, 'text_store')
 
70
        cacheify(br, 'revision_store')
 
71
    return br
 
72
 
 
73
 
 
74
def _relpath(base, path):
 
75
    """Return path relative to base, or raise exception.
 
76
 
 
77
    The path may be either an absolute path or a path relative to the
 
78
    current working directory.
 
79
 
 
80
    Lifted out of Branch.relpath for ease of testing.
 
81
 
 
82
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
83
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
84
    avoids that problem."""
 
85
    rp = os.path.abspath(path)
 
86
 
 
87
    s = []
 
88
    head = rp
 
89
    while len(head) >= len(base):
 
90
        if head == base:
 
91
            break
 
92
        head, tail = os.path.split(head)
 
93
        if tail:
 
94
            s.insert(0, tail)
 
95
    else:
 
96
        from errors import NotBranchError
 
97
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
98
 
 
99
    return os.sep.join(s)
 
100
        
 
101
 
 
102
def find_branch_root(f=None):
 
103
    """Find the branch root enclosing f, or pwd.
 
104
 
 
105
    f may be a filename or a URL.
 
106
 
 
107
    It is not necessary that f exists.
 
108
 
 
109
    Basically we keep looking up until we find the control directory or
 
110
    run into the root.  If there isn't one, raises NotBranchError.
 
111
    """
 
112
    if f == None:
 
113
        f = os.getcwd()
 
114
    elif hasattr(os.path, 'realpath'):
 
115
        f = os.path.realpath(f)
 
116
    else:
 
117
        f = os.path.abspath(f)
 
118
    if not os.path.exists(f):
 
119
        raise BzrError('%r does not exist' % f)
 
120
        
 
121
 
 
122
    orig_f = f
 
123
 
 
124
    while True:
 
125
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
126
            return f
 
127
        head, tail = os.path.split(f)
 
128
        if head == f:
 
129
            # reached the root, whatever that may be
 
130
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
 
131
        f = head
 
132
 
 
133
 
 
134
 
 
135
# XXX: move into bzrlib.errors; subclass BzrError    
 
136
class DivergedBranches(Exception):
 
137
    def __init__(self, branch1, branch2):
 
138
        self.branch1 = branch1
 
139
        self.branch2 = branch2
 
140
        Exception.__init__(self, "These branches have diverged.")
 
141
 
 
142
 
 
143
######################################################################
 
144
# branch objects
 
145
 
 
146
class Branch(object):
 
147
    """Branch holding a history of revisions.
 
148
 
 
149
    base
 
150
        Base directory of the branch.
 
151
 
 
152
    _lock_mode
 
153
        None, or 'r' or 'w'
 
154
 
 
155
    _lock_count
 
156
        If _lock_mode is true, a positive count of the number of times the
 
157
        lock has been taken.
 
158
 
 
159
    _lock
 
160
        Lock object from bzrlib.lock.
 
161
    """
 
162
    base = None
 
163
    _lock_mode = None
 
164
    _lock_count = None
 
165
    _lock = None
 
166
    
 
167
    # Map some sort of prefix into a namespace
 
168
    # stuff like "revno:10", "revid:", etc.
 
169
    # This should match a prefix with a function which accepts
 
170
    REVISION_NAMESPACES = {}
 
171
 
 
172
    def __init__(self, base, init=False, find_root=True):
 
173
        """Create new branch object at a particular location.
 
174
 
 
175
        base -- Base directory for the branch.
 
176
        
 
177
        init -- If True, create new control files in a previously
 
178
             unversioned directory.  If False, the branch must already
 
179
             be versioned.
 
180
 
 
181
        find_root -- If true and init is false, find the root of the
 
182
             existing branch containing base.
 
183
 
 
184
        In the test suite, creation of new trees is tested using the
 
185
        `ScratchBranch` class.
 
186
        """
 
187
        from bzrlib.store import ImmutableStore
 
188
        if init:
 
189
            self.base = os.path.realpath(base)
 
190
            self._make_control()
 
191
        elif find_root:
 
192
            self.base = find_branch_root(base)
 
193
        else:
 
194
            self.base = os.path.realpath(base)
 
195
            if not isdir(self.controlfilename('.')):
 
196
                from errors import NotBranchError
 
197
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
198
                                     ['use "bzr init" to initialize a new working tree',
 
199
                                      'current bzr can only operate from top-of-tree'])
 
200
        self._check_format()
 
201
 
 
202
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
203
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
204
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
205
 
 
206
 
 
207
    def __str__(self):
 
208
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
209
 
 
210
 
 
211
    __repr__ = __str__
 
212
 
 
213
 
 
214
    def __del__(self):
 
215
        if self._lock_mode or self._lock:
 
216
            from warnings import warn
 
217
            warn("branch %r was not explicitly unlocked" % self)
 
218
            self._lock.unlock()
 
219
 
 
220
 
 
221
    def lock_write(self):
 
222
        if self._lock_mode:
 
223
            if self._lock_mode != 'w':
 
224
                from errors import LockError
 
225
                raise LockError("can't upgrade to a write lock from %r" %
 
226
                                self._lock_mode)
 
227
            self._lock_count += 1
 
228
        else:
 
229
            from bzrlib.lock import WriteLock
 
230
 
 
231
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
232
            self._lock_mode = 'w'
 
233
            self._lock_count = 1
 
234
 
 
235
 
 
236
    def lock_read(self):
 
237
        if self._lock_mode:
 
238
            assert self._lock_mode in ('r', 'w'), \
 
239
                   "invalid lock mode %r" % self._lock_mode
 
240
            self._lock_count += 1
 
241
        else:
 
242
            from bzrlib.lock import ReadLock
 
243
 
 
244
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
245
            self._lock_mode = 'r'
 
246
            self._lock_count = 1
 
247
                        
 
248
    def unlock(self):
 
249
        if not self._lock_mode:
 
250
            from errors import LockError
 
251
            raise LockError('branch %r is not locked' % (self))
 
252
 
 
253
        if self._lock_count > 1:
 
254
            self._lock_count -= 1
 
255
        else:
 
256
            self._lock.unlock()
 
257
            self._lock = None
 
258
            self._lock_mode = self._lock_count = None
 
259
 
 
260
    def abspath(self, name):
 
261
        """Return absolute filename for something in the branch"""
 
262
        return os.path.join(self.base, name)
 
263
 
 
264
    def relpath(self, path):
 
265
        """Return path relative to this branch of something inside it.
 
266
 
 
267
        Raises an error if path is not in this branch."""
 
268
        return _relpath(self.base, path)
 
269
 
 
270
    def controlfilename(self, file_or_path):
 
271
        """Return location relative to branch."""
 
272
        if isinstance(file_or_path, basestring):
 
273
            file_or_path = [file_or_path]
 
274
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
275
 
 
276
 
 
277
    def controlfile(self, file_or_path, mode='r'):
 
278
        """Open a control file for this branch.
 
279
 
 
280
        There are two classes of file in the control directory: text
 
281
        and binary.  binary files are untranslated byte streams.  Text
 
282
        control files are stored with Unix newlines and in UTF-8, even
 
283
        if the platform or locale defaults are different.
 
284
 
 
285
        Controlfiles should almost never be opened in write mode but
 
286
        rather should be atomically copied and replaced using atomicfile.
 
287
        """
 
288
 
 
289
        fn = self.controlfilename(file_or_path)
 
290
 
 
291
        if mode == 'rb' or mode == 'wb':
 
292
            return file(fn, mode)
 
293
        elif mode == 'r' or mode == 'w':
 
294
            # open in binary mode anyhow so there's no newline translation;
 
295
            # codecs uses line buffering by default; don't want that.
 
296
            import codecs
 
297
            return codecs.open(fn, mode + 'b', 'utf-8',
 
298
                               buffering=60000)
 
299
        else:
 
300
            raise BzrError("invalid controlfile mode %r" % mode)
 
301
 
 
302
    def _make_control(self):
 
303
        from bzrlib.inventory import Inventory
 
304
        from bzrlib.xml import pack_xml
 
305
        
 
306
        os.mkdir(self.controlfilename([]))
 
307
        self.controlfile('README', 'w').write(
 
308
            "This is a Bazaar-NG control directory.\n"
 
309
            "Do not change any files in this directory.\n")
 
310
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
311
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
312
            os.mkdir(self.controlfilename(d))
 
313
        for f in ('revision-history', 'merged-patches',
 
314
                  'pending-merged-patches', 'branch-name',
 
315
                  'branch-lock',
 
316
                  'pending-merges'):
 
317
            self.controlfile(f, 'w').write('')
 
318
        mutter('created control directory in ' + self.base)
 
319
 
 
320
        # if we want per-tree root ids then this is the place to set
 
321
        # them; they're not needed for now and so ommitted for
 
322
        # simplicity.
 
323
        pack_xml(Inventory(), self.controlfile('inventory','w'))
 
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.get_inventory_xml(inventory_id))
 
664
 
 
665
 
 
666
    def get_inventory_xml(self, inventory_id):
 
667
        """Get inventory XML as a file object."""
 
668
        return self.inventory_store[inventory_id]
 
669
            
 
670
 
 
671
    def get_inventory_sha1(self, inventory_id):
 
672
        """Return the sha1 hash of the inventory entry
 
673
        """
 
674
        return sha_file(self.get_inventory_xml(inventory_id))
 
675
 
 
676
 
 
677
    def get_revision_inventory(self, revision_id):
 
678
        """Return inventory of a past revision."""
 
679
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
680
        # must be the same as its revision, so this is trivial.
 
681
        if revision_id == None:
 
682
            from bzrlib.inventory import Inventory
 
683
            return Inventory(self.get_root_id())
 
684
        else:
 
685
            return self.get_inventory(revision_id)
 
686
 
 
687
 
 
688
    def revision_history(self):
 
689
        """Return sequence of revision hashes on to this branch.
 
690
 
 
691
        >>> ScratchBranch().revision_history()
 
692
        []
 
693
        """
 
694
        self.lock_read()
 
695
        try:
 
696
            return [l.rstrip('\r\n') for l in
 
697
                    self.controlfile('revision-history', 'r').readlines()]
 
698
        finally:
 
699
            self.unlock()
 
700
 
 
701
 
 
702
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
703
        """
 
704
        >>> import commit
 
705
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
706
        >>> sb.common_ancestor(sb) == (None, None)
 
707
        True
 
708
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
709
        >>> sb.common_ancestor(sb)[0]
 
710
        1
 
711
        >>> clone = sb.clone()
 
712
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
713
        >>> sb.common_ancestor(sb)[0]
 
714
        2
 
715
        >>> sb.common_ancestor(clone)[0]
 
716
        1
 
717
        >>> commit.commit(clone, "Committing divergent second revision", 
 
718
        ...               verbose=False)
 
719
        >>> sb.common_ancestor(clone)[0]
 
720
        1
 
721
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
722
        True
 
723
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
724
        True
 
725
        >>> clone2 = sb.clone()
 
726
        >>> sb.common_ancestor(clone2)[0]
 
727
        2
 
728
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
729
        1
 
730
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
731
        1
 
732
        """
 
733
        my_history = self.revision_history()
 
734
        other_history = other.revision_history()
 
735
        if self_revno is None:
 
736
            self_revno = len(my_history)
 
737
        if other_revno is None:
 
738
            other_revno = len(other_history)
 
739
        indices = range(min((self_revno, other_revno)))
 
740
        indices.reverse()
 
741
        for r in indices:
 
742
            if my_history[r] == other_history[r]:
 
743
                return r+1, my_history[r]
 
744
        return None, None
 
745
 
 
746
 
 
747
    def revno(self):
 
748
        """Return current revision number for this branch.
 
749
 
 
750
        That is equivalent to the number of revisions committed to
 
751
        this branch.
 
752
        """
 
753
        return len(self.revision_history())
 
754
 
 
755
 
 
756
    def last_patch(self):
 
757
        """Return last patch hash, or None if no history.
 
758
        """
 
759
        ph = self.revision_history()
 
760
        if ph:
 
761
            return ph[-1]
 
762
        else:
 
763
            return None
 
764
 
 
765
 
 
766
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
767
        """
 
768
        If self and other have not diverged, return a list of the revisions
 
769
        present in other, but missing from self.
 
770
 
 
771
        >>> from bzrlib.commit import commit
 
772
        >>> bzrlib.trace.silent = True
 
773
        >>> br1 = ScratchBranch()
 
774
        >>> br2 = ScratchBranch()
 
775
        >>> br1.missing_revisions(br2)
 
776
        []
 
777
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
778
        >>> br1.missing_revisions(br2)
 
779
        [u'REVISION-ID-1']
 
780
        >>> br2.missing_revisions(br1)
 
781
        []
 
782
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
783
        >>> br1.missing_revisions(br2)
 
784
        []
 
785
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
786
        >>> br1.missing_revisions(br2)
 
787
        [u'REVISION-ID-2A']
 
788
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
789
        >>> br1.missing_revisions(br2)
 
790
        Traceback (most recent call last):
 
791
        DivergedBranches: These branches have diverged.
 
792
        """
 
793
        self_history = self.revision_history()
 
794
        self_len = len(self_history)
 
795
        other_history = other.revision_history()
 
796
        other_len = len(other_history)
 
797
        common_index = min(self_len, other_len) -1
 
798
        if common_index >= 0 and \
 
799
            self_history[common_index] != other_history[common_index]:
 
800
            raise DivergedBranches(self, other)
 
801
 
 
802
        if stop_revision is None:
 
803
            stop_revision = other_len
 
804
        elif stop_revision > other_len:
 
805
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
806
        
 
807
        return other_history[self_len:stop_revision]
 
808
 
 
809
 
 
810
    def update_revisions(self, other, stop_revision=None):
 
811
        """Pull in all new revisions from other branch.
 
812
        
 
813
        >>> from bzrlib.commit import commit
 
814
        >>> bzrlib.trace.silent = True
 
815
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
816
        >>> br1.add('foo')
 
817
        >>> br1.add('bar')
 
818
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
819
        >>> br2 = ScratchBranch()
 
820
        >>> br2.update_revisions(br1)
 
821
        Added 2 texts.
 
822
        Added 1 inventories.
 
823
        Added 1 revisions.
 
824
        >>> br2.revision_history()
 
825
        [u'REVISION-ID-1']
 
826
        >>> br2.update_revisions(br1)
 
827
        Added 0 texts.
 
828
        Added 0 inventories.
 
829
        Added 0 revisions.
 
830
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
831
        True
 
832
        """
 
833
        progress = bzrlib.ui.ui_factory.progress_bar()
 
834
        progress.update('comparing histories')
 
835
        revision_ids = self.missing_revisions(other, stop_revision)
 
836
        count = self.install_revisions(other, revision_ids, progress=progress)
 
837
        self.append_revision(*revision_ids)
 
838
        print "Added %d revisions." % count
 
839
                    
 
840
 
 
841
    def install_revisions(self, other, revision_ids, progress=None):
 
842
        if hasattr(other.revision_store, "prefetch"):
 
843
            other.revision_store.prefetch(revision_ids)
 
844
        if hasattr(other.inventory_store, "prefetch"):
 
845
            inventory_ids = [other.get_revision(r).inventory_id
 
846
                             for r in revision_ids]
 
847
            other.inventory_store.prefetch(inventory_ids)
 
848
                
 
849
        revisions = []
 
850
        needed_texts = set()
 
851
        i = 0
 
852
        for rev_id in revision_ids:
 
853
            i += 1
 
854
            if progress:
 
855
                progress.update('fetching revision', i, len(revision_ids))
 
856
            rev = other.get_revision(rev_id)
 
857
            revisions.append(rev)
 
858
            inv = other.get_inventory(str(rev.inventory_id))
 
859
            for key, entry in inv.iter_entries():
 
860
                if entry.text_id is None:
 
861
                    continue
 
862
                if entry.text_id not in self.text_store:
 
863
                    needed_texts.add(entry.text_id)
 
864
 
 
865
        if progress:
 
866
            progress.clear()
 
867
                    
 
868
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
869
        print "Added %d texts." % count 
 
870
        inventory_ids = [ f.inventory_id for f in revisions ]
 
871
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
872
                                                inventory_ids)
 
873
        print "Added %d inventories." % count 
 
874
        revision_ids = [ f.revision_id for f in revisions]
 
875
        count = self.revision_store.copy_multi(other.revision_store, 
 
876
                                               revision_ids)
 
877
        return count
 
878
       
 
879
    def commit(self, *args, **kw):
 
880
        from bzrlib.commit import commit
 
881
        commit(self, *args, **kw)
 
882
        
 
883
 
 
884
    def lookup_revision(self, revision):
 
885
        """Return the revision identifier for a given revision information."""
 
886
        revno, info = self.get_revision_info(revision)
 
887
        return info
 
888
 
 
889
    def get_revision_info(self, revision):
 
890
        """Return (revno, revision id) for revision identifier.
 
891
 
 
892
        revision can be an integer, in which case it is assumed to be revno (though
 
893
            this will translate negative values into positive ones)
 
894
        revision can also be a string, in which case it is parsed for something like
 
895
            'date:' or 'revid:' etc.
 
896
        """
 
897
        if revision is None:
 
898
            return 0, None
 
899
        revno = None
 
900
        try:# Convert to int if possible
 
901
            revision = int(revision)
 
902
        except ValueError:
 
903
            pass
 
904
        revs = self.revision_history()
 
905
        if isinstance(revision, int):
 
906
            if revision == 0:
 
907
                return 0, None
 
908
            # Mabye we should do this first, but we don't need it if revision == 0
 
909
            if revision < 0:
 
910
                revno = len(revs) + revision + 1
 
911
            else:
 
912
                revno = revision
 
913
        elif isinstance(revision, basestring):
 
914
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
915
                if revision.startswith(prefix):
 
916
                    revno = func(self, revs, revision)
 
917
                    break
 
918
            else:
 
919
                raise BzrError('No namespace registered for string: %r' % revision)
 
920
 
 
921
        if revno is None or revno <= 0 or revno > len(revs):
 
922
            raise BzrError("no such revision %s" % revision)
 
923
        return revno, revs[revno-1]
 
924
 
 
925
    def _namespace_revno(self, revs, revision):
 
926
        """Lookup a revision by revision number"""
 
927
        assert revision.startswith('revno:')
 
928
        try:
 
929
            return int(revision[6:])
 
930
        except ValueError:
 
931
            return None
 
932
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
933
 
 
934
    def _namespace_revid(self, revs, revision):
 
935
        assert revision.startswith('revid:')
 
936
        try:
 
937
            return revs.index(revision[6:]) + 1
 
938
        except ValueError:
 
939
            return None
 
940
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
941
 
 
942
    def _namespace_last(self, revs, revision):
 
943
        assert revision.startswith('last:')
 
944
        try:
 
945
            offset = int(revision[5:])
 
946
        except ValueError:
 
947
            return None
 
948
        else:
 
949
            if offset <= 0:
 
950
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
951
            return len(revs) - offset + 1
 
952
    REVISION_NAMESPACES['last:'] = _namespace_last
 
953
 
 
954
    def _namespace_tag(self, revs, revision):
 
955
        assert revision.startswith('tag:')
 
956
        raise BzrError('tag: namespace registered, but not implemented.')
 
957
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
958
 
 
959
    def _namespace_date(self, revs, revision):
 
960
        assert revision.startswith('date:')
 
961
        import datetime
 
962
        # Spec for date revisions:
 
963
        #   date:value
 
964
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
965
        #   it can also start with a '+/-/='. '+' says match the first
 
966
        #   entry after the given date. '-' is match the first entry before the date
 
967
        #   '=' is match the first entry after, but still on the given date.
 
968
        #
 
969
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
970
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
971
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
972
        #       May 13th, 2005 at 0:00
 
973
        #
 
974
        #   So the proper way of saying 'give me all entries for today' is:
 
975
        #       -r {date:+today}:{date:-tomorrow}
 
976
        #   The default is '=' when not supplied
 
977
        val = revision[5:]
 
978
        match_style = '='
 
979
        if val[:1] in ('+', '-', '='):
 
980
            match_style = val[:1]
 
981
            val = val[1:]
 
982
 
 
983
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
984
        if val.lower() == 'yesterday':
 
985
            dt = today - datetime.timedelta(days=1)
 
986
        elif val.lower() == 'today':
 
987
            dt = today
 
988
        elif val.lower() == 'tomorrow':
 
989
            dt = today + datetime.timedelta(days=1)
 
990
        else:
 
991
            import re
 
992
            # This should be done outside the function to avoid recompiling it.
 
993
            _date_re = re.compile(
 
994
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
995
                    r'(,|T)?\s*'
 
996
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
997
                )
 
998
            m = _date_re.match(val)
 
999
            if not m or (not m.group('date') and not m.group('time')):
 
1000
                raise BzrError('Invalid revision date %r' % revision)
 
1001
 
 
1002
            if m.group('date'):
 
1003
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
1004
            else:
 
1005
                year, month, day = today.year, today.month, today.day
 
1006
            if m.group('time'):
 
1007
                hour = int(m.group('hour'))
 
1008
                minute = int(m.group('minute'))
 
1009
                if m.group('second'):
 
1010
                    second = int(m.group('second'))
 
1011
                else:
 
1012
                    second = 0
 
1013
            else:
 
1014
                hour, minute, second = 0,0,0
 
1015
 
 
1016
            dt = datetime.datetime(year=year, month=month, day=day,
 
1017
                    hour=hour, minute=minute, second=second)
 
1018
        first = dt
 
1019
        last = None
 
1020
        reversed = False
 
1021
        if match_style == '-':
 
1022
            reversed = True
 
1023
        elif match_style == '=':
 
1024
            last = dt + datetime.timedelta(days=1)
 
1025
 
 
1026
        if reversed:
 
1027
            for i in range(len(revs)-1, -1, -1):
 
1028
                r = self.get_revision(revs[i])
 
1029
                # TODO: Handle timezone.
 
1030
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1031
                if first >= dt and (last is None or dt >= last):
 
1032
                    return i+1
 
1033
        else:
 
1034
            for i in range(len(revs)):
 
1035
                r = self.get_revision(revs[i])
 
1036
                # TODO: Handle timezone.
 
1037
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1038
                if first <= dt and (last is None or dt <= last):
 
1039
                    return i+1
 
1040
    REVISION_NAMESPACES['date:'] = _namespace_date
 
1041
 
 
1042
    def revision_tree(self, revision_id):
 
1043
        """Return Tree for a revision on this branch.
 
1044
 
 
1045
        `revision_id` may be None for the null revision, in which case
 
1046
        an `EmptyTree` is returned."""
 
1047
        # TODO: refactor this to use an existing revision object
 
1048
        # so we don't need to read it in twice.
 
1049
        if revision_id == None:
 
1050
            return EmptyTree()
 
1051
        else:
 
1052
            inv = self.get_revision_inventory(revision_id)
 
1053
            return RevisionTree(self.text_store, inv)
 
1054
 
 
1055
 
 
1056
    def working_tree(self):
 
1057
        """Return a `Tree` for the working copy."""
 
1058
        from workingtree import WorkingTree
 
1059
        return WorkingTree(self.base, self.read_working_inventory())
 
1060
 
 
1061
 
 
1062
    def basis_tree(self):
 
1063
        """Return `Tree` object for last revision.
 
1064
 
 
1065
        If there are no revisions yet, return an `EmptyTree`.
 
1066
        """
 
1067
        r = self.last_patch()
 
1068
        if r == None:
 
1069
            return EmptyTree()
 
1070
        else:
 
1071
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
1072
 
 
1073
 
 
1074
 
 
1075
    def rename_one(self, from_rel, to_rel):
 
1076
        """Rename one file.
 
1077
 
 
1078
        This can change the directory or the filename or both.
 
1079
        """
 
1080
        self.lock_write()
 
1081
        try:
 
1082
            tree = self.working_tree()
 
1083
            inv = tree.inventory
 
1084
            if not tree.has_filename(from_rel):
 
1085
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1086
            if tree.has_filename(to_rel):
 
1087
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1088
 
 
1089
            file_id = inv.path2id(from_rel)
 
1090
            if file_id == None:
 
1091
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1092
 
 
1093
            if inv.path2id(to_rel):
 
1094
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1095
 
 
1096
            to_dir, to_tail = os.path.split(to_rel)
 
1097
            to_dir_id = inv.path2id(to_dir)
 
1098
            if to_dir_id == None and to_dir != '':
 
1099
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1100
 
 
1101
            mutter("rename_one:")
 
1102
            mutter("  file_id    {%s}" % file_id)
 
1103
            mutter("  from_rel   %r" % from_rel)
 
1104
            mutter("  to_rel     %r" % to_rel)
 
1105
            mutter("  to_dir     %r" % to_dir)
 
1106
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1107
 
 
1108
            inv.rename(file_id, to_dir_id, to_tail)
 
1109
 
 
1110
            print "%s => %s" % (from_rel, to_rel)
 
1111
 
 
1112
            from_abs = self.abspath(from_rel)
 
1113
            to_abs = self.abspath(to_rel)
 
1114
            try:
 
1115
                os.rename(from_abs, to_abs)
 
1116
            except OSError, e:
 
1117
                raise BzrError("failed to rename %r to %r: %s"
 
1118
                        % (from_abs, to_abs, e[1]),
 
1119
                        ["rename rolled back"])
 
1120
 
 
1121
            self._write_inventory(inv)
 
1122
        finally:
 
1123
            self.unlock()
 
1124
 
 
1125
 
 
1126
    def move(self, from_paths, to_name):
 
1127
        """Rename files.
 
1128
 
 
1129
        to_name must exist as a versioned directory.
 
1130
 
 
1131
        If to_name exists and is a directory, the files are moved into
 
1132
        it, keeping their old names.  If it is a directory, 
 
1133
 
 
1134
        Note that to_name is only the last component of the new name;
 
1135
        this doesn't change the directory.
 
1136
        """
 
1137
        self.lock_write()
 
1138
        try:
 
1139
            ## TODO: Option to move IDs only
 
1140
            assert not isinstance(from_paths, basestring)
 
1141
            tree = self.working_tree()
 
1142
            inv = tree.inventory
 
1143
            to_abs = self.abspath(to_name)
 
1144
            if not isdir(to_abs):
 
1145
                raise BzrError("destination %r is not a directory" % to_abs)
 
1146
            if not tree.has_filename(to_name):
 
1147
                raise BzrError("destination %r not in working directory" % to_abs)
 
1148
            to_dir_id = inv.path2id(to_name)
 
1149
            if to_dir_id == None and to_name != '':
 
1150
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1151
            to_dir_ie = inv[to_dir_id]
 
1152
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1153
                raise BzrError("destination %r is not a directory" % to_abs)
 
1154
 
 
1155
            to_idpath = inv.get_idpath(to_dir_id)
 
1156
 
 
1157
            for f in from_paths:
 
1158
                if not tree.has_filename(f):
 
1159
                    raise BzrError("%r does not exist in working tree" % f)
 
1160
                f_id = inv.path2id(f)
 
1161
                if f_id == None:
 
1162
                    raise BzrError("%r is not versioned" % f)
 
1163
                name_tail = splitpath(f)[-1]
 
1164
                dest_path = appendpath(to_name, name_tail)
 
1165
                if tree.has_filename(dest_path):
 
1166
                    raise BzrError("destination %r already exists" % dest_path)
 
1167
                if f_id in to_idpath:
 
1168
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1169
 
 
1170
            # OK, so there's a race here, it's possible that someone will
 
1171
            # create a file in this interval and then the rename might be
 
1172
            # left half-done.  But we should have caught most problems.
 
1173
 
 
1174
            for f in from_paths:
 
1175
                name_tail = splitpath(f)[-1]
 
1176
                dest_path = appendpath(to_name, name_tail)
 
1177
                print "%s => %s" % (f, dest_path)
 
1178
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1179
                try:
 
1180
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1181
                except OSError, e:
 
1182
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1183
                            ["rename rolled back"])
 
1184
 
 
1185
            self._write_inventory(inv)
 
1186
        finally:
 
1187
            self.unlock()
 
1188
 
 
1189
 
 
1190
    def revert(self, filenames, old_tree=None, backups=True):
 
1191
        """Restore selected files to the versions from a previous tree.
 
1192
 
 
1193
        backups
 
1194
            If true (default) backups are made of files before
 
1195
            they're renamed.
 
1196
        """
 
1197
        from bzrlib.errors import NotVersionedError, BzrError
 
1198
        from bzrlib.atomicfile import AtomicFile
 
1199
        from bzrlib.osutils import backup_file
 
1200
        
 
1201
        inv = self.read_working_inventory()
 
1202
        if old_tree is None:
 
1203
            old_tree = self.basis_tree()
 
1204
        old_inv = old_tree.inventory
 
1205
 
 
1206
        nids = []
 
1207
        for fn in filenames:
 
1208
            file_id = inv.path2id(fn)
 
1209
            if not file_id:
 
1210
                raise NotVersionedError("not a versioned file", fn)
 
1211
            if not old_inv.has_id(file_id):
 
1212
                raise BzrError("file not present in old tree", fn, file_id)
 
1213
            nids.append((fn, file_id))
 
1214
            
 
1215
        # TODO: Rename back if it was previously at a different location
 
1216
 
 
1217
        # TODO: If given a directory, restore the entire contents from
 
1218
        # the previous version.
 
1219
 
 
1220
        # TODO: Make a backup to a temporary file.
 
1221
 
 
1222
        # TODO: If the file previously didn't exist, delete it?
 
1223
        for fn, file_id in nids:
 
1224
            backup_file(fn)
 
1225
            
 
1226
            f = AtomicFile(fn, 'wb')
 
1227
            try:
 
1228
                f.write(old_tree.get_file(file_id).read())
 
1229
                f.commit()
 
1230
            finally:
 
1231
                f.close()
 
1232
 
 
1233
 
 
1234
    def pending_merges(self):
 
1235
        """Return a list of pending merges.
 
1236
 
 
1237
        These are revisions that have been merged into the working
 
1238
        directory but not yet committed.
 
1239
        """
 
1240
        cfn = self.controlfilename('pending-merges')
 
1241
        if not os.path.exists(cfn):
 
1242
            return []
 
1243
        p = []
 
1244
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1245
            p.append(l.rstrip('\n'))
 
1246
        return p
 
1247
 
 
1248
 
 
1249
    def add_pending_merge(self, revision_id):
 
1250
        from bzrlib.revision import validate_revision_id
 
1251
 
 
1252
        validate_revision_id(revision_id)
 
1253
 
 
1254
        p = self.pending_merges()
 
1255
        if revision_id in p:
 
1256
            return
 
1257
        p.append(revision_id)
 
1258
        self.set_pending_merges(p)
 
1259
 
 
1260
 
 
1261
    def set_pending_merges(self, rev_list):
 
1262
        from bzrlib.atomicfile import AtomicFile
 
1263
        self.lock_write()
 
1264
        try:
 
1265
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1266
            try:
 
1267
                for l in rev_list:
 
1268
                    print >>f, l
 
1269
                f.commit()
 
1270
            finally:
 
1271
                f.close()
 
1272
        finally:
 
1273
            self.unlock()
 
1274
 
 
1275
 
 
1276
 
 
1277
class ScratchBranch(Branch):
 
1278
    """Special test class: a branch that cleans up after itself.
 
1279
 
 
1280
    >>> b = ScratchBranch()
 
1281
    >>> isdir(b.base)
 
1282
    True
 
1283
    >>> bd = b.base
 
1284
    >>> b.destroy()
 
1285
    >>> isdir(bd)
 
1286
    False
 
1287
    """
 
1288
    def __init__(self, files=[], dirs=[], base=None):
 
1289
        """Make a test branch.
 
1290
 
 
1291
        This creates a temporary directory and runs init-tree in it.
 
1292
 
 
1293
        If any files are listed, they are created in the working copy.
 
1294
        """
 
1295
        from tempfile import mkdtemp
 
1296
        init = False
 
1297
        if base is None:
 
1298
            base = mkdtemp()
 
1299
            init = True
 
1300
        Branch.__init__(self, base, init=init)
 
1301
        for d in dirs:
 
1302
            os.mkdir(self.abspath(d))
 
1303
            
 
1304
        for f in files:
 
1305
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1306
 
 
1307
 
 
1308
    def clone(self):
 
1309
        """
 
1310
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1311
        >>> clone = orig.clone()
 
1312
        >>> os.path.samefile(orig.base, clone.base)
 
1313
        False
 
1314
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1315
        True
 
1316
        """
 
1317
        from shutil import copytree
 
1318
        from tempfile import mkdtemp
 
1319
        base = mkdtemp()
 
1320
        os.rmdir(base)
 
1321
        copytree(self.base, base, symlinks=True)
 
1322
        return ScratchBranch(base=base)
 
1323
        
 
1324
    def __del__(self):
 
1325
        self.destroy()
 
1326
 
 
1327
    def destroy(self):
 
1328
        """Destroy the test branch, removing the scratch directory."""
 
1329
        from shutil import rmtree
 
1330
        try:
 
1331
            if self.base:
 
1332
                mutter("delete ScratchBranch %s" % self.base)
 
1333
                rmtree(self.base)
 
1334
        except OSError, e:
 
1335
            # Work around for shutil.rmtree failing on Windows when
 
1336
            # readonly files are encountered
 
1337
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1338
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1339
                for name in files:
 
1340
                    os.chmod(os.path.join(root, name), 0700)
 
1341
            rmtree(self.base)
 
1342
        self.base = None
 
1343
 
 
1344
    
 
1345
 
 
1346
######################################################################
 
1347
# predicates
 
1348
 
 
1349
 
 
1350
def is_control_file(filename):
 
1351
    ## FIXME: better check
 
1352
    filename = os.path.normpath(filename)
 
1353
    while filename != '':
 
1354
        head, tail = os.path.split(filename)
 
1355
        ## mutter('check %r for control file' % ((head, tail), ))
 
1356
        if tail == bzrlib.BZRDIR:
 
1357
            return True
 
1358
        if filename == head:
 
1359
            break
 
1360
        filename = head
 
1361
    return False
 
1362
 
 
1363
 
 
1364
 
 
1365
def gen_file_id(name):
 
1366
    """Return new file id.
 
1367
 
 
1368
    This should probably generate proper UUIDs, but for the moment we
 
1369
    cope with just randomness because running uuidgen every time is
 
1370
    slow."""
 
1371
    import re
 
1372
    from binascii import hexlify
 
1373
    from time import time
 
1374
 
 
1375
    # get last component
 
1376
    idx = name.rfind('/')
 
1377
    if idx != -1:
 
1378
        name = name[idx+1 : ]
 
1379
    idx = name.rfind('\\')
 
1380
    if idx != -1:
 
1381
        name = name[idx+1 : ]
 
1382
 
 
1383
    # make it not a hidden file
 
1384
    name = name.lstrip('.')
 
1385
 
 
1386
    # remove any wierd characters; we don't escape them but rather
 
1387
    # just pull them out
 
1388
    name = re.sub(r'[^\w.]', '', name)
 
1389
 
 
1390
    s = hexlify(rand_bytes(8))
 
1391
    return '-'.join((name, compact_date(time()), s))
 
1392
 
 
1393
 
 
1394
def gen_root_id():
 
1395
    """Return a new tree-root file id."""
 
1396
    return gen_file_id('TREE_ROOT')
 
1397