~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-04-15 01:31:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning

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