/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:12:11 UTC
  • Revision ID: mbp@sourcefrog.net-20050913011211-47c8a4f18ac40dda
- fix up import
- fix creation of test directory
- shorten test directory names by removing __main__

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 install_revisions(self, other, revision_ids, pb):
 
827
        """Copy revisions from other branch into self.
 
828
 
 
829
        This is a lower-level function used by a pull or a merge.  It
 
830
        incorporates some history from one branch into another, but
 
831
        does not update the revision history or operate on the working
 
832
        copy.
 
833
 
 
834
        revision_ids
 
835
            Sequence of revisions to copy.
 
836
 
 
837
        pb
 
838
            Progress bar for copying.
 
839
        """
 
840
        if False:
 
841
            if hasattr(other.revision_store, "prefetch"):
 
842
                other.revision_store.prefetch(revision_ids)
 
843
            if hasattr(other.inventory_store, "prefetch"):
 
844
                other.inventory_store.prefetch(revision_ids)
 
845
 
 
846
        if pb is None:
 
847
            pb = bzrlib.ui.ui_factory.progress_bar()
 
848
                
 
849
        revisions = []
 
850
        needed_texts = set()
 
851
        i = 0
 
852
 
 
853
        failures = set()
 
854
        for i, rev_id in enumerate(revision_ids):
 
855
            pb.update('fetching revision', i+1, len(revision_ids))
 
856
            try:
 
857
                rev = other.get_revision(rev_id)
 
858
            except bzrlib.errors.NoSuchRevision:
 
859
                failures.add(rev_id)
 
860
                continue
 
861
 
 
862
            revisions.append(rev)
 
863
            inv = other.get_inventory(rev_id)
 
864
            for key, entry in inv.iter_entries():
 
865
                if entry.text_id is None:
 
866
                    continue
 
867
                if entry.text_id not in self.text_store:
 
868
                    needed_texts.add(entry.text_id)
 
869
 
 
870
        pb.clear()
 
871
                    
 
872
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
 
873
                                                    needed_texts)
 
874
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
 
875
                                                         revision_ids)
 
876
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
 
877
                                                        revision_ids,
 
878
                                                        permit_failure=True)
 
879
        assert len(cp_fail) == 0 
 
880
        return count, failures
 
881
       
 
882
 
 
883
    def commit(self, *args, **kw):
 
884
        from bzrlib.commit import Commit
 
885
        Commit().commit(self, *args, **kw)
 
886
        
 
887
 
 
888
    def lookup_revision(self, revision):
 
889
        """Return the revision identifier for a given revision information."""
 
890
        revno, info = self._get_revision_info(revision)
 
891
        return info
 
892
 
 
893
 
 
894
    def revision_id_to_revno(self, revision_id):
 
895
        """Given a revision id, return its revno"""
 
896
        history = self.revision_history()
 
897
        try:
 
898
            return history.index(revision_id) + 1
 
899
        except ValueError:
 
900
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
901
 
 
902
 
 
903
    def get_revision_info(self, revision):
 
904
        """Return (revno, revision id) for revision identifier.
 
905
 
 
906
        revision can be an integer, in which case it is assumed to be revno (though
 
907
            this will translate negative values into positive ones)
 
908
        revision can also be a string, in which case it is parsed for something like
 
909
            'date:' or 'revid:' etc.
 
910
        """
 
911
        revno, rev_id = self._get_revision_info(revision)
 
912
        if revno is None:
 
913
            raise bzrlib.errors.NoSuchRevision(self, revision)
 
914
        return revno, rev_id
 
915
 
 
916
    def get_rev_id(self, revno, history=None):
 
917
        """Find the revision id of the specified revno."""
 
918
        if revno == 0:
 
919
            return None
 
920
        if history is None:
 
921
            history = self.revision_history()
 
922
        elif revno <= 0 or revno > len(history):
 
923
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
924
        return history[revno - 1]
 
925
 
 
926
    def _get_revision_info(self, revision):
 
927
        """Return (revno, revision id) for revision specifier.
 
928
 
 
929
        revision can be an integer, in which case it is assumed to be revno
 
930
        (though this will translate negative values into positive ones)
 
931
        revision can also be a string, in which case it is parsed for something
 
932
        like 'date:' or 'revid:' etc.
 
933
 
 
934
        A revid is always returned.  If it is None, the specifier referred to
 
935
        the null revision.  If the revid does not occur in the revision
 
936
        history, revno will be None.
 
937
        """
 
938
        
 
939
        if revision is None:
 
940
            return 0, None
 
941
        revno = None
 
942
        try:# Convert to int if possible
 
943
            revision = int(revision)
 
944
        except ValueError:
 
945
            pass
 
946
        revs = self.revision_history()
 
947
        if isinstance(revision, int):
 
948
            if revision < 0:
 
949
                revno = len(revs) + revision + 1
 
950
            else:
 
951
                revno = revision
 
952
            rev_id = self.get_rev_id(revno, revs)
 
953
        elif isinstance(revision, basestring):
 
954
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
955
                if revision.startswith(prefix):
 
956
                    result = func(self, revs, revision)
 
957
                    if len(result) > 1:
 
958
                        revno, rev_id = result
 
959
                    else:
 
960
                        revno = result[0]
 
961
                        rev_id = self.get_rev_id(revno, revs)
 
962
                    break
 
963
            else:
 
964
                raise BzrError('No namespace registered for string: %r' %
 
965
                               revision)
 
966
        else:
 
967
            raise TypeError('Unhandled revision type %s' % revision)
 
968
 
 
969
        if revno is None:
 
970
            if rev_id is None:
 
971
                raise bzrlib.errors.NoSuchRevision(self, revision)
 
972
        return revno, rev_id
 
973
 
 
974
    def _namespace_revno(self, revs, revision):
 
975
        """Lookup a revision by revision number"""
 
976
        assert revision.startswith('revno:')
 
977
        try:
 
978
            return (int(revision[6:]),)
 
979
        except ValueError:
 
980
            return None
 
981
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
982
 
 
983
    def _namespace_revid(self, revs, revision):
 
984
        assert revision.startswith('revid:')
 
985
        rev_id = revision[len('revid:'):]
 
986
        try:
 
987
            return revs.index(rev_id) + 1, rev_id
 
988
        except ValueError:
 
989
            return None, rev_id
 
990
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
991
 
 
992
    def _namespace_last(self, revs, revision):
 
993
        assert revision.startswith('last:')
 
994
        try:
 
995
            offset = int(revision[5:])
 
996
        except ValueError:
 
997
            return (None,)
 
998
        else:
 
999
            if offset <= 0:
 
1000
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
1001
            return (len(revs) - offset + 1,)
 
1002
    REVISION_NAMESPACES['last:'] = _namespace_last
 
1003
 
 
1004
    def _namespace_tag(self, revs, revision):
 
1005
        assert revision.startswith('tag:')
 
1006
        raise BzrError('tag: namespace registered, but not implemented.')
 
1007
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
1008
 
 
1009
    def _namespace_date(self, revs, revision):
 
1010
        assert revision.startswith('date:')
 
1011
        import datetime
 
1012
        # Spec for date revisions:
 
1013
        #   date:value
 
1014
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
1015
        #   it can also start with a '+/-/='. '+' says match the first
 
1016
        #   entry after the given date. '-' is match the first entry before the date
 
1017
        #   '=' is match the first entry after, but still on the given date.
 
1018
        #
 
1019
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
1020
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
1021
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
1022
        #       May 13th, 2005 at 0:00
 
1023
        #
 
1024
        #   So the proper way of saying 'give me all entries for today' is:
 
1025
        #       -r {date:+today}:{date:-tomorrow}
 
1026
        #   The default is '=' when not supplied
 
1027
        val = revision[5:]
 
1028
        match_style = '='
 
1029
        if val[:1] in ('+', '-', '='):
 
1030
            match_style = val[:1]
 
1031
            val = val[1:]
 
1032
 
 
1033
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
1034
        if val.lower() == 'yesterday':
 
1035
            dt = today - datetime.timedelta(days=1)
 
1036
        elif val.lower() == 'today':
 
1037
            dt = today
 
1038
        elif val.lower() == 'tomorrow':
 
1039
            dt = today + datetime.timedelta(days=1)
 
1040
        else:
 
1041
            import re
 
1042
            # This should be done outside the function to avoid recompiling it.
 
1043
            _date_re = re.compile(
 
1044
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
1045
                    r'(,|T)?\s*'
 
1046
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
1047
                )
 
1048
            m = _date_re.match(val)
 
1049
            if not m or (not m.group('date') and not m.group('time')):
 
1050
                raise BzrError('Invalid revision date %r' % revision)
 
1051
 
 
1052
            if m.group('date'):
 
1053
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
1054
            else:
 
1055
                year, month, day = today.year, today.month, today.day
 
1056
            if m.group('time'):
 
1057
                hour = int(m.group('hour'))
 
1058
                minute = int(m.group('minute'))
 
1059
                if m.group('second'):
 
1060
                    second = int(m.group('second'))
 
1061
                else:
 
1062
                    second = 0
 
1063
            else:
 
1064
                hour, minute, second = 0,0,0
 
1065
 
 
1066
            dt = datetime.datetime(year=year, month=month, day=day,
 
1067
                    hour=hour, minute=minute, second=second)
 
1068
        first = dt
 
1069
        last = None
 
1070
        reversed = False
 
1071
        if match_style == '-':
 
1072
            reversed = True
 
1073
        elif match_style == '=':
 
1074
            last = dt + datetime.timedelta(days=1)
 
1075
 
 
1076
        if reversed:
 
1077
            for i in range(len(revs)-1, -1, -1):
 
1078
                r = self.get_revision(revs[i])
 
1079
                # TODO: Handle timezone.
 
1080
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1081
                if first >= dt and (last is None or dt >= last):
 
1082
                    return (i+1,)
 
1083
        else:
 
1084
            for i in range(len(revs)):
 
1085
                r = self.get_revision(revs[i])
 
1086
                # TODO: Handle timezone.
 
1087
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1088
                if first <= dt and (last is None or dt <= last):
 
1089
                    return (i+1,)
 
1090
    REVISION_NAMESPACES['date:'] = _namespace_date
 
1091
 
 
1092
    def revision_tree(self, revision_id):
 
1093
        """Return Tree for a revision on this branch.
 
1094
 
 
1095
        `revision_id` may be None for the null revision, in which case
 
1096
        an `EmptyTree` is returned."""
 
1097
        # TODO: refactor this to use an existing revision object
 
1098
        # so we don't need to read it in twice.
 
1099
        if revision_id == None:
 
1100
            return EmptyTree()
 
1101
        else:
 
1102
            inv = self.get_revision_inventory(revision_id)
 
1103
            return RevisionTree(self.weave_store, inv, revision_id)
 
1104
 
 
1105
 
 
1106
    def working_tree(self):
 
1107
        """Return a `Tree` for the working copy."""
 
1108
        from workingtree import WorkingTree
 
1109
        return WorkingTree(self.base, self.read_working_inventory())
 
1110
 
 
1111
 
 
1112
    def basis_tree(self):
 
1113
        """Return `Tree` object for last revision.
 
1114
 
 
1115
        If there are no revisions yet, return an `EmptyTree`.
 
1116
        """
 
1117
        return self.revision_tree(self.last_patch())
 
1118
 
 
1119
 
 
1120
    def rename_one(self, from_rel, to_rel):
 
1121
        """Rename one file.
 
1122
 
 
1123
        This can change the directory or the filename or both.
 
1124
        """
 
1125
        self.lock_write()
 
1126
        try:
 
1127
            tree = self.working_tree()
 
1128
            inv = tree.inventory
 
1129
            if not tree.has_filename(from_rel):
 
1130
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1131
            if tree.has_filename(to_rel):
 
1132
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1133
 
 
1134
            file_id = inv.path2id(from_rel)
 
1135
            if file_id == None:
 
1136
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1137
 
 
1138
            if inv.path2id(to_rel):
 
1139
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1140
 
 
1141
            to_dir, to_tail = os.path.split(to_rel)
 
1142
            to_dir_id = inv.path2id(to_dir)
 
1143
            if to_dir_id == None and to_dir != '':
 
1144
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1145
 
 
1146
            mutter("rename_one:")
 
1147
            mutter("  file_id    {%s}" % file_id)
 
1148
            mutter("  from_rel   %r" % from_rel)
 
1149
            mutter("  to_rel     %r" % to_rel)
 
1150
            mutter("  to_dir     %r" % to_dir)
 
1151
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1152
 
 
1153
            inv.rename(file_id, to_dir_id, to_tail)
 
1154
 
 
1155
            from_abs = self.abspath(from_rel)
 
1156
            to_abs = self.abspath(to_rel)
 
1157
            try:
 
1158
                os.rename(from_abs, to_abs)
 
1159
            except OSError, e:
 
1160
                raise BzrError("failed to rename %r to %r: %s"
 
1161
                        % (from_abs, to_abs, e[1]),
 
1162
                        ["rename rolled back"])
 
1163
 
 
1164
            self._write_inventory(inv)
 
1165
        finally:
 
1166
            self.unlock()
 
1167
 
 
1168
 
 
1169
    def move(self, from_paths, to_name):
 
1170
        """Rename files.
 
1171
 
 
1172
        to_name must exist as a versioned directory.
 
1173
 
 
1174
        If to_name exists and is a directory, the files are moved into
 
1175
        it, keeping their old names.  If it is a directory, 
 
1176
 
 
1177
        Note that to_name is only the last component of the new name;
 
1178
        this doesn't change the directory.
 
1179
 
 
1180
        This returns a list of (from_path, to_path) pairs for each
 
1181
        entry that is moved.
 
1182
        """
 
1183
        result = []
 
1184
        self.lock_write()
 
1185
        try:
 
1186
            ## TODO: Option to move IDs only
 
1187
            assert not isinstance(from_paths, basestring)
 
1188
            tree = self.working_tree()
 
1189
            inv = tree.inventory
 
1190
            to_abs = self.abspath(to_name)
 
1191
            if not isdir(to_abs):
 
1192
                raise BzrError("destination %r is not a directory" % to_abs)
 
1193
            if not tree.has_filename(to_name):
 
1194
                raise BzrError("destination %r not in working directory" % to_abs)
 
1195
            to_dir_id = inv.path2id(to_name)
 
1196
            if to_dir_id == None and to_name != '':
 
1197
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1198
            to_dir_ie = inv[to_dir_id]
 
1199
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1200
                raise BzrError("destination %r is not a directory" % to_abs)
 
1201
 
 
1202
            to_idpath = inv.get_idpath(to_dir_id)
 
1203
 
 
1204
            for f in from_paths:
 
1205
                if not tree.has_filename(f):
 
1206
                    raise BzrError("%r does not exist in working tree" % f)
 
1207
                f_id = inv.path2id(f)
 
1208
                if f_id == None:
 
1209
                    raise BzrError("%r is not versioned" % f)
 
1210
                name_tail = splitpath(f)[-1]
 
1211
                dest_path = appendpath(to_name, name_tail)
 
1212
                if tree.has_filename(dest_path):
 
1213
                    raise BzrError("destination %r already exists" % dest_path)
 
1214
                if f_id in to_idpath:
 
1215
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1216
 
 
1217
            # OK, so there's a race here, it's possible that someone will
 
1218
            # create a file in this interval and then the rename might be
 
1219
            # left half-done.  But we should have caught most problems.
 
1220
 
 
1221
            for f in from_paths:
 
1222
                name_tail = splitpath(f)[-1]
 
1223
                dest_path = appendpath(to_name, name_tail)
 
1224
                result.append((f, dest_path))
 
1225
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1226
                try:
 
1227
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1228
                except OSError, e:
 
1229
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1230
                            ["rename rolled back"])
 
1231
 
 
1232
            self._write_inventory(inv)
 
1233
        finally:
 
1234
            self.unlock()
 
1235
 
 
1236
        return result
 
1237
 
 
1238
 
 
1239
    def revert(self, filenames, old_tree=None, backups=True):
 
1240
        """Restore selected files to the versions from a previous tree.
 
1241
 
 
1242
        backups
 
1243
            If true (default) backups are made of files before
 
1244
            they're renamed.
 
1245
        """
 
1246
        from bzrlib.errors import NotVersionedError, BzrError
 
1247
        from bzrlib.atomicfile import AtomicFile
 
1248
        from bzrlib.osutils import backup_file
 
1249
        
 
1250
        inv = self.read_working_inventory()
 
1251
        if old_tree is None:
 
1252
            old_tree = self.basis_tree()
 
1253
        old_inv = old_tree.inventory
 
1254
 
 
1255
        nids = []
 
1256
        for fn in filenames:
 
1257
            file_id = inv.path2id(fn)
 
1258
            if not file_id:
 
1259
                raise NotVersionedError("not a versioned file", fn)
 
1260
            if not old_inv.has_id(file_id):
 
1261
                raise BzrError("file not present in old tree", fn, file_id)
 
1262
            nids.append((fn, file_id))
 
1263
            
 
1264
        # TODO: Rename back if it was previously at a different location
 
1265
 
 
1266
        # TODO: If given a directory, restore the entire contents from
 
1267
        # the previous version.
 
1268
 
 
1269
        # TODO: Make a backup to a temporary file.
 
1270
 
 
1271
        # TODO: If the file previously didn't exist, delete it?
 
1272
        for fn, file_id in nids:
 
1273
            backup_file(fn)
 
1274
            
 
1275
            f = AtomicFile(fn, 'wb')
 
1276
            try:
 
1277
                f.write(old_tree.get_file(file_id).read())
 
1278
                f.commit()
 
1279
            finally:
 
1280
                f.close()
 
1281
 
 
1282
 
 
1283
    def pending_merges(self):
 
1284
        """Return a list of pending merges.
 
1285
 
 
1286
        These are revisions that have been merged into the working
 
1287
        directory but not yet committed.
 
1288
        """
 
1289
        cfn = self.controlfilename('pending-merges')
 
1290
        if not os.path.exists(cfn):
 
1291
            return []
 
1292
        p = []
 
1293
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1294
            p.append(l.rstrip('\n'))
 
1295
        return p
 
1296
 
 
1297
 
 
1298
    def add_pending_merge(self, revision_id):
 
1299
        from bzrlib.revision import validate_revision_id
 
1300
 
 
1301
        validate_revision_id(revision_id)
 
1302
 
 
1303
        p = self.pending_merges()
 
1304
        if revision_id in p:
 
1305
            return
 
1306
        p.append(revision_id)
 
1307
        self.set_pending_merges(p)
 
1308
 
 
1309
 
 
1310
    def set_pending_merges(self, rev_list):
 
1311
        from bzrlib.atomicfile import AtomicFile
 
1312
        self.lock_write()
 
1313
        try:
 
1314
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1315
            try:
 
1316
                for l in rev_list:
 
1317
                    print >>f, l
 
1318
                f.commit()
 
1319
            finally:
 
1320
                f.close()
 
1321
        finally:
 
1322
            self.unlock()
 
1323
 
 
1324
 
 
1325
    def get_parent(self):
 
1326
        """Return the parent location of the branch.
 
1327
 
 
1328
        This is the default location for push/pull/missing.  The usual
 
1329
        pattern is that the user can override it by specifying a
 
1330
        location.
 
1331
        """
 
1332
        import errno
 
1333
        _locs = ['parent', 'pull', 'x-pull']
 
1334
        for l in _locs:
 
1335
            try:
 
1336
                return self.controlfile(l, 'r').read().strip('\n')
 
1337
            except IOError, e:
 
1338
                if e.errno != errno.ENOENT:
 
1339
                    raise
 
1340
        return None
 
1341
 
 
1342
 
 
1343
    def set_parent(self, url):
 
1344
        # TODO: Maybe delete old location files?
 
1345
        from bzrlib.atomicfile import AtomicFile
 
1346
        self.lock_write()
 
1347
        try:
 
1348
            f = AtomicFile(self.controlfilename('parent'))
 
1349
            try:
 
1350
                f.write(url + '\n')
 
1351
                f.commit()
 
1352
            finally:
 
1353
                f.close()
 
1354
        finally:
 
1355
            self.unlock()
 
1356
 
 
1357
    def check_revno(self, revno):
 
1358
        """\
 
1359
        Check whether a revno corresponds to any revision.
 
1360
        Zero (the NULL revision) is considered valid.
 
1361
        """
 
1362
        if revno != 0:
 
1363
            self.check_real_revno(revno)
 
1364
            
 
1365
    def check_real_revno(self, revno):
 
1366
        """\
 
1367
        Check whether a revno corresponds to a real revision.
 
1368
        Zero (the NULL revision) is considered invalid
 
1369
        """
 
1370
        if revno < 1 or revno > self.revno():
 
1371
            raise InvalidRevisionNumber(revno)
 
1372
        
 
1373
        
 
1374
 
 
1375
 
 
1376
class ScratchBranch(Branch):
 
1377
    """Special test class: a branch that cleans up after itself.
 
1378
 
 
1379
    >>> b = ScratchBranch()
 
1380
    >>> isdir(b.base)
 
1381
    True
 
1382
    >>> bd = b.base
 
1383
    >>> b.destroy()
 
1384
    >>> isdir(bd)
 
1385
    False
 
1386
    """
 
1387
    def __init__(self, files=[], dirs=[], base=None):
 
1388
        """Make a test branch.
 
1389
 
 
1390
        This creates a temporary directory and runs init-tree in it.
 
1391
 
 
1392
        If any files are listed, they are created in the working copy.
 
1393
        """
 
1394
        from tempfile import mkdtemp
 
1395
        init = False
 
1396
        if base is None:
 
1397
            base = mkdtemp()
 
1398
            init = True
 
1399
        Branch.__init__(self, base, init=init)
 
1400
        for d in dirs:
 
1401
            os.mkdir(self.abspath(d))
 
1402
            
 
1403
        for f in files:
 
1404
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1405
 
 
1406
 
 
1407
    def clone(self):
 
1408
        """
 
1409
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1410
        >>> clone = orig.clone()
 
1411
        >>> os.path.samefile(orig.base, clone.base)
 
1412
        False
 
1413
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1414
        True
 
1415
        """
 
1416
        from shutil import copytree
 
1417
        from tempfile import mkdtemp
 
1418
        base = mkdtemp()
 
1419
        os.rmdir(base)
 
1420
        copytree(self.base, base, symlinks=True)
 
1421
        return ScratchBranch(base=base)
 
1422
 
 
1423
 
 
1424
        
 
1425
    def __del__(self):
 
1426
        self.destroy()
 
1427
 
 
1428
    def destroy(self):
 
1429
        """Destroy the test branch, removing the scratch directory."""
 
1430
        from shutil import rmtree
 
1431
        try:
 
1432
            if self.base:
 
1433
                mutter("delete ScratchBranch %s" % self.base)
 
1434
                rmtree(self.base)
 
1435
        except OSError, e:
 
1436
            # Work around for shutil.rmtree failing on Windows when
 
1437
            # readonly files are encountered
 
1438
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1439
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1440
                for name in files:
 
1441
                    os.chmod(os.path.join(root, name), 0700)
 
1442
            rmtree(self.base)
 
1443
        self.base = None
 
1444
 
 
1445
    
 
1446
 
 
1447
######################################################################
 
1448
# predicates
 
1449
 
 
1450
 
 
1451
def is_control_file(filename):
 
1452
    ## FIXME: better check
 
1453
    filename = os.path.normpath(filename)
 
1454
    while filename != '':
 
1455
        head, tail = os.path.split(filename)
 
1456
        ## mutter('check %r for control file' % ((head, tail), ))
 
1457
        if tail == bzrlib.BZRDIR:
 
1458
            return True
 
1459
        if filename == head:
 
1460
            break
 
1461
        filename = head
 
1462
    return False
 
1463
 
 
1464
 
 
1465
 
 
1466
def gen_file_id(name):
 
1467
    """Return new file id.
 
1468
 
 
1469
    This should probably generate proper UUIDs, but for the moment we
 
1470
    cope with just randomness because running uuidgen every time is
 
1471
    slow."""
 
1472
    import re
 
1473
    from binascii import hexlify
 
1474
    from time import time
 
1475
 
 
1476
    # get last component
 
1477
    idx = name.rfind('/')
 
1478
    if idx != -1:
 
1479
        name = name[idx+1 : ]
 
1480
    idx = name.rfind('\\')
 
1481
    if idx != -1:
 
1482
        name = name[idx+1 : ]
 
1483
 
 
1484
    # make it not a hidden file
 
1485
    name = name.lstrip('.')
 
1486
 
 
1487
    # remove any wierd characters; we don't escape them but rather
 
1488
    # just pull them out
 
1489
    name = re.sub(r'[^\w.]', '', name)
 
1490
 
 
1491
    s = hexlify(rand_bytes(8))
 
1492
    return '-'.join((name, compact_date(time()), s))
 
1493
 
 
1494
 
 
1495
def gen_root_id():
 
1496
    """Return a new tree-root file id."""
 
1497
    return gen_file_id('TREE_ROOT')
 
1498
 
 
1499
 
 
1500
def pull_loc(branch):
 
1501
    # TODO: Should perhaps just make attribute be 'base' in
 
1502
    # RemoteBranch and Branch?
 
1503
    if hasattr(branch, "baseurl"):
 
1504
        return branch.baseurl
 
1505
    else:
 
1506
        return branch.base
 
1507
 
 
1508
 
 
1509
def copy_branch(branch_from, to_location, revision=None):
 
1510
    """Copy branch_from into the existing directory to_location.
 
1511
 
 
1512
    revision
 
1513
        If not None, only revisions up to this point will be copied.
 
1514
        The head of the new branch will be that revision.
 
1515
 
 
1516
    to_location
 
1517
        The name of a local directory that exists but is empty.
 
1518
    """
 
1519
    from bzrlib.merge import merge
 
1520
    from bzrlib.branch import Branch
 
1521
 
 
1522
    assert isinstance(branch_from, Branch)
 
1523
    assert isinstance(to_location, basestring)
 
1524
    
 
1525
    br_to = Branch(to_location, init=True)
 
1526
    br_to.set_root_id(branch_from.get_root_id())
 
1527
    if revision is None:
 
1528
        revno = branch_from.revno()
 
1529
    else:
 
1530
        revno, rev_id = branch_from.get_revision_info(revision)
 
1531
    br_to.update_revisions(branch_from, stop_revision=revno)
 
1532
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
1533
          check_clean=False, ignore_zero=True)
 
1534
    
 
1535
    from_location = pull_loc(branch_from)
 
1536
    br_to.set_parent(pull_loc(branch_from))
 
1537