/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 23:42:32 UTC
  • mto: (1185.8.2) (974.1.91)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: mbp@sourcefrog.net-20050913234232-4d901f2d843a35f3
- ignore .DS_Store by default

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