/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-30 02:54:51 UTC
  • mfrom: (1395)
  • mto: This revision was merged to the branch mainline in revision 1397.
  • Revision ID: robertc@robertcollins.net-20050930025451-47b9e412202be44b
symlink and weaves, whaddya know

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