~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-07-07 10:22:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050707102201-2d2a13a25098b101
- rearrange and clear up merged weave

Show diffs side-by-side

added added

removed removed

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