/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-09-07 10:47:36 UTC
  • mto: (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1397.
  • Revision ID: robertc@robertcollins.net-20050907104736-8e592b72108c577d
symlink support updated to work

Show diffs side-by-side

added added

removed removed

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