/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-06-28 03:02:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050628030231-d311e4ebcd467ef4
Merge John's import-speedup branch:

                                                                                         
  777 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:32 -0500
      revision-id: john@arbash-meinel.com-20050627032031-e82a50db3863b18e
      bzr selftest was not using the correct bzr

  776 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:22 -0500
      revision-id: john@arbash-meinel.com-20050627032021-c9f21fde989ddaee
      Add was using an old mutter

  775 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:02:33 -0500
      revision-id: john@arbash-meinel.com-20050627030233-9165cfe98fc63298
      Cleaned up to be less different

  774 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:54:53 -0500
      revision-id: john@arbash-meinel.com-20050627025452-4260d0e744edef43
      Allow BZR_PLUGIN_PATH='' to negate plugin loading.

  773 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:49:34 -0500
      revision-id: john@arbash-meinel.com-20050627024933-b7158f67b7b9eae5
      Finished the previous cleanup (allowing load_plugins to be called twice)

  772 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:45:08 -0500
      revision-id: john@arbash-meinel.com-20050627024508-723b1df510d196fc
      Work on making the tests pass. versioning.py is calling run_cmd directly, but plugins have been loaded.

  771 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:32:29 -0500
      revision-id: john@arbash-meinel.com-20050627023228-79972744d7c53e15
      Got it down a little bit more by removing import of tree and inventory.

  770 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:26:05 -0500
      revision-id: john@arbash-meinel.com-20050627022604-350b9773ef622f95
      Reducing the number of import from bzrlib/__init__.py and bzrlib/branch.py

  769 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:32:25 -0500
      revision-id: john@arbash-meinel.com-20050627013225-32dd044f10d23948
      Updated revision.py and xml.py to include SubElement.

  768 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:56 -0500
      revision-id: john@arbash-meinel.com-20050627010356-ee66919e1c377faf
      Minor typo

  767 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:13 -0500
      revision-id: john@arbash-meinel.com-20050627010312-40d024007eb85051
      Caching the import

  766 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:51:47 -0500
      revision-id: john@arbash-meinel.com-20050627005147-5281c99e48ed1834
      Created wrapper functions for lazy import of ElementTree

  765 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:46:37 -0500
      revision-id: john@arbash-meinel.com-20050627004636-bf432902004a94c5
      Removed all of the test imports of cElementTree

  764 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:43:59 -0500
      revision-id: john@arbash-meinel.com-20050627004358-d137fbe9570dd71b
      Trying to make bzr startup faster.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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, os
 
19
 
 
20
import bzrlib
 
21
from bzrlib.trace import mutter, note
 
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
 
23
     sha_file, appendpath, file_kind
 
24
from bzrlib.errors import BzrError
 
25
 
 
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
27
## TODO: Maybe include checks for common corruption of newlines, etc?
 
28
 
 
29
 
 
30
 
 
31
def find_branch(f, **args):
 
32
    if f and (f.startswith('http://') or f.startswith('https://')):
 
33
        import remotebranch 
 
34
        return remotebranch.RemoteBranch(f, **args)
 
35
    else:
 
36
        return Branch(f, **args)
 
37
 
 
38
 
 
39
def find_cached_branch(f, cache_root, **args):
 
40
    from remotebranch import RemoteBranch
 
41
    br = find_branch(f, **args)
 
42
    def cacheify(br, store_name):
 
43
        from meta_store import CachedStore
 
44
        cache_path = os.path.join(cache_root, store_name)
 
45
        os.mkdir(cache_path)
 
46
        new_store = CachedStore(getattr(br, store_name), cache_path)
 
47
        setattr(br, store_name, new_store)
 
48
 
 
49
    if isinstance(br, RemoteBranch):
 
50
        cacheify(br, 'inventory_store')
 
51
        cacheify(br, 'text_store')
 
52
        cacheify(br, 'revision_store')
 
53
    return br
 
54
 
 
55
 
 
56
def _relpath(base, path):
 
57
    """Return path relative to base, or raise exception.
 
58
 
 
59
    The path may be either an absolute path or a path relative to the
 
60
    current working directory.
 
61
 
 
62
    Lifted out of Branch.relpath for ease of testing.
 
63
 
 
64
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
65
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
66
    avoids that problem."""
 
67
    rp = os.path.abspath(path)
 
68
 
 
69
    s = []
 
70
    head = rp
 
71
    while len(head) >= len(base):
 
72
        if head == base:
 
73
            break
 
74
        head, tail = os.path.split(head)
 
75
        if tail:
 
76
            s.insert(0, tail)
 
77
    else:
 
78
        from errors import NotBranchError
 
79
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
80
 
 
81
    return os.sep.join(s)
 
82
        
 
83
 
 
84
def find_branch_root(f=None):
 
85
    """Find the branch root enclosing f, or pwd.
 
86
 
 
87
    f may be a filename or a URL.
 
88
 
 
89
    It is not necessary that f exists.
 
90
 
 
91
    Basically we keep looking up until we find the control directory or
 
92
    run into the root."""
 
93
    if f == None:
 
94
        f = os.getcwd()
 
95
    elif hasattr(os.path, 'realpath'):
 
96
        f = os.path.realpath(f)
 
97
    else:
 
98
        f = os.path.abspath(f)
 
99
    if not os.path.exists(f):
 
100
        raise BzrError('%r does not exist' % f)
 
101
        
 
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 BzrError('%r is not in a branch' % orig_f)
 
112
        f = head
 
113
    
 
114
class DivergedBranches(Exception):
 
115
    def __init__(self, branch1, branch2):
 
116
        self.branch1 = branch1
 
117
        self.branch2 = branch2
 
118
        Exception.__init__(self, "These branches have diverged.")
 
119
 
 
120
 
 
121
class NoSuchRevision(BzrError):
 
122
    def __init__(self, branch, revision):
 
123
        self.branch = branch
 
124
        self.revision = revision
 
125
        msg = "Branch %s has no revision %d" % (branch, revision)
 
126
        BzrError.__init__(self, msg)
 
127
 
 
128
 
 
129
######################################################################
 
130
# branch objects
 
131
 
 
132
class Branch(object):
 
133
    """Branch holding a history of revisions.
 
134
 
 
135
    base
 
136
        Base directory of the branch.
 
137
 
 
138
    _lock_mode
 
139
        None, or 'r' or 'w'
 
140
 
 
141
    _lock_count
 
142
        If _lock_mode is true, a positive count of the number of times the
 
143
        lock has been taken.
 
144
 
 
145
    _lock
 
146
        Lock object from bzrlib.lock.
 
147
    """
 
148
    base = None
 
149
    _lock_mode = None
 
150
    _lock_count = None
 
151
    _lock = None
 
152
    
 
153
    def __init__(self, base, init=False, find_root=True):
 
154
        """Create new branch object at a particular location.
 
155
 
 
156
        base -- Base directory for the branch.
 
157
        
 
158
        init -- If True, create new control files in a previously
 
159
             unversioned directory.  If False, the branch must already
 
160
             be versioned.
 
161
 
 
162
        find_root -- If true and init is false, find the root of the
 
163
             existing branch containing base.
 
164
 
 
165
        In the test suite, creation of new trees is tested using the
 
166
        `ScratchBranch` class.
 
167
        """
 
168
        from bzrlib.store import ImmutableStore
 
169
        if init:
 
170
            self.base = os.path.realpath(base)
 
171
            self._make_control()
 
172
        elif find_root:
 
173
            self.base = find_branch_root(base)
 
174
        else:
 
175
            self.base = os.path.realpath(base)
 
176
            if not isdir(self.controlfilename('.')):
 
177
                from errors import NotBranchError
 
178
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
179
                                     ['use "bzr init" to initialize a new working tree',
 
180
                                      'current bzr can only operate from top-of-tree'])
 
181
        self._check_format()
 
182
 
 
183
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
184
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
185
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
186
 
 
187
 
 
188
    def __str__(self):
 
189
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
190
 
 
191
 
 
192
    __repr__ = __str__
 
193
 
 
194
 
 
195
    def __del__(self):
 
196
        if self._lock_mode or self._lock:
 
197
            from warnings import warn
 
198
            warn("branch %r was not explicitly unlocked" % self)
 
199
            self._lock.unlock()
 
200
 
 
201
 
 
202
 
 
203
    def lock_write(self):
 
204
        if self._lock_mode:
 
205
            if self._lock_mode != 'w':
 
206
                from errors import LockError
 
207
                raise LockError("can't upgrade to a write lock from %r" %
 
208
                                self._lock_mode)
 
209
            self._lock_count += 1
 
210
        else:
 
211
            from bzrlib.lock import WriteLock
 
212
 
 
213
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
214
            self._lock_mode = 'w'
 
215
            self._lock_count = 1
 
216
 
 
217
 
 
218
 
 
219
    def lock_read(self):
 
220
        if self._lock_mode:
 
221
            assert self._lock_mode in ('r', 'w'), \
 
222
                   "invalid lock mode %r" % self._lock_mode
 
223
            self._lock_count += 1
 
224
        else:
 
225
            from bzrlib.lock import ReadLock
 
226
 
 
227
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
228
            self._lock_mode = 'r'
 
229
            self._lock_count = 1
 
230
                        
 
231
 
 
232
            
 
233
    def unlock(self):
 
234
        if not self._lock_mode:
 
235
            from errors import LockError
 
236
            raise LockError('branch %r is not locked' % (self))
 
237
 
 
238
        if self._lock_count > 1:
 
239
            self._lock_count -= 1
 
240
        else:
 
241
            self._lock.unlock()
 
242
            self._lock = None
 
243
            self._lock_mode = self._lock_count = None
 
244
 
 
245
 
 
246
    def abspath(self, name):
 
247
        """Return absolute filename for something in the branch"""
 
248
        return os.path.join(self.base, name)
 
249
 
 
250
 
 
251
    def relpath(self, path):
 
252
        """Return path relative to this branch of something inside it.
 
253
 
 
254
        Raises an error if path is not in this branch."""
 
255
        return _relpath(self.base, path)
 
256
 
 
257
 
 
258
    def controlfilename(self, file_or_path):
 
259
        """Return location relative to branch."""
 
260
        if isinstance(file_or_path, basestring):
 
261
            file_or_path = [file_or_path]
 
262
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
263
 
 
264
 
 
265
    def controlfile(self, file_or_path, mode='r'):
 
266
        """Open a control file for this branch.
 
267
 
 
268
        There are two classes of file in the control directory: text
 
269
        and binary.  binary files are untranslated byte streams.  Text
 
270
        control files are stored with Unix newlines and in UTF-8, even
 
271
        if the platform or locale defaults are different.
 
272
 
 
273
        Controlfiles should almost never be opened in write mode but
 
274
        rather should be atomically copied and replaced using atomicfile.
 
275
        """
 
276
 
 
277
        fn = self.controlfilename(file_or_path)
 
278
 
 
279
        if mode == 'rb' or mode == 'wb':
 
280
            return file(fn, mode)
 
281
        elif mode == 'r' or mode == 'w':
 
282
            # open in binary mode anyhow so there's no newline translation;
 
283
            # codecs uses line buffering by default; don't want that.
 
284
            import codecs
 
285
            return codecs.open(fn, mode + 'b', 'utf-8',
 
286
                               buffering=60000)
 
287
        else:
 
288
            raise BzrError("invalid controlfile mode %r" % mode)
 
289
 
 
290
 
 
291
 
 
292
    def _make_control(self):
 
293
        from bzrlib.inventory import Inventory
 
294
        os.mkdir(self.controlfilename([]))
 
295
        self.controlfile('README', 'w').write(
 
296
            "This is a Bazaar-NG control directory.\n"
 
297
            "Do not change any files in this directory.\n")
 
298
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
299
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
300
            os.mkdir(self.controlfilename(d))
 
301
        for f in ('revision-history', 'merged-patches',
 
302
                  'pending-merged-patches', 'branch-name',
 
303
                  'branch-lock'):
 
304
            self.controlfile(f, 'w').write('')
 
305
        mutter('created control directory in ' + self.base)
 
306
        Inventory().write_xml(self.controlfile('inventory','w'))
 
307
 
 
308
 
 
309
    def _check_format(self):
 
310
        """Check this branch format is supported.
 
311
 
 
312
        The current tool only supports the current unstable format.
 
313
 
 
314
        In the future, we might need different in-memory Branch
 
315
        classes to support downlevel branches.  But not yet.
 
316
        """
 
317
        # This ignores newlines so that we can open branches created
 
318
        # on Windows from Linux and so on.  I think it might be better
 
319
        # to always make all internal files in unix format.
 
320
        fmt = self.controlfile('branch-format', 'r').read()
 
321
        fmt.replace('\r\n', '')
 
322
        if fmt != BZR_BRANCH_FORMAT:
 
323
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
324
                           ['use a different bzr version',
 
325
                            'or remove the .bzr directory and "bzr init" again'])
 
326
 
 
327
 
 
328
 
 
329
    def read_working_inventory(self):
 
330
        """Read the working inventory."""
 
331
        from bzrlib.inventory import Inventory
 
332
        from time import time
 
333
        before = time()
 
334
        # ElementTree does its own conversion from UTF-8, so open in
 
335
        # binary.
 
336
        self.lock_read()
 
337
        try:
 
338
            inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
339
            mutter("loaded inventory of %d items in %f"
 
340
                   % (len(inv), time() - before))
 
341
            return inv
 
342
        finally:
 
343
            self.unlock()
 
344
            
 
345
 
 
346
    def _write_inventory(self, inv):
 
347
        """Update the working inventory.
 
348
 
 
349
        That is to say, the inventory describing changes underway, that
 
350
        will be committed to the next revision.
 
351
        """
 
352
        self.lock_write()
 
353
        try:
 
354
            from bzrlib.atomicfile import AtomicFile
 
355
 
 
356
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
357
            try:
 
358
                inv.write_xml(f)
 
359
                f.commit()
 
360
            finally:
 
361
                f.close()
 
362
        finally:
 
363
            self.unlock()
 
364
        
 
365
        mutter('wrote working inventory')
 
366
            
 
367
 
 
368
    inventory = property(read_working_inventory, _write_inventory, None,
 
369
                         """Inventory for the working copy.""")
 
370
 
 
371
 
 
372
    def add(self, files, verbose=False, ids=None):
 
373
        """Make files versioned.
 
374
 
 
375
        Note that the command line normally calls smart_add instead.
 
376
 
 
377
        This puts the files in the Added state, so that they will be
 
378
        recorded by the next commit.
 
379
 
 
380
        files
 
381
            List of paths to add, relative to the base of the tree.
 
382
 
 
383
        ids
 
384
            If set, use these instead of automatically generated ids.
 
385
            Must be the same length as the list of files, but may
 
386
            contain None for ids that are to be autogenerated.
 
387
 
 
388
        TODO: Perhaps have an option to add the ids even if the files do
 
389
              not (yet) exist.
 
390
 
 
391
        TODO: Perhaps return the ids of the files?  But then again it
 
392
              is easy to retrieve them if they're needed.
 
393
 
 
394
        TODO: Adding a directory should optionally recurse down and
 
395
              add all non-ignored children.  Perhaps do that in a
 
396
              higher-level method.
 
397
        """
 
398
        from bzrlib.textui import show_status
 
399
        # TODO: Re-adding a file that is removed in the working copy
 
400
        # should probably put it back with the previous ID.
 
401
        if isinstance(files, basestring):
 
402
            assert(ids is None or isinstance(ids, basestring))
 
403
            files = [files]
 
404
            if ids is not None:
 
405
                ids = [ids]
 
406
 
 
407
        if ids is None:
 
408
            ids = [None] * len(files)
 
409
        else:
 
410
            assert(len(ids) == len(files))
 
411
 
 
412
        self.lock_write()
 
413
        try:
 
414
            inv = self.read_working_inventory()
 
415
            for f,file_id in zip(files, ids):
 
416
                if is_control_file(f):
 
417
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
418
 
 
419
                fp = splitpath(f)
 
420
 
 
421
                if len(fp) == 0:
 
422
                    raise BzrError("cannot add top-level %r" % f)
 
423
 
 
424
                fullpath = os.path.normpath(self.abspath(f))
 
425
 
 
426
                try:
 
427
                    kind = file_kind(fullpath)
 
428
                except OSError:
 
429
                    # maybe something better?
 
430
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
431
 
 
432
                if kind != 'file' and kind != 'directory':
 
433
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
434
 
 
435
                if file_id is None:
 
436
                    file_id = gen_file_id(f)
 
437
                inv.add_path(f, kind=kind, file_id=file_id)
 
438
 
 
439
                if verbose:
 
440
                    print 'added', quotefn(f)
 
441
 
 
442
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
443
 
 
444
            self._write_inventory(inv)
 
445
        finally:
 
446
            self.unlock()
 
447
            
 
448
 
 
449
    def print_file(self, file, revno):
 
450
        """Print `file` to stdout."""
 
451
        self.lock_read()
 
452
        try:
 
453
            tree = self.revision_tree(self.lookup_revision(revno))
 
454
            # use inventory as it was in that revision
 
455
            file_id = tree.inventory.path2id(file)
 
456
            if not file_id:
 
457
                raise BzrError("%r is not present in revision %d" % (file, revno))
 
458
            tree.print_file(file_id)
 
459
        finally:
 
460
            self.unlock()
 
461
 
 
462
 
 
463
    def remove(self, files, verbose=False):
 
464
        """Mark nominated files for removal from the inventory.
 
465
 
 
466
        This does not remove their text.  This does not run on 
 
467
 
 
468
        TODO: Refuse to remove modified files unless --force is given?
 
469
 
 
470
        TODO: Do something useful with directories.
 
471
 
 
472
        TODO: Should this remove the text or not?  Tough call; not
 
473
        removing may be useful and the user can just use use rm, and
 
474
        is the opposite of add.  Removing it is consistent with most
 
475
        other tools.  Maybe an option.
 
476
        """
 
477
        from bzrlib.textui import show_status
 
478
        ## TODO: Normalize names
 
479
        ## TODO: Remove nested loops; better scalability
 
480
        if isinstance(files, basestring):
 
481
            files = [files]
 
482
 
 
483
        self.lock_write()
 
484
 
 
485
        try:
 
486
            tree = self.working_tree()
 
487
            inv = tree.inventory
 
488
 
 
489
            # do this before any modifications
 
490
            for f in files:
 
491
                fid = inv.path2id(f)
 
492
                if not fid:
 
493
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
494
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
495
                if verbose:
 
496
                    # having remove it, it must be either ignored or unknown
 
497
                    if tree.is_ignored(f):
 
498
                        new_status = 'I'
 
499
                    else:
 
500
                        new_status = '?'
 
501
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
502
                del inv[fid]
 
503
 
 
504
            self._write_inventory(inv)
 
505
        finally:
 
506
            self.unlock()
 
507
 
 
508
 
 
509
    # FIXME: this doesn't need to be a branch method
 
510
    def set_inventory(self, new_inventory_list):
 
511
        from bzrlib.inventory import Inventory, InventoryEntry
 
512
        inv = Inventory()
 
513
        for path, file_id, parent, kind in new_inventory_list:
 
514
            name = os.path.basename(path)
 
515
            if name == "":
 
516
                continue
 
517
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
518
        self._write_inventory(inv)
 
519
 
 
520
 
 
521
    def unknowns(self):
 
522
        """Return all unknown files.
 
523
 
 
524
        These are files in the working directory that are not versioned or
 
525
        control files or ignored.
 
526
        
 
527
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
528
        >>> list(b.unknowns())
 
529
        ['foo']
 
530
        >>> b.add('foo')
 
531
        >>> list(b.unknowns())
 
532
        []
 
533
        >>> b.remove('foo')
 
534
        >>> list(b.unknowns())
 
535
        ['foo']
 
536
        """
 
537
        return self.working_tree().unknowns()
 
538
 
 
539
 
 
540
    def append_revision(self, revision_id):
 
541
        from bzrlib.atomicfile import AtomicFile
 
542
 
 
543
        mutter("add {%s} to revision-history" % revision_id)
 
544
        rev_history = self.revision_history() + [revision_id]
 
545
 
 
546
        f = AtomicFile(self.controlfilename('revision-history'))
 
547
        try:
 
548
            for rev_id in rev_history:
 
549
                print >>f, rev_id
 
550
            f.commit()
 
551
        finally:
 
552
            f.close()
 
553
 
 
554
 
 
555
    def get_revision(self, revision_id):
 
556
        """Return the Revision object for a named revision"""
 
557
        from bzrlib.revision import Revision
 
558
        if not revision_id or not isinstance(revision_id, basestring):
 
559
            raise ValueError('invalid revision-id: %r' % revision_id)
 
560
        r = Revision.read_xml(self.revision_store[revision_id])
 
561
        assert r.revision_id == revision_id
 
562
        return r
 
563
 
 
564
    def get_revision_sha1(self, revision_id):
 
565
        """Hash the stored value of a revision, and return it."""
 
566
        # In the future, revision entries will be signed. At that
 
567
        # point, it is probably best *not* to include the signature
 
568
        # in the revision hash. Because that lets you re-sign
 
569
        # the revision, (add signatures/remove signatures) and still
 
570
        # have all hash pointers stay consistent.
 
571
        # But for now, just hash the contents.
 
572
        return sha_file(self.revision_store[revision_id])
 
573
 
 
574
 
 
575
    def get_inventory(self, inventory_id):
 
576
        """Get Inventory object by hash.
 
577
 
 
578
        TODO: Perhaps for this and similar methods, take a revision
 
579
               parameter which can be either an integer revno or a
 
580
               string hash."""
 
581
        from bzrlib.inventory import Inventory
 
582
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
583
        return i
 
584
 
 
585
    def get_inventory_sha1(self, inventory_id):
 
586
        """Return the sha1 hash of the inventory entry
 
587
        """
 
588
        return sha_file(self.inventory_store[inventory_id])
 
589
 
 
590
 
 
591
    def get_revision_inventory(self, revision_id):
 
592
        """Return inventory of a past revision."""
 
593
        if revision_id == None:
 
594
            from bzrlib.inventory import Inventory
 
595
            return Inventory()
 
596
        else:
 
597
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
598
 
 
599
 
 
600
    def revision_history(self):
 
601
        """Return sequence of revision hashes on to this branch.
 
602
 
 
603
        >>> ScratchBranch().revision_history()
 
604
        []
 
605
        """
 
606
        self.lock_read()
 
607
        try:
 
608
            return [l.rstrip('\r\n') for l in
 
609
                    self.controlfile('revision-history', 'r').readlines()]
 
610
        finally:
 
611
            self.unlock()
 
612
 
 
613
 
 
614
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
615
        """
 
616
        >>> import commit
 
617
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
618
        >>> sb.common_ancestor(sb) == (None, None)
 
619
        True
 
620
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
621
        >>> sb.common_ancestor(sb)[0]
 
622
        1
 
623
        >>> clone = sb.clone()
 
624
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
625
        >>> sb.common_ancestor(sb)[0]
 
626
        2
 
627
        >>> sb.common_ancestor(clone)[0]
 
628
        1
 
629
        >>> commit.commit(clone, "Committing divergent second revision", 
 
630
        ...               verbose=False)
 
631
        >>> sb.common_ancestor(clone)[0]
 
632
        1
 
633
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
634
        True
 
635
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
636
        True
 
637
        >>> clone2 = sb.clone()
 
638
        >>> sb.common_ancestor(clone2)[0]
 
639
        2
 
640
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
641
        1
 
642
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
643
        1
 
644
        """
 
645
        my_history = self.revision_history()
 
646
        other_history = other.revision_history()
 
647
        if self_revno is None:
 
648
            self_revno = len(my_history)
 
649
        if other_revno is None:
 
650
            other_revno = len(other_history)
 
651
        indices = range(min((self_revno, other_revno)))
 
652
        indices.reverse()
 
653
        for r in indices:
 
654
            if my_history[r] == other_history[r]:
 
655
                return r+1, my_history[r]
 
656
        return None, None
 
657
 
 
658
    def enum_history(self, direction):
 
659
        """Return (revno, revision_id) for history of branch.
 
660
 
 
661
        direction
 
662
            'forward' is from earliest to latest
 
663
            'reverse' is from latest to earliest
 
664
        """
 
665
        rh = self.revision_history()
 
666
        if direction == 'forward':
 
667
            i = 1
 
668
            for rid in rh:
 
669
                yield i, rid
 
670
                i += 1
 
671
        elif direction == 'reverse':
 
672
            i = len(rh)
 
673
            while i > 0:
 
674
                yield i, rh[i-1]
 
675
                i -= 1
 
676
        else:
 
677
            raise ValueError('invalid history direction', direction)
 
678
 
 
679
 
 
680
    def revno(self):
 
681
        """Return current revision number for this branch.
 
682
 
 
683
        That is equivalent to the number of revisions committed to
 
684
        this branch.
 
685
        """
 
686
        return len(self.revision_history())
 
687
 
 
688
 
 
689
    def last_patch(self):
 
690
        """Return last patch hash, or None if no history.
 
691
        """
 
692
        ph = self.revision_history()
 
693
        if ph:
 
694
            return ph[-1]
 
695
        else:
 
696
            return None
 
697
 
 
698
 
 
699
    def missing_revisions(self, other, stop_revision=None):
 
700
        """
 
701
        If self and other have not diverged, return a list of the revisions
 
702
        present in other, but missing from self.
 
703
 
 
704
        >>> from bzrlib.commit import commit
 
705
        >>> bzrlib.trace.silent = True
 
706
        >>> br1 = ScratchBranch()
 
707
        >>> br2 = ScratchBranch()
 
708
        >>> br1.missing_revisions(br2)
 
709
        []
 
710
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
711
        >>> br1.missing_revisions(br2)
 
712
        [u'REVISION-ID-1']
 
713
        >>> br2.missing_revisions(br1)
 
714
        []
 
715
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
716
        >>> br1.missing_revisions(br2)
 
717
        []
 
718
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
719
        >>> br1.missing_revisions(br2)
 
720
        [u'REVISION-ID-2A']
 
721
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
722
        >>> br1.missing_revisions(br2)
 
723
        Traceback (most recent call last):
 
724
        DivergedBranches: These branches have diverged.
 
725
        """
 
726
        self_history = self.revision_history()
 
727
        self_len = len(self_history)
 
728
        other_history = other.revision_history()
 
729
        other_len = len(other_history)
 
730
        common_index = min(self_len, other_len) -1
 
731
        if common_index >= 0 and \
 
732
            self_history[common_index] != other_history[common_index]:
 
733
            raise DivergedBranches(self, other)
 
734
 
 
735
        if stop_revision is None:
 
736
            stop_revision = other_len
 
737
        elif stop_revision > other_len:
 
738
            raise NoSuchRevision(self, stop_revision)
 
739
        
 
740
        return other_history[self_len:stop_revision]
 
741
 
 
742
 
 
743
    def update_revisions(self, other, stop_revision=None):
 
744
        """Pull in all new revisions from other branch.
 
745
        
 
746
        >>> from bzrlib.commit import commit
 
747
        >>> bzrlib.trace.silent = True
 
748
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
749
        >>> br1.add('foo')
 
750
        >>> br1.add('bar')
 
751
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
752
        >>> br2 = ScratchBranch()
 
753
        >>> br2.update_revisions(br1)
 
754
        Added 2 texts.
 
755
        Added 1 inventories.
 
756
        Added 1 revisions.
 
757
        >>> br2.revision_history()
 
758
        [u'REVISION-ID-1']
 
759
        >>> br2.update_revisions(br1)
 
760
        Added 0 texts.
 
761
        Added 0 inventories.
 
762
        Added 0 revisions.
 
763
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
764
        True
 
765
        """
 
766
        from bzrlib.progress import ProgressBar
 
767
        try:
 
768
            set
 
769
        except NameError:
 
770
            from sets import Set as set
 
771
 
 
772
        pb = ProgressBar()
 
773
 
 
774
        pb.update('comparing histories')
 
775
        revision_ids = self.missing_revisions(other, stop_revision)
 
776
 
 
777
        if hasattr(other.revision_store, "prefetch"):
 
778
            other.revision_store.prefetch(revision_ids)
 
779
        if hasattr(other.inventory_store, "prefetch"):
 
780
            inventory_ids = [other.get_revision(r).inventory_id
 
781
                             for r in revision_ids]
 
782
            other.inventory_store.prefetch(inventory_ids)
 
783
                
 
784
        revisions = []
 
785
        needed_texts = set()
 
786
        i = 0
 
787
        for rev_id in revision_ids:
 
788
            i += 1
 
789
            pb.update('fetching revision', i, len(revision_ids))
 
790
            rev = other.get_revision(rev_id)
 
791
            revisions.append(rev)
 
792
            inv = other.get_inventory(str(rev.inventory_id))
 
793
            for key, entry in inv.iter_entries():
 
794
                if entry.text_id is None:
 
795
                    continue
 
796
                if entry.text_id not in self.text_store:
 
797
                    needed_texts.add(entry.text_id)
 
798
 
 
799
        pb.clear()
 
800
                    
 
801
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
802
        print "Added %d texts." % count 
 
803
        inventory_ids = [ f.inventory_id for f in revisions ]
 
804
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
805
                                                inventory_ids)
 
806
        print "Added %d inventories." % count 
 
807
        revision_ids = [ f.revision_id for f in revisions]
 
808
        count = self.revision_store.copy_multi(other.revision_store, 
 
809
                                               revision_ids)
 
810
        for revision_id in revision_ids:
 
811
            self.append_revision(revision_id)
 
812
        print "Added %d revisions." % count
 
813
                    
 
814
        
 
815
    def commit(self, *args, **kw):
 
816
        from bzrlib.commit import commit
 
817
        commit(self, *args, **kw)
 
818
        
 
819
 
 
820
    def lookup_revision(self, revno):
 
821
        """Return revision hash for revision number."""
 
822
        if revno == 0:
 
823
            return None
 
824
 
 
825
        try:
 
826
            # list is 0-based; revisions are 1-based
 
827
            return self.revision_history()[revno-1]
 
828
        except IndexError:
 
829
            raise BzrError("no such revision %s" % revno)
 
830
 
 
831
 
 
832
    def revision_tree(self, revision_id):
 
833
        """Return Tree for a revision on this branch.
 
834
 
 
835
        `revision_id` may be None for the null revision, in which case
 
836
        an `EmptyTree` is returned."""
 
837
        from bzrlib.tree import EmptyTree, RevisionTree
 
838
        # TODO: refactor this to use an existing revision object
 
839
        # so we don't need to read it in twice.
 
840
        if revision_id == None:
 
841
            return EmptyTree()
 
842
        else:
 
843
            inv = self.get_revision_inventory(revision_id)
 
844
            return RevisionTree(self.text_store, inv)
 
845
 
 
846
 
 
847
    def working_tree(self):
 
848
        """Return a `Tree` for the working copy."""
 
849
        from workingtree import WorkingTree
 
850
        return WorkingTree(self.base, self.read_working_inventory())
 
851
 
 
852
 
 
853
    def basis_tree(self):
 
854
        """Return `Tree` object for last revision.
 
855
 
 
856
        If there are no revisions yet, return an `EmptyTree`.
 
857
        """
 
858
        from bzrlib.tree import EmptyTree, RevisionTree
 
859
        r = self.last_patch()
 
860
        if r == None:
 
861
            return EmptyTree()
 
862
        else:
 
863
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
864
 
 
865
 
 
866
 
 
867
    def rename_one(self, from_rel, to_rel):
 
868
        """Rename one file.
 
869
 
 
870
        This can change the directory or the filename or both.
 
871
        """
 
872
        self.lock_write()
 
873
        try:
 
874
            tree = self.working_tree()
 
875
            inv = tree.inventory
 
876
            if not tree.has_filename(from_rel):
 
877
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
878
            if tree.has_filename(to_rel):
 
879
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
880
 
 
881
            file_id = inv.path2id(from_rel)
 
882
            if file_id == None:
 
883
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
884
 
 
885
            if inv.path2id(to_rel):
 
886
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
887
 
 
888
            to_dir, to_tail = os.path.split(to_rel)
 
889
            to_dir_id = inv.path2id(to_dir)
 
890
            if to_dir_id == None and to_dir != '':
 
891
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
892
 
 
893
            mutter("rename_one:")
 
894
            mutter("  file_id    {%s}" % file_id)
 
895
            mutter("  from_rel   %r" % from_rel)
 
896
            mutter("  to_rel     %r" % to_rel)
 
897
            mutter("  to_dir     %r" % to_dir)
 
898
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
899
 
 
900
            inv.rename(file_id, to_dir_id, to_tail)
 
901
 
 
902
            print "%s => %s" % (from_rel, to_rel)
 
903
 
 
904
            from_abs = self.abspath(from_rel)
 
905
            to_abs = self.abspath(to_rel)
 
906
            try:
 
907
                os.rename(from_abs, to_abs)
 
908
            except OSError, e:
 
909
                raise BzrError("failed to rename %r to %r: %s"
 
910
                        % (from_abs, to_abs, e[1]),
 
911
                        ["rename rolled back"])
 
912
 
 
913
            self._write_inventory(inv)
 
914
        finally:
 
915
            self.unlock()
 
916
 
 
917
 
 
918
    def move(self, from_paths, to_name):
 
919
        """Rename files.
 
920
 
 
921
        to_name must exist as a versioned directory.
 
922
 
 
923
        If to_name exists and is a directory, the files are moved into
 
924
        it, keeping their old names.  If it is a directory, 
 
925
 
 
926
        Note that to_name is only the last component of the new name;
 
927
        this doesn't change the directory.
 
928
        """
 
929
        self.lock_write()
 
930
        try:
 
931
            ## TODO: Option to move IDs only
 
932
            assert not isinstance(from_paths, basestring)
 
933
            tree = self.working_tree()
 
934
            inv = tree.inventory
 
935
            to_abs = self.abspath(to_name)
 
936
            if not isdir(to_abs):
 
937
                raise BzrError("destination %r is not a directory" % to_abs)
 
938
            if not tree.has_filename(to_name):
 
939
                raise BzrError("destination %r not in working directory" % to_abs)
 
940
            to_dir_id = inv.path2id(to_name)
 
941
            if to_dir_id == None and to_name != '':
 
942
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
943
            to_dir_ie = inv[to_dir_id]
 
944
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
945
                raise BzrError("destination %r is not a directory" % to_abs)
 
946
 
 
947
            to_idpath = inv.get_idpath(to_dir_id)
 
948
 
 
949
            for f in from_paths:
 
950
                if not tree.has_filename(f):
 
951
                    raise BzrError("%r does not exist in working tree" % f)
 
952
                f_id = inv.path2id(f)
 
953
                if f_id == None:
 
954
                    raise BzrError("%r is not versioned" % f)
 
955
                name_tail = splitpath(f)[-1]
 
956
                dest_path = appendpath(to_name, name_tail)
 
957
                if tree.has_filename(dest_path):
 
958
                    raise BzrError("destination %r already exists" % dest_path)
 
959
                if f_id in to_idpath:
 
960
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
961
 
 
962
            # OK, so there's a race here, it's possible that someone will
 
963
            # create a file in this interval and then the rename might be
 
964
            # left half-done.  But we should have caught most problems.
 
965
 
 
966
            for f in from_paths:
 
967
                name_tail = splitpath(f)[-1]
 
968
                dest_path = appendpath(to_name, name_tail)
 
969
                print "%s => %s" % (f, dest_path)
 
970
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
971
                try:
 
972
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
973
                except OSError, e:
 
974
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
975
                            ["rename rolled back"])
 
976
 
 
977
            self._write_inventory(inv)
 
978
        finally:
 
979
            self.unlock()
 
980
 
 
981
 
 
982
    def revert(self, filenames, old_tree=None, backups=True):
 
983
        """Restore selected files to the versions from a previous tree.
 
984
 
 
985
        backups
 
986
            If true (default) backups are made of files before
 
987
            they're renamed.
 
988
        """
 
989
        from bzrlib.errors import NotVersionedError, BzrError
 
990
        from bzrlib.atomicfile import AtomicFile
 
991
        from bzrlib.osutils import backup_file
 
992
        
 
993
        inv = self.read_working_inventory()
 
994
        if old_tree is None:
 
995
            old_tree = self.basis_tree()
 
996
        old_inv = old_tree.inventory
 
997
 
 
998
        nids = []
 
999
        for fn in filenames:
 
1000
            file_id = inv.path2id(fn)
 
1001
            if not file_id:
 
1002
                raise NotVersionedError("not a versioned file", fn)
 
1003
            if not old_inv.has_id(file_id):
 
1004
                raise BzrError("file not present in old tree", fn, file_id)
 
1005
            nids.append((fn, file_id))
 
1006
            
 
1007
        # TODO: Rename back if it was previously at a different location
 
1008
 
 
1009
        # TODO: If given a directory, restore the entire contents from
 
1010
        # the previous version.
 
1011
 
 
1012
        # TODO: Make a backup to a temporary file.
 
1013
 
 
1014
        # TODO: If the file previously didn't exist, delete it?
 
1015
        for fn, file_id in nids:
 
1016
            backup_file(fn)
 
1017
            
 
1018
            f = AtomicFile(fn, 'wb')
 
1019
            try:
 
1020
                f.write(old_tree.get_file(file_id).read())
 
1021
                f.commit()
 
1022
            finally:
 
1023
                f.close()
 
1024
 
 
1025
 
 
1026
 
 
1027
class ScratchBranch(Branch):
 
1028
    """Special test class: a branch that cleans up after itself.
 
1029
 
 
1030
    >>> b = ScratchBranch()
 
1031
    >>> isdir(b.base)
 
1032
    True
 
1033
    >>> bd = b.base
 
1034
    >>> b.destroy()
 
1035
    >>> isdir(bd)
 
1036
    False
 
1037
    """
 
1038
    def __init__(self, files=[], dirs=[], base=None):
 
1039
        """Make a test branch.
 
1040
 
 
1041
        This creates a temporary directory and runs init-tree in it.
 
1042
 
 
1043
        If any files are listed, they are created in the working copy.
 
1044
        """
 
1045
        from tempfile import mkdtemp
 
1046
        init = False
 
1047
        if base is None:
 
1048
            base = mkdtemp()
 
1049
            init = True
 
1050
        Branch.__init__(self, base, init=init)
 
1051
        for d in dirs:
 
1052
            os.mkdir(self.abspath(d))
 
1053
            
 
1054
        for f in files:
 
1055
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1056
 
 
1057
 
 
1058
    def clone(self):
 
1059
        """
 
1060
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1061
        >>> clone = orig.clone()
 
1062
        >>> os.path.samefile(orig.base, clone.base)
 
1063
        False
 
1064
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1065
        True
 
1066
        """
 
1067
        from shutil import copytree
 
1068
        from tempfile import mkdtemp
 
1069
        base = mkdtemp()
 
1070
        os.rmdir(base)
 
1071
        copytree(self.base, base, symlinks=True)
 
1072
        return ScratchBranch(base=base)
 
1073
        
 
1074
    def __del__(self):
 
1075
        self.destroy()
 
1076
 
 
1077
    def destroy(self):
 
1078
        """Destroy the test branch, removing the scratch directory."""
 
1079
        from shutil import rmtree
 
1080
        try:
 
1081
            if self.base:
 
1082
                mutter("delete ScratchBranch %s" % self.base)
 
1083
                rmtree(self.base)
 
1084
        except OSError, e:
 
1085
            # Work around for shutil.rmtree failing on Windows when
 
1086
            # readonly files are encountered
 
1087
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1088
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1089
                for name in files:
 
1090
                    os.chmod(os.path.join(root, name), 0700)
 
1091
            rmtree(self.base)
 
1092
        self.base = None
 
1093
 
 
1094
    
 
1095
 
 
1096
######################################################################
 
1097
# predicates
 
1098
 
 
1099
 
 
1100
def is_control_file(filename):
 
1101
    ## FIXME: better check
 
1102
    filename = os.path.normpath(filename)
 
1103
    while filename != '':
 
1104
        head, tail = os.path.split(filename)
 
1105
        ## mutter('check %r for control file' % ((head, tail), ))
 
1106
        if tail == bzrlib.BZRDIR:
 
1107
            return True
 
1108
        if filename == head:
 
1109
            break
 
1110
        filename = head
 
1111
    return False
 
1112
 
 
1113
 
 
1114
 
 
1115
def gen_file_id(name):
 
1116
    """Return new file id.
 
1117
 
 
1118
    This should probably generate proper UUIDs, but for the moment we
 
1119
    cope with just randomness because running uuidgen every time is
 
1120
    slow."""
 
1121
    import re
 
1122
    from binascii import hexlify
 
1123
    from time import time
 
1124
 
 
1125
    # get last component
 
1126
    idx = name.rfind('/')
 
1127
    if idx != -1:
 
1128
        name = name[idx+1 : ]
 
1129
    idx = name.rfind('\\')
 
1130
    if idx != -1:
 
1131
        name = name[idx+1 : ]
 
1132
 
 
1133
    # make it not a hidden file
 
1134
    name = name.lstrip('.')
 
1135
 
 
1136
    # remove any wierd characters; we don't escape them but rather
 
1137
    # just pull them out
 
1138
    name = re.sub(r'[^\w.]', '', name)
 
1139
 
 
1140
    s = hexlify(rand_bytes(8))
 
1141
    return '-'.join((name, compact_date(time()), s))