/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-09-16 06:21:56 UTC
  • Revision ID: mbp@sourcefrog.net-20050916062156-cacf627b0d2edb22
- enable and disable more ancestry tests

Show diffs side-by-side

added added

removed removed

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