/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-24 08:59:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050824085932-c61f1f1f1c930e13
- Add a simple UIFactory 

  The idea of this is to let a client of bzrlib set some 
  policy about how output is displayed.

  In this revision all that's done is that progress bars
  are constructed by a policy established by the application
  rather than being randomly constructed in the library 
  or passed down the calls.  This avoids progress bars
  popping up while running the test suite and cleans up
  some code.

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