/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-09-13 01:40:45 UTC
  • Revision ID: mbp@sourcefrog.net-20050913014045-49f65739c33df949
- v5 xml no longer stores redundant inventory_id

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