~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

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
19
 
import 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
20
23
 
21
24
import bzrlib
22
 
from bzrlib.trace import mutter, note
23
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
 
     splitpath, \
25
 
     sha_file, appendpath, file_kind
26
 
 
27
 
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
28
 
import bzrlib.errors
29
 
from bzrlib.textui import show_status
30
 
from bzrlib.revision import Revision
31
 
from bzrlib.xml import unpack_xml
32
 
from bzrlib.delta import compare_trees
33
 
from bzrlib.tree import EmptyTree, RevisionTree
34
 
import bzrlib.ui
35
 
 
36
 
 
 
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
37
37
 
38
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
39
## TODO: Maybe include checks for common corruption of newlines, etc?
40
40
 
41
41
 
42
 
# TODO: Some operations like log might retrieve the same revisions
43
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
44
 
# cache in memory to make this faster.
45
 
 
46
 
# TODO: please move the revision-string syntax stuff out of the branch
47
 
# object; it's clutter
48
 
 
49
 
 
50
 
def find_branch(f, **args):
51
 
    if f and (f.startswith('http://') or f.startswith('https://')):
52
 
        import remotebranch 
53
 
        return remotebranch.RemoteBranch(f, **args)
54
 
    else:
55
 
        return Branch(f, **args)
56
 
 
57
 
 
58
 
def find_cached_branch(f, cache_root, **args):
59
 
    from remotebranch import RemoteBranch
60
 
    br = find_branch(f, **args)
61
 
    def cacheify(br, store_name):
62
 
        from meta_store import CachedStore
63
 
        cache_path = os.path.join(cache_root, store_name)
64
 
        os.mkdir(cache_path)
65
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
66
 
        setattr(br, store_name, new_store)
67
 
 
68
 
    if isinstance(br, RemoteBranch):
69
 
        cacheify(br, 'inventory_store')
70
 
        cacheify(br, 'text_store')
71
 
        cacheify(br, 'revision_store')
72
 
    return br
73
 
 
74
 
 
75
 
def _relpath(base, path):
76
 
    """Return path relative to base, or raise exception.
77
 
 
78
 
    The path may be either an absolute path or a path relative to the
79
 
    current working directory.
80
 
 
81
 
    Lifted out of Branch.relpath for ease of testing.
82
 
 
83
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
84
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
85
 
    avoids that problem."""
86
 
    rp = os.path.abspath(path)
87
 
 
88
 
    s = []
89
 
    head = rp
90
 
    while len(head) >= len(base):
91
 
        if head == base:
92
 
            break
93
 
        head, tail = os.path.split(head)
94
 
        if tail:
95
 
            s.insert(0, tail)
96
 
    else:
97
 
        from errors import NotBranchError
98
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
99
 
 
100
 
    return os.sep.join(s)
101
 
        
102
42
 
103
43
def find_branch_root(f=None):
104
44
    """Find the branch root enclosing f, or pwd.
105
45
 
106
 
    f may be a filename or a URL.
107
 
 
108
46
    It is not necessary that f exists.
109
47
 
110
48
    Basically we keep looking up until we find the control directory or
111
 
    run into the root.  If there isn't one, raises NotBranchError.
112
 
    """
 
49
    run into the root."""
113
50
    if f == None:
114
51
        f = os.getcwd()
115
52
    elif hasattr(os.path, 'realpath'):
116
53
        f = os.path.realpath(f)
117
54
    else:
118
55
        f = os.path.abspath(f)
119
 
    if not os.path.exists(f):
120
 
        raise BzrError('%r does not exist' % f)
121
 
        
122
56
 
123
57
    orig_f = f
124
58
 
128
62
        head, tail = os.path.split(f)
129
63
        if head == f:
130
64
            # reached the root, whatever that may be
131
 
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
 
65
            raise BzrError('%r is not in a branch' % orig_f)
132
66
        f = head
133
 
 
134
 
 
135
 
 
136
 
# XXX: move into bzrlib.errors; subclass BzrError    
137
 
class DivergedBranches(Exception):
138
 
    def __init__(self, branch1, branch2):
139
 
        self.branch1 = branch1
140
 
        self.branch2 = branch2
141
 
        Exception.__init__(self, "These branches have diverged.")
 
67
    
142
68
 
143
69
 
144
70
######################################################################
145
71
# branch objects
146
72
 
147
 
class Branch(object):
 
73
class Branch:
148
74
    """Branch holding a history of revisions.
149
75
 
150
76
    base
151
77
        Base directory of the branch.
152
 
 
153
 
    _lock_mode
154
 
        None, or 'r' or 'w'
155
 
 
156
 
    _lock_count
157
 
        If _lock_mode is true, a positive count of the number of times the
158
 
        lock has been taken.
159
 
 
160
 
    _lock
161
 
        Lock object from bzrlib.lock.
162
78
    """
163
 
    base = None
164
 
    _lock_mode = None
165
 
    _lock_count = None
166
 
    _lock = None
 
79
    _lockmode = None
167
80
    
168
 
    # Map some sort of prefix into a namespace
169
 
    # stuff like "revno:10", "revid:", etc.
170
 
    # This should match a prefix with a function which accepts
171
 
    REVISION_NAMESPACES = {}
172
 
 
173
 
    def __init__(self, base, init=False, find_root=True):
 
81
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
174
82
        """Create new branch object at a particular location.
175
83
 
176
84
        base -- Base directory for the branch.
185
93
        In the test suite, creation of new trees is tested using the
186
94
        `ScratchBranch` class.
187
95
        """
188
 
        from bzrlib.store import ImmutableStore
189
96
        if init:
190
97
            self.base = os.path.realpath(base)
191
98
            self._make_control()
194
101
        else:
195
102
            self.base = os.path.realpath(base)
196
103
            if not isdir(self.controlfilename('.')):
197
 
                from errors import NotBranchError
198
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
199
 
                                     ['use "bzr init" to initialize a new working tree',
200
 
                                      'current bzr can only operate from top-of-tree'])
 
104
                bailout("not a bzr branch: %s" % quotefn(base),
 
105
                        ['use "bzr init" to initialize a new working tree',
 
106
                         'current bzr can only operate from top-of-tree'])
201
107
        self._check_format()
 
108
        self.lock(lock_mode)
202
109
 
203
110
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
204
111
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
212
119
    __repr__ = __str__
213
120
 
214
121
 
215
 
    def __del__(self):
216
 
        if self._lock_mode or self._lock:
217
 
            from warnings import warn
218
 
            warn("branch %r was not explicitly unlocked" % self)
219
 
            self._lock.unlock()
220
 
 
221
 
 
222
 
    def lock_write(self):
223
 
        if self._lock_mode:
224
 
            if self._lock_mode != 'w':
225
 
                from errors import LockError
226
 
                raise LockError("can't upgrade to a write lock from %r" %
227
 
                                self._lock_mode)
228
 
            self._lock_count += 1
229
 
        else:
230
 
            from bzrlib.lock import WriteLock
231
 
 
232
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
233
 
            self._lock_mode = 'w'
234
 
            self._lock_count = 1
235
 
 
236
 
 
237
 
    def lock_read(self):
238
 
        if self._lock_mode:
239
 
            assert self._lock_mode in ('r', 'w'), \
240
 
                   "invalid lock mode %r" % self._lock_mode
241
 
            self._lock_count += 1
242
 
        else:
243
 
            from bzrlib.lock import ReadLock
244
 
 
245
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
246
 
            self._lock_mode = 'r'
247
 
            self._lock_count = 1
248
 
                        
249
 
    def unlock(self):
250
 
        if not self._lock_mode:
251
 
            from errors import LockError
252
 
            raise LockError('branch %r is not locked' % (self))
253
 
 
254
 
        if self._lock_count > 1:
255
 
            self._lock_count -= 1
256
 
        else:
257
 
            self._lock.unlock()
258
 
            self._lock = None
259
 
            self._lock_mode = self._lock_count = None
 
122
 
 
123
    def lock(self, mode='w'):
 
124
        """Lock the on-disk branch, excluding other processes."""
 
125
        try:
 
126
            import fcntl
 
127
 
 
128
            if mode == 'w':
 
129
                lm = fcntl.LOCK_EX
 
130
                om = os.O_WRONLY | os.O_CREAT
 
131
            elif mode == 'r':
 
132
                lm = fcntl.LOCK_SH
 
133
                om = os.O_RDONLY
 
134
            else:
 
135
                raise BzrError("invalid locking mode %r" % mode)
 
136
 
 
137
            # XXX: Old branches might not have the lock file, and
 
138
            # won't get one until someone does a write-mode command on
 
139
            # them or creates it by hand.
 
140
 
 
141
            lockfile = os.open(self.controlfilename('branch-lock'), om)
 
142
            fcntl.lockf(lockfile, lm)
 
143
            def unlock():
 
144
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
145
                os.close(lockfile)
 
146
                self._lockmode = None
 
147
            self.unlock = unlock
 
148
            self._lockmode = mode
 
149
        except ImportError:
 
150
            warning("please write a locking method for platform %r" % sys.platform)
 
151
            def unlock():
 
152
                self._lockmode = None
 
153
            self.unlock = unlock
 
154
            self._lockmode = mode
 
155
 
 
156
 
 
157
    def _need_readlock(self):
 
158
        if self._lockmode not in ['r', 'w']:
 
159
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
160
 
 
161
    def _need_writelock(self):
 
162
        if self._lockmode not in ['w']:
 
163
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
164
 
260
165
 
261
166
    def abspath(self, name):
262
167
        """Return absolute filename for something in the branch"""
263
168
        return os.path.join(self.base, name)
264
169
 
 
170
 
265
171
    def relpath(self, path):
266
172
        """Return path relative to this branch of something inside it.
267
173
 
268
174
        Raises an error if path is not in this branch."""
269
 
        return _relpath(self.base, path)
 
175
        rp = os.path.realpath(path)
 
176
        # FIXME: windows
 
177
        if not rp.startswith(self.base):
 
178
            bailout("path %r is not within branch %r" % (rp, self.base))
 
179
        rp = rp[len(self.base):]
 
180
        rp = rp.lstrip(os.sep)
 
181
        return rp
 
182
 
270
183
 
271
184
    def controlfilename(self, file_or_path):
272
185
        """Return location relative to branch."""
273
 
        if isinstance(file_or_path, basestring):
 
186
        if isinstance(file_or_path, types.StringTypes):
274
187
            file_or_path = [file_or_path]
275
188
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
276
189
 
282
195
        and binary.  binary files are untranslated byte streams.  Text
283
196
        control files are stored with Unix newlines and in UTF-8, even
284
197
        if the platform or locale defaults are different.
285
 
 
286
 
        Controlfiles should almost never be opened in write mode but
287
 
        rather should be atomically copied and replaced using atomicfile.
288
198
        """
289
199
 
290
200
        fn = self.controlfilename(file_or_path)
300
210
        else:
301
211
            raise BzrError("invalid controlfile mode %r" % mode)
302
212
 
 
213
 
 
214
 
303
215
    def _make_control(self):
304
 
        from bzrlib.inventory import Inventory
305
 
        from bzrlib.xml import pack_xml
306
 
        
307
216
        os.mkdir(self.controlfilename([]))
308
217
        self.controlfile('README', 'w').write(
309
218
            "This is a Bazaar-NG control directory.\n"
310
 
            "Do not change any files in this directory.\n")
 
219
            "Do not change any files in this directory.")
311
220
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
312
221
        for d in ('text-store', 'inventory-store', 'revision-store'):
313
222
            os.mkdir(self.controlfilename(d))
314
223
        for f in ('revision-history', 'merged-patches',
315
224
                  'pending-merged-patches', 'branch-name',
316
 
                  'branch-lock',
317
 
                  'pending-merges'):
 
225
                  'branch-lock'):
318
226
            self.controlfile(f, 'w').write('')
319
227
        mutter('created control directory in ' + self.base)
 
228
        Inventory().write_xml(self.controlfile('inventory','w'))
320
229
 
321
 
        # if we want per-tree root ids then this is the place to set
322
 
        # them; they're not needed for now and so ommitted for
323
 
        # simplicity.
324
 
        pack_xml(Inventory(), self.controlfile('inventory','w'))
325
230
 
326
231
    def _check_format(self):
327
232
        """Check this branch format is supported.
337
242
        fmt = self.controlfile('branch-format', 'r').read()
338
243
        fmt.replace('\r\n', '')
339
244
        if fmt != BZR_BRANCH_FORMAT:
340
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
341
 
                           ['use a different bzr version',
342
 
                            'or remove the .bzr directory and "bzr init" again'])
343
 
 
344
 
    def get_root_id(self):
345
 
        """Return the id of this branches root"""
346
 
        inv = self.read_working_inventory()
347
 
        return inv.root.file_id
348
 
 
349
 
    def set_root_id(self, file_id):
350
 
        inv = self.read_working_inventory()
351
 
        orig_root_id = inv.root.file_id
352
 
        del inv._byid[inv.root.file_id]
353
 
        inv.root.file_id = file_id
354
 
        inv._byid[inv.root.file_id] = inv.root
355
 
        for fid in inv:
356
 
            entry = inv[fid]
357
 
            if entry.parent_id in (None, orig_root_id):
358
 
                entry.parent_id = inv.root.file_id
359
 
        self._write_inventory(inv)
 
245
            bailout('sorry, branch format %r not supported' % fmt,
 
246
                    ['use a different bzr version',
 
247
                     'or remove the .bzr directory and "bzr init" again'])
 
248
 
360
249
 
361
250
    def read_working_inventory(self):
362
251
        """Read the working inventory."""
363
 
        from bzrlib.inventory import Inventory
364
 
        from bzrlib.xml import unpack_xml
365
 
        from time import time
366
 
        before = time()
367
 
        self.lock_read()
368
 
        try:
369
 
            # ElementTree does its own conversion from UTF-8, so open in
370
 
            # binary.
371
 
            inv = unpack_xml(Inventory,
372
 
                             self.controlfile('inventory', 'rb'))
373
 
            mutter("loaded inventory of %d items in %f"
374
 
                   % (len(inv), time() - before))
375
 
            return inv
376
 
        finally:
377
 
            self.unlock()
378
 
            
 
252
        self._need_readlock()
 
253
        before = time.time()
 
254
        # ElementTree does its own conversion from UTF-8, so open in
 
255
        # binary.
 
256
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
257
        mutter("loaded inventory of %d items in %f"
 
258
               % (len(inv), time.time() - before))
 
259
        return inv
 
260
 
379
261
 
380
262
    def _write_inventory(self, inv):
381
263
        """Update the working inventory.
383
265
        That is to say, the inventory describing changes underway, that
384
266
        will be committed to the next revision.
385
267
        """
386
 
        from bzrlib.atomicfile import AtomicFile
387
 
        from bzrlib.xml import pack_xml
388
 
        
389
 
        self.lock_write()
390
 
        try:
391
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
392
 
            try:
393
 
                pack_xml(inv, f)
394
 
                f.commit()
395
 
            finally:
396
 
                f.close()
397
 
        finally:
398
 
            self.unlock()
399
 
        
 
268
        self._need_writelock()
 
269
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
270
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
271
        tmpfname = self.controlfilename('inventory.tmp')
 
272
        tmpf = file(tmpfname, 'wb')
 
273
        inv.write_xml(tmpf)
 
274
        tmpf.close()
 
275
        inv_fname = self.controlfilename('inventory')
 
276
        if sys.platform == 'win32':
 
277
            os.remove(inv_fname)
 
278
        os.rename(tmpfname, inv_fname)
400
279
        mutter('wrote working inventory')
401
 
            
 
280
 
402
281
 
403
282
    inventory = property(read_working_inventory, _write_inventory, None,
404
283
                         """Inventory for the working copy.""")
405
284
 
406
285
 
407
 
    def add(self, files, ids=None):
 
286
    def add(self, files, verbose=False):
408
287
        """Make files versioned.
409
288
 
410
 
        Note that the command line normally calls smart_add instead,
411
 
        which can automatically recurse.
 
289
        Note that the command line normally calls smart_add instead.
412
290
 
413
291
        This puts the files in the Added state, so that they will be
414
292
        recorded by the next commit.
415
293
 
416
 
        files
417
 
            List of paths to add, relative to the base of the tree.
418
 
 
419
 
        ids
420
 
            If set, use these instead of automatically generated ids.
421
 
            Must be the same length as the list of files, but may
422
 
            contain None for ids that are to be autogenerated.
423
 
 
424
294
        TODO: Perhaps have an option to add the ids even if the files do
425
 
              not (yet) exist.
426
 
 
427
 
        TODO: Perhaps yield the ids and paths as they're added.
 
295
               not (yet) exist.
 
296
 
 
297
        TODO: Perhaps return the ids of the files?  But then again it
 
298
               is easy to retrieve them if they're needed.
 
299
 
 
300
        TODO: Option to specify file id.
 
301
 
 
302
        TODO: Adding a directory should optionally recurse down and
 
303
               add all non-ignored children.  Perhaps do that in a
 
304
               higher-level method.
 
305
 
 
306
        >>> b = ScratchBranch(files=['foo'])
 
307
        >>> 'foo' in b.unknowns()
 
308
        True
 
309
        >>> b.show_status()
 
310
        ?       foo
 
311
        >>> b.add('foo')
 
312
        >>> 'foo' in b.unknowns()
 
313
        False
 
314
        >>> bool(b.inventory.path2id('foo'))
 
315
        True
 
316
        >>> b.show_status()
 
317
        A       foo
 
318
 
 
319
        >>> b.add('foo')
 
320
        Traceback (most recent call last):
 
321
        ...
 
322
        BzrError: ('foo is already versioned', [])
 
323
 
 
324
        >>> b.add(['nothere'])
 
325
        Traceback (most recent call last):
 
326
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
428
327
        """
 
328
        self._need_writelock()
 
329
 
429
330
        # TODO: Re-adding a file that is removed in the working copy
430
331
        # should probably put it back with the previous ID.
431
 
        if isinstance(files, basestring):
432
 
            assert(ids is None or isinstance(ids, basestring))
 
332
        if isinstance(files, types.StringTypes):
433
333
            files = [files]
434
 
            if ids is not None:
435
 
                ids = [ids]
436
 
 
437
 
        if ids is None:
438
 
            ids = [None] * len(files)
439
 
        else:
440
 
            assert(len(ids) == len(files))
441
 
 
442
 
        self.lock_write()
443
 
        try:
444
 
            inv = self.read_working_inventory()
445
 
            for f,file_id in zip(files, ids):
446
 
                if is_control_file(f):
447
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
448
 
 
449
 
                fp = splitpath(f)
450
 
 
451
 
                if len(fp) == 0:
452
 
                    raise BzrError("cannot add top-level %r" % f)
453
 
 
454
 
                fullpath = os.path.normpath(self.abspath(f))
455
 
 
456
 
                try:
457
 
                    kind = file_kind(fullpath)
458
 
                except OSError:
459
 
                    # maybe something better?
460
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
 
 
462
 
                if kind != 'file' and kind != 'directory':
463
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
 
 
465
 
                if file_id is None:
466
 
                    file_id = gen_file_id(f)
467
 
                inv.add_path(f, kind=kind, file_id=file_id)
468
 
 
469
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
470
 
 
471
 
            self._write_inventory(inv)
472
 
        finally:
473
 
            self.unlock()
474
 
            
 
334
        
 
335
        inv = self.read_working_inventory()
 
336
        for f in files:
 
337
            if is_control_file(f):
 
338
                bailout("cannot add control file %s" % quotefn(f))
 
339
 
 
340
            fp = splitpath(f)
 
341
 
 
342
            if len(fp) == 0:
 
343
                bailout("cannot add top-level %r" % f)
 
344
                
 
345
            fullpath = os.path.normpath(self.abspath(f))
 
346
 
 
347
            try:
 
348
                kind = file_kind(fullpath)
 
349
            except OSError:
 
350
                # maybe something better?
 
351
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
352
            
 
353
            if kind != 'file' and kind != 'directory':
 
354
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
355
 
 
356
            file_id = gen_file_id(f)
 
357
            inv.add_path(f, kind=kind, file_id=file_id)
 
358
 
 
359
            if verbose:
 
360
                show_status('A', kind, quotefn(f))
 
361
                
 
362
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
363
            
 
364
        self._write_inventory(inv)
 
365
 
475
366
 
476
367
    def print_file(self, file, revno):
477
368
        """Print `file` to stdout."""
478
 
        self.lock_read()
479
 
        try:
480
 
            tree = self.revision_tree(self.lookup_revision(revno))
481
 
            # use inventory as it was in that revision
482
 
            file_id = tree.inventory.path2id(file)
483
 
            if not file_id:
484
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
485
 
            tree.print_file(file_id)
486
 
        finally:
487
 
            self.unlock()
488
 
 
 
369
        self._need_readlock()
 
370
        tree = self.revision_tree(self.lookup_revision(revno))
 
371
        # use inventory as it was in that revision
 
372
        file_id = tree.inventory.path2id(file)
 
373
        if not file_id:
 
374
            bailout("%r is not present in revision %d" % (file, revno))
 
375
        tree.print_file(file_id)
 
376
        
489
377
 
490
378
    def remove(self, files, verbose=False):
491
379
        """Mark nominated files for removal from the inventory.
494
382
 
495
383
        TODO: Refuse to remove modified files unless --force is given?
496
384
 
 
385
        >>> b = ScratchBranch(files=['foo'])
 
386
        >>> b.add('foo')
 
387
        >>> b.inventory.has_filename('foo')
 
388
        True
 
389
        >>> b.remove('foo')
 
390
        >>> b.working_tree().has_filename('foo')
 
391
        True
 
392
        >>> b.inventory.has_filename('foo')
 
393
        False
 
394
        
 
395
        >>> b = ScratchBranch(files=['foo'])
 
396
        >>> b.add('foo')
 
397
        >>> b.commit('one')
 
398
        >>> b.remove('foo')
 
399
        >>> b.commit('two')
 
400
        >>> b.inventory.has_filename('foo') 
 
401
        False
 
402
        >>> b.basis_tree().has_filename('foo') 
 
403
        False
 
404
        >>> b.working_tree().has_filename('foo') 
 
405
        True
 
406
 
497
407
        TODO: Do something useful with directories.
498
408
 
499
409
        TODO: Should this remove the text or not?  Tough call; not
503
413
        """
504
414
        ## TODO: Normalize names
505
415
        ## TODO: Remove nested loops; better scalability
506
 
        if isinstance(files, basestring):
 
416
        self._need_writelock()
 
417
 
 
418
        if isinstance(files, types.StringTypes):
507
419
            files = [files]
508
 
 
509
 
        self.lock_write()
510
 
 
511
 
        try:
512
 
            tree = self.working_tree()
513
 
            inv = tree.inventory
514
 
 
515
 
            # do this before any modifications
516
 
            for f in files:
517
 
                fid = inv.path2id(f)
518
 
                if not fid:
519
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
520
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
521
 
                if verbose:
522
 
                    # having remove it, it must be either ignored or unknown
523
 
                    if tree.is_ignored(f):
524
 
                        new_status = 'I'
525
 
                    else:
526
 
                        new_status = '?'
527
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
528
 
                del inv[fid]
529
 
 
530
 
            self._write_inventory(inv)
531
 
        finally:
532
 
            self.unlock()
533
 
 
534
 
 
535
 
    # FIXME: this doesn't need to be a branch method
536
 
    def set_inventory(self, new_inventory_list):
537
 
        from bzrlib.inventory import Inventory, InventoryEntry
538
 
        inv = Inventory(self.get_root_id())
539
 
        for path, file_id, parent, kind in new_inventory_list:
540
 
            name = os.path.basename(path)
541
 
            if name == "":
542
 
                continue
543
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
420
        
 
421
        tree = self.working_tree()
 
422
        inv = tree.inventory
 
423
 
 
424
        # do this before any modifications
 
425
        for f in files:
 
426
            fid = inv.path2id(f)
 
427
            if not fid:
 
428
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
429
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
430
            if verbose:
 
431
                # having remove it, it must be either ignored or unknown
 
432
                if tree.is_ignored(f):
 
433
                    new_status = 'I'
 
434
                else:
 
435
                    new_status = '?'
 
436
                show_status(new_status, inv[fid].kind, quotefn(f))
 
437
            del inv[fid]
 
438
 
544
439
        self._write_inventory(inv)
545
440
 
546
441
 
563
458
        return self.working_tree().unknowns()
564
459
 
565
460
 
566
 
    def append_revision(self, *revision_ids):
567
 
        from bzrlib.atomicfile import AtomicFile
568
 
 
569
 
        for revision_id in revision_ids:
570
 
            mutter("add {%s} to revision-history" % revision_id)
571
 
 
 
461
    def commit(self, message, timestamp=None, timezone=None,
 
462
               committer=None,
 
463
               verbose=False):
 
464
        """Commit working copy as a new revision.
 
465
        
 
466
        The basic approach is to add all the file texts into the
 
467
        store, then the inventory, then make a new revision pointing
 
468
        to that inventory and store that.
 
469
        
 
470
        This is not quite safe if the working copy changes during the
 
471
        commit; for the moment that is simply not allowed.  A better
 
472
        approach is to make a temporary copy of the files before
 
473
        computing their hashes, and then add those hashes in turn to
 
474
        the inventory.  This should mean at least that there are no
 
475
        broken hash pointers.  There is no way we can get a snapshot
 
476
        of the whole directory at an instant.  This would also have to
 
477
        be robust against files disappearing, moving, etc.  So the
 
478
        whole thing is a bit hard.
 
479
 
 
480
        timestamp -- if not None, seconds-since-epoch for a
 
481
             postdated/predated commit.
 
482
        """
 
483
        self._need_writelock()
 
484
 
 
485
        ## TODO: Show branch names
 
486
 
 
487
        # TODO: Don't commit if there are no changes, unless forced?
 
488
 
 
489
        # First walk over the working inventory; and both update that
 
490
        # and also build a new revision inventory.  The revision
 
491
        # inventory needs to hold the text-id, sha1 and size of the
 
492
        # actual file versions committed in the revision.  (These are
 
493
        # not present in the working inventory.)  We also need to
 
494
        # detect missing/deleted files, and remove them from the
 
495
        # working inventory.
 
496
 
 
497
        work_inv = self.read_working_inventory()
 
498
        inv = Inventory()
 
499
        basis = self.basis_tree()
 
500
        basis_inv = basis.inventory
 
501
        missing_ids = []
 
502
        for path, entry in work_inv.iter_entries():
 
503
            ## TODO: Cope with files that have gone missing.
 
504
 
 
505
            ## TODO: Check that the file kind has not changed from the previous
 
506
            ## revision of this file (if any).
 
507
 
 
508
            entry = entry.copy()
 
509
 
 
510
            p = self.abspath(path)
 
511
            file_id = entry.file_id
 
512
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
513
 
 
514
            if not os.path.exists(p):
 
515
                mutter("    file is missing, removing from inventory")
 
516
                if verbose:
 
517
                    show_status('D', entry.kind, quotefn(path))
 
518
                missing_ids.append(file_id)
 
519
                continue
 
520
 
 
521
            # TODO: Handle files that have been deleted
 
522
 
 
523
            # TODO: Maybe a special case for empty files?  Seems a
 
524
            # waste to store them many times.
 
525
 
 
526
            inv.add(entry)
 
527
 
 
528
            if basis_inv.has_id(file_id):
 
529
                old_kind = basis_inv[file_id].kind
 
530
                if old_kind != entry.kind:
 
531
                    bailout("entry %r changed kind from %r to %r"
 
532
                            % (file_id, old_kind, entry.kind))
 
533
 
 
534
            if entry.kind == 'directory':
 
535
                if not isdir(p):
 
536
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
537
            elif entry.kind == 'file':
 
538
                if not isfile(p):
 
539
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
540
 
 
541
                content = file(p, 'rb').read()
 
542
 
 
543
                entry.text_sha1 = sha_string(content)
 
544
                entry.text_size = len(content)
 
545
 
 
546
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
547
                if (old_ie
 
548
                    and (old_ie.text_size == entry.text_size)
 
549
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
550
                    ## assert content == basis.get_file(file_id).read()
 
551
                    entry.text_id = basis_inv[file_id].text_id
 
552
                    mutter('    unchanged from previous text_id {%s}' %
 
553
                           entry.text_id)
 
554
                    
 
555
                else:
 
556
                    entry.text_id = gen_file_id(entry.name)
 
557
                    self.text_store.add(content, entry.text_id)
 
558
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
559
                    if verbose:
 
560
                        if not old_ie:
 
561
                            state = 'A'
 
562
                        elif (old_ie.name == entry.name
 
563
                              and old_ie.parent_id == entry.parent_id):
 
564
                            state = 'M'
 
565
                        else:
 
566
                            state = 'R'
 
567
 
 
568
                        show_status(state, entry.kind, quotefn(path))
 
569
 
 
570
        for file_id in missing_ids:
 
571
            # have to do this later so we don't mess up the iterator.
 
572
            # since parents may be removed before their children we
 
573
            # have to test.
 
574
 
 
575
            # FIXME: There's probably a better way to do this; perhaps
 
576
            # the workingtree should know how to filter itself.
 
577
            if work_inv.has_id(file_id):
 
578
                del work_inv[file_id]
 
579
 
 
580
 
 
581
        inv_id = rev_id = _gen_revision_id(time.time())
 
582
        
 
583
        inv_tmp = tempfile.TemporaryFile()
 
584
        inv.write_xml(inv_tmp)
 
585
        inv_tmp.seek(0)
 
586
        self.inventory_store.add(inv_tmp, inv_id)
 
587
        mutter('new inventory_id is {%s}' % inv_id)
 
588
 
 
589
        self._write_inventory(work_inv)
 
590
 
 
591
        if timestamp == None:
 
592
            timestamp = time.time()
 
593
 
 
594
        if committer == None:
 
595
            committer = username()
 
596
 
 
597
        if timezone == None:
 
598
            timezone = local_time_offset()
 
599
 
 
600
        mutter("building commit log message")
 
601
        rev = Revision(timestamp=timestamp,
 
602
                       timezone=timezone,
 
603
                       committer=committer,
 
604
                       precursor = self.last_patch(),
 
605
                       message = message,
 
606
                       inventory_id=inv_id,
 
607
                       revision_id=rev_id)
 
608
 
 
609
        rev_tmp = tempfile.TemporaryFile()
 
610
        rev.write_xml(rev_tmp)
 
611
        rev_tmp.seek(0)
 
612
        self.revision_store.add(rev_tmp, rev_id)
 
613
        mutter("new revision_id is {%s}" % rev_id)
 
614
        
 
615
        ## XXX: Everything up to here can simply be orphaned if we abort
 
616
        ## the commit; it will leave junk files behind but that doesn't
 
617
        ## matter.
 
618
 
 
619
        ## TODO: Read back the just-generated changeset, and make sure it
 
620
        ## applies and recreates the right state.
 
621
 
 
622
        ## TODO: Also calculate and store the inventory SHA1
 
623
        mutter("committing patch r%d" % (self.revno() + 1))
 
624
 
 
625
 
 
626
        self.append_revision(rev_id)
 
627
        
 
628
        if verbose:
 
629
            note("commited r%d" % self.revno())
 
630
 
 
631
 
 
632
    def append_revision(self, revision_id):
 
633
        mutter("add {%s} to revision-history" % revision_id)
572
634
        rev_history = self.revision_history()
573
 
        rev_history.extend(revision_ids)
574
 
 
575
 
        f = AtomicFile(self.controlfilename('revision-history'))
576
 
        try:
577
 
            for rev_id in rev_history:
578
 
                print >>f, rev_id
579
 
            f.commit()
580
 
        finally:
581
 
            f.close()
582
 
 
583
 
 
584
 
    def get_revision_xml(self, revision_id):
585
 
        """Return XML file object for revision object."""
586
 
        if not revision_id or not isinstance(revision_id, basestring):
587
 
            raise InvalidRevisionId(revision_id)
588
 
 
589
 
        self.lock_read()
590
 
        try:
591
 
            try:
592
 
                return self.revision_store[revision_id]
593
 
            except IndexError:
594
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
595
 
        finally:
596
 
            self.unlock()
 
635
 
 
636
        tmprhname = self.controlfilename('revision-history.tmp')
 
637
        rhname = self.controlfilename('revision-history')
 
638
        
 
639
        f = file(tmprhname, 'wt')
 
640
        rev_history.append(revision_id)
 
641
        f.write('\n'.join(rev_history))
 
642
        f.write('\n')
 
643
        f.close()
 
644
 
 
645
        if sys.platform == 'win32':
 
646
            os.remove(rhname)
 
647
        os.rename(tmprhname, rhname)
 
648
        
597
649
 
598
650
 
599
651
    def get_revision(self, revision_id):
600
652
        """Return the Revision object for a named revision"""
601
 
        xml_file = self.get_revision_xml(revision_id)
602
 
 
603
 
        try:
604
 
            r = unpack_xml(Revision, xml_file)
605
 
        except SyntaxError, e:
606
 
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
607
 
                                         [revision_id,
608
 
                                          str(e)])
609
 
            
 
653
        self._need_readlock()
 
654
        r = Revision.read_xml(self.revision_store[revision_id])
610
655
        assert r.revision_id == revision_id
611
656
        return r
612
657
 
613
658
 
614
 
    def get_revision_delta(self, revno):
615
 
        """Return the delta for one revision.
616
 
 
617
 
        The delta is relative to its mainline predecessor, or the
618
 
        empty tree for revision 1.
619
 
        """
620
 
        assert isinstance(revno, int)
621
 
        rh = self.revision_history()
622
 
        if not (1 <= revno <= len(rh)):
623
 
            raise InvalidRevisionNumber(revno)
624
 
 
625
 
        # revno is 1-based; list is 0-based
626
 
 
627
 
        new_tree = self.revision_tree(rh[revno-1])
628
 
        if revno == 1:
629
 
            old_tree = EmptyTree()
630
 
        else:
631
 
            old_tree = self.revision_tree(rh[revno-2])
632
 
 
633
 
        return compare_trees(old_tree, new_tree)
634
 
 
635
 
        
636
 
 
637
 
    def get_revision_sha1(self, revision_id):
638
 
        """Hash the stored value of a revision, and return it."""
639
 
        # In the future, revision entries will be signed. At that
640
 
        # point, it is probably best *not* to include the signature
641
 
        # in the revision hash. Because that lets you re-sign
642
 
        # the revision, (add signatures/remove signatures) and still
643
 
        # have all hash pointers stay consistent.
644
 
        # But for now, just hash the contents.
645
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
646
 
 
647
 
 
648
659
    def get_inventory(self, inventory_id):
649
660
        """Get Inventory object by hash.
650
661
 
651
662
        TODO: Perhaps for this and similar methods, take a revision
652
663
               parameter which can be either an integer revno or a
653
664
               string hash."""
654
 
        from bzrlib.inventory import Inventory
655
 
        from bzrlib.xml import unpack_xml
656
 
 
657
 
        return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
658
 
 
659
 
 
660
 
    def get_inventory_xml(self, inventory_id):
661
 
        """Get inventory XML as a file object."""
662
 
        return self.inventory_store[inventory_id]
663
 
            
664
 
 
665
 
    def get_inventory_sha1(self, inventory_id):
666
 
        """Return the sha1 hash of the inventory entry
667
 
        """
668
 
        return sha_file(self.get_inventory_xml(inventory_id))
 
665
        self._need_readlock()
 
666
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
667
        return i
669
668
 
670
669
 
671
670
    def get_revision_inventory(self, revision_id):
672
671
        """Return inventory of a past revision."""
673
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
674
 
        # must be the same as its revision, so this is trivial.
 
672
        self._need_readlock()
675
673
        if revision_id == None:
676
 
            from bzrlib.inventory import Inventory
677
 
            return Inventory(self.get_root_id())
 
674
            return Inventory()
678
675
        else:
679
 
            return self.get_inventory(revision_id)
 
676
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
680
677
 
681
678
 
682
679
    def revision_history(self):
685
682
        >>> ScratchBranch().revision_history()
686
683
        []
687
684
        """
688
 
        self.lock_read()
689
 
        try:
690
 
            return [l.rstrip('\r\n') for l in
691
 
                    self.controlfile('revision-history', 'r').readlines()]
692
 
        finally:
693
 
            self.unlock()
694
 
 
695
 
 
696
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
697
 
        """
698
 
        >>> import commit
699
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
700
 
        >>> sb.common_ancestor(sb) == (None, None)
701
 
        True
702
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
703
 
        >>> sb.common_ancestor(sb)[0]
704
 
        1
705
 
        >>> clone = sb.clone()
706
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
707
 
        >>> sb.common_ancestor(sb)[0]
708
 
        2
709
 
        >>> sb.common_ancestor(clone)[0]
710
 
        1
711
 
        >>> commit.commit(clone, "Committing divergent second revision", 
712
 
        ...               verbose=False)
713
 
        >>> sb.common_ancestor(clone)[0]
714
 
        1
715
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
716
 
        True
717
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
718
 
        True
719
 
        >>> clone2 = sb.clone()
720
 
        >>> sb.common_ancestor(clone2)[0]
721
 
        2
722
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
723
 
        1
724
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
725
 
        1
726
 
        """
727
 
        my_history = self.revision_history()
728
 
        other_history = other.revision_history()
729
 
        if self_revno is None:
730
 
            self_revno = len(my_history)
731
 
        if other_revno is None:
732
 
            other_revno = len(other_history)
733
 
        indices = range(min((self_revno, other_revno)))
734
 
        indices.reverse()
735
 
        for r in indices:
736
 
            if my_history[r] == other_history[r]:
737
 
                return r+1, my_history[r]
738
 
        return None, None
 
685
        self._need_readlock()
 
686
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
739
687
 
740
688
 
741
689
    def revno(self):
743
691
 
744
692
        That is equivalent to the number of revisions committed to
745
693
        this branch.
 
694
 
 
695
        >>> b = ScratchBranch()
 
696
        >>> b.revno()
 
697
        0
 
698
        >>> b.commit('no foo')
 
699
        >>> b.revno()
 
700
        1
746
701
        """
747
702
        return len(self.revision_history())
748
703
 
749
704
 
750
705
    def last_patch(self):
751
706
        """Return last patch hash, or None if no history.
 
707
 
 
708
        >>> ScratchBranch().last_patch() == None
 
709
        True
752
710
        """
753
711
        ph = self.revision_history()
754
712
        if ph:
755
713
            return ph[-1]
756
714
        else:
757
715
            return None
758
 
 
759
 
 
760
 
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
761
 
        """
762
 
        If self and other have not diverged, return a list of the revisions
763
 
        present in other, but missing from self.
764
 
 
765
 
        >>> from bzrlib.commit import commit
766
 
        >>> bzrlib.trace.silent = True
767
 
        >>> br1 = ScratchBranch()
768
 
        >>> br2 = ScratchBranch()
769
 
        >>> br1.missing_revisions(br2)
770
 
        []
771
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
772
 
        >>> br1.missing_revisions(br2)
773
 
        [u'REVISION-ID-1']
774
 
        >>> br2.missing_revisions(br1)
775
 
        []
776
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
777
 
        >>> br1.missing_revisions(br2)
778
 
        []
779
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
780
 
        >>> br1.missing_revisions(br2)
781
 
        [u'REVISION-ID-2A']
782
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
783
 
        >>> br1.missing_revisions(br2)
784
 
        Traceback (most recent call last):
785
 
        DivergedBranches: These branches have diverged.
786
 
        """
787
 
        self_history = self.revision_history()
788
 
        self_len = len(self_history)
789
 
        other_history = other.revision_history()
790
 
        other_len = len(other_history)
791
 
        common_index = min(self_len, other_len) -1
792
 
        if common_index >= 0 and \
793
 
            self_history[common_index] != other_history[common_index]:
794
 
            raise DivergedBranches(self, other)
795
 
 
796
 
        if stop_revision is None:
797
 
            stop_revision = other_len
798
 
        elif stop_revision > other_len:
799
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
800
 
        
801
 
        return other_history[self_len:stop_revision]
802
 
 
803
 
 
804
 
    def update_revisions(self, other, stop_revision=None):
805
 
        """Pull in all new revisions from other branch.
806
 
        """
807
 
        from bzrlib.fetch import greedy_fetch
808
 
 
809
 
        pb = bzrlib.ui.ui_factory.progress_bar()
810
 
        pb.update('comparing histories')
811
 
 
812
 
        revision_ids = self.missing_revisions(other, stop_revision)
813
 
 
814
 
        if len(revision_ids) > 0:
815
 
            count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
816
 
        else:
817
 
            count = 0
818
 
        self.append_revision(*revision_ids)
819
 
        ## note("Added %d revisions." % count)
820
 
        pb.clear()
821
 
 
822
 
    def install_revisions(self, other, revision_ids, pb):
823
 
        if hasattr(other.revision_store, "prefetch"):
824
 
            other.revision_store.prefetch(revision_ids)
825
 
        if hasattr(other.inventory_store, "prefetch"):
826
 
            inventory_ids = [other.get_revision(r).inventory_id
827
 
                             for r in revision_ids]
828
 
            other.inventory_store.prefetch(inventory_ids)
829
 
 
830
 
        if pb is None:
831
 
            pb = bzrlib.ui.ui_factory.progress_bar()
832
 
                
833
 
        revisions = []
834
 
        needed_texts = set()
835
 
        i = 0
836
 
 
837
 
        failures = set()
838
 
        for i, rev_id in enumerate(revision_ids):
839
 
            pb.update('fetching revision', i+1, len(revision_ids))
840
 
            try:
841
 
                rev = other.get_revision(rev_id)
842
 
            except bzrlib.errors.NoSuchRevision:
843
 
                failures.add(rev_id)
844
 
                continue
845
 
 
846
 
            revisions.append(rev)
847
 
            inv = other.get_inventory(str(rev.inventory_id))
848
 
            for key, entry in inv.iter_entries():
849
 
                if entry.text_id is None:
850
 
                    continue
851
 
                if entry.text_id not in self.text_store:
852
 
                    needed_texts.add(entry.text_id)
853
 
 
854
 
        pb.clear()
855
 
                    
856
 
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
857
 
                                                    needed_texts)
858
 
        #print "Added %d texts." % count 
859
 
        inventory_ids = [ f.inventory_id for f in revisions ]
860
 
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
861
 
                                                         inventory_ids)
862
 
        #print "Added %d inventories." % count 
863
 
        revision_ids = [ f.revision_id for f in revisions]
864
 
 
865
 
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
866
 
                                                          revision_ids,
867
 
                                                          permit_failure=True)
868
 
        assert len(cp_fail) == 0 
869
 
        return count, failures
870
 
       
871
 
 
872
 
    def commit(self, *args, **kw):
873
 
        from bzrlib.commit import commit
874
 
        commit(self, *args, **kw)
875
 
        
876
 
 
877
 
    def lookup_revision(self, revision):
878
 
        """Return the revision identifier for a given revision information."""
879
 
        revno, info = self.get_revision_info(revision)
880
 
        return info
881
 
 
882
 
 
883
 
    def revision_id_to_revno(self, revision_id):
884
 
        """Given a revision id, return its revno"""
885
 
        history = self.revision_history()
886
 
        try:
887
 
            return history.index(revision_id) + 1
888
 
        except ValueError:
889
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
890
 
 
891
 
 
892
 
    def get_revision_info(self, revision):
893
 
        """Return (revno, revision id) for revision identifier.
894
 
 
895
 
        revision can be an integer, in which case it is assumed to be revno (though
896
 
            this will translate negative values into positive ones)
897
 
        revision can also be a string, in which case it is parsed for something like
898
 
            'date:' or 'revid:' etc.
899
 
        """
900
 
        if revision is None:
901
 
            return 0, None
902
 
        revno = None
903
 
        try:# Convert to int if possible
904
 
            revision = int(revision)
905
 
        except ValueError:
906
 
            pass
907
 
        revs = self.revision_history()
908
 
        if isinstance(revision, int):
909
 
            if revision == 0:
910
 
                return 0, None
911
 
            # Mabye we should do this first, but we don't need it if revision == 0
912
 
            if revision < 0:
913
 
                revno = len(revs) + revision + 1
914
 
            else:
915
 
                revno = revision
916
 
        elif isinstance(revision, basestring):
917
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
918
 
                if revision.startswith(prefix):
919
 
                    revno = func(self, revs, revision)
920
 
                    break
921
 
            else:
922
 
                raise BzrError('No namespace registered for string: %r' % revision)
923
 
 
924
 
        if revno is None or revno <= 0 or revno > len(revs):
925
 
            raise BzrError("no such revision %s" % revision)
926
 
        return revno, revs[revno-1]
927
 
 
928
 
    def _namespace_revno(self, revs, revision):
929
 
        """Lookup a revision by revision number"""
930
 
        assert revision.startswith('revno:')
931
 
        try:
932
 
            return int(revision[6:])
933
 
        except ValueError:
934
 
            return None
935
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
936
 
 
937
 
    def _namespace_revid(self, revs, revision):
938
 
        assert revision.startswith('revid:')
939
 
        try:
940
 
            return revs.index(revision[6:]) + 1
941
 
        except ValueError:
942
 
            return None
943
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
944
 
 
945
 
    def _namespace_last(self, revs, revision):
946
 
        assert revision.startswith('last:')
947
 
        try:
948
 
            offset = int(revision[5:])
949
 
        except ValueError:
950
 
            return None
951
 
        else:
952
 
            if offset <= 0:
953
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
954
 
            return len(revs) - offset + 1
955
 
    REVISION_NAMESPACES['last:'] = _namespace_last
956
 
 
957
 
    def _namespace_tag(self, revs, revision):
958
 
        assert revision.startswith('tag:')
959
 
        raise BzrError('tag: namespace registered, but not implemented.')
960
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
961
 
 
962
 
    def _namespace_date(self, revs, revision):
963
 
        assert revision.startswith('date:')
964
 
        import datetime
965
 
        # Spec for date revisions:
966
 
        #   date:value
967
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
968
 
        #   it can also start with a '+/-/='. '+' says match the first
969
 
        #   entry after the given date. '-' is match the first entry before the date
970
 
        #   '=' is match the first entry after, but still on the given date.
971
 
        #
972
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
973
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
974
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
975
 
        #       May 13th, 2005 at 0:00
976
 
        #
977
 
        #   So the proper way of saying 'give me all entries for today' is:
978
 
        #       -r {date:+today}:{date:-tomorrow}
979
 
        #   The default is '=' when not supplied
980
 
        val = revision[5:]
981
 
        match_style = '='
982
 
        if val[:1] in ('+', '-', '='):
983
 
            match_style = val[:1]
984
 
            val = val[1:]
985
 
 
986
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
987
 
        if val.lower() == 'yesterday':
988
 
            dt = today - datetime.timedelta(days=1)
989
 
        elif val.lower() == 'today':
990
 
            dt = today
991
 
        elif val.lower() == 'tomorrow':
992
 
            dt = today + datetime.timedelta(days=1)
993
 
        else:
994
 
            import re
995
 
            # This should be done outside the function to avoid recompiling it.
996
 
            _date_re = re.compile(
997
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
998
 
                    r'(,|T)?\s*'
999
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1000
 
                )
1001
 
            m = _date_re.match(val)
1002
 
            if not m or (not m.group('date') and not m.group('time')):
1003
 
                raise BzrError('Invalid revision date %r' % revision)
1004
 
 
1005
 
            if m.group('date'):
1006
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1007
 
            else:
1008
 
                year, month, day = today.year, today.month, today.day
1009
 
            if m.group('time'):
1010
 
                hour = int(m.group('hour'))
1011
 
                minute = int(m.group('minute'))
1012
 
                if m.group('second'):
1013
 
                    second = int(m.group('second'))
1014
 
                else:
1015
 
                    second = 0
1016
 
            else:
1017
 
                hour, minute, second = 0,0,0
1018
 
 
1019
 
            dt = datetime.datetime(year=year, month=month, day=day,
1020
 
                    hour=hour, minute=minute, second=second)
1021
 
        first = dt
1022
 
        last = None
1023
 
        reversed = False
1024
 
        if match_style == '-':
1025
 
            reversed = True
1026
 
        elif match_style == '=':
1027
 
            last = dt + datetime.timedelta(days=1)
1028
 
 
1029
 
        if reversed:
1030
 
            for i in range(len(revs)-1, -1, -1):
1031
 
                r = self.get_revision(revs[i])
1032
 
                # TODO: Handle timezone.
1033
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1034
 
                if first >= dt and (last is None or dt >= last):
1035
 
                    return i+1
1036
 
        else:
1037
 
            for i in range(len(revs)):
1038
 
                r = self.get_revision(revs[i])
1039
 
                # TODO: Handle timezone.
1040
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1041
 
                if first <= dt and (last is None or dt <= last):
1042
 
                    return i+1
1043
 
    REVISION_NAMESPACES['date:'] = _namespace_date
 
716
        
 
717
 
 
718
    def lookup_revision(self, revno):
 
719
        """Return revision hash for revision number."""
 
720
        if revno == 0:
 
721
            return None
 
722
 
 
723
        try:
 
724
            # list is 0-based; revisions are 1-based
 
725
            return self.revision_history()[revno-1]
 
726
        except IndexError:
 
727
            raise BzrError("no such revision %s" % revno)
 
728
 
1044
729
 
1045
730
    def revision_tree(self, revision_id):
1046
731
        """Return Tree for a revision on this branch.
1047
732
 
1048
733
        `revision_id` may be None for the null revision, in which case
1049
734
        an `EmptyTree` is returned."""
1050
 
        # TODO: refactor this to use an existing revision object
1051
 
        # so we don't need to read it in twice.
 
735
        self._need_readlock()
1052
736
        if revision_id == None:
1053
737
            return EmptyTree()
1054
738
        else:
1058
742
 
1059
743
    def working_tree(self):
1060
744
        """Return a `Tree` for the working copy."""
1061
 
        from workingtree import WorkingTree
1062
745
        return WorkingTree(self.base, self.read_working_inventory())
1063
746
 
1064
747
 
1066
749
        """Return `Tree` object for last revision.
1067
750
 
1068
751
        If there are no revisions yet, return an `EmptyTree`.
 
752
 
 
753
        >>> b = ScratchBranch(files=['foo'])
 
754
        >>> b.basis_tree().has_filename('foo')
 
755
        False
 
756
        >>> b.working_tree().has_filename('foo')
 
757
        True
 
758
        >>> b.add('foo')
 
759
        >>> b.commit('add foo')
 
760
        >>> b.basis_tree().has_filename('foo')
 
761
        True
1069
762
        """
1070
763
        r = self.last_patch()
1071
764
        if r == None:
1075
768
 
1076
769
 
1077
770
 
 
771
    def write_log(self, show_timezone='original', verbose=False):
 
772
        """Write out human-readable log of commits to this branch
 
773
 
 
774
        utc -- If true, show dates in universal time, not local time."""
 
775
        self._need_readlock()
 
776
        ## TODO: Option to choose either original, utc or local timezone
 
777
        revno = 1
 
778
        precursor = None
 
779
        for p in self.revision_history():
 
780
            print '-' * 40
 
781
            print 'revno:', revno
 
782
            ## TODO: Show hash if --id is given.
 
783
            ##print 'revision-hash:', p
 
784
            rev = self.get_revision(p)
 
785
            print 'committer:', rev.committer
 
786
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
787
                                                 show_timezone))
 
788
 
 
789
            ## opportunistic consistency check, same as check_patch_chaining
 
790
            if rev.precursor != precursor:
 
791
                bailout("mismatched precursor!")
 
792
 
 
793
            print 'message:'
 
794
            if not rev.message:
 
795
                print '  (no message)'
 
796
            else:
 
797
                for l in rev.message.split('\n'):
 
798
                    print '  ' + l
 
799
 
 
800
            if verbose == True and precursor != None:
 
801
                print 'changed files:'
 
802
                tree = self.revision_tree(p)
 
803
                prevtree = self.revision_tree(precursor)
 
804
                
 
805
                for file_state, fid, old_name, new_name, kind in \
 
806
                                        diff_trees(prevtree, tree, ):
 
807
                    if file_state == 'A' or file_state == 'M':
 
808
                        show_status(file_state, kind, new_name)
 
809
                    elif file_state == 'D':
 
810
                        show_status(file_state, kind, old_name)
 
811
                    elif file_state == 'R':
 
812
                        show_status(file_state, kind,
 
813
                            old_name + ' => ' + new_name)
 
814
                
 
815
            revno += 1
 
816
            precursor = p
 
817
 
 
818
 
1078
819
    def rename_one(self, from_rel, to_rel):
1079
820
        """Rename one file.
1080
821
 
1081
822
        This can change the directory or the filename or both.
1082
823
        """
1083
 
        self.lock_write()
 
824
        self._need_writelock()
 
825
        tree = self.working_tree()
 
826
        inv = tree.inventory
 
827
        if not tree.has_filename(from_rel):
 
828
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
829
        if tree.has_filename(to_rel):
 
830
            bailout("can't rename: new working file %r already exists" % to_rel)
 
831
            
 
832
        file_id = inv.path2id(from_rel)
 
833
        if file_id == None:
 
834
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
835
 
 
836
        if inv.path2id(to_rel):
 
837
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
838
 
 
839
        to_dir, to_tail = os.path.split(to_rel)
 
840
        to_dir_id = inv.path2id(to_dir)
 
841
        if to_dir_id == None and to_dir != '':
 
842
            bailout("can't determine destination directory id for %r" % to_dir)
 
843
 
 
844
        mutter("rename_one:")
 
845
        mutter("  file_id    {%s}" % file_id)
 
846
        mutter("  from_rel   %r" % from_rel)
 
847
        mutter("  to_rel     %r" % to_rel)
 
848
        mutter("  to_dir     %r" % to_dir)
 
849
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
850
            
 
851
        inv.rename(file_id, to_dir_id, to_tail)
 
852
 
 
853
        print "%s => %s" % (from_rel, to_rel)
 
854
        
 
855
        from_abs = self.abspath(from_rel)
 
856
        to_abs = self.abspath(to_rel)
1084
857
        try:
1085
 
            tree = self.working_tree()
1086
 
            inv = tree.inventory
1087
 
            if not tree.has_filename(from_rel):
1088
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1089
 
            if tree.has_filename(to_rel):
1090
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
1091
 
 
1092
 
            file_id = inv.path2id(from_rel)
1093
 
            if file_id == None:
1094
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1095
 
 
1096
 
            if inv.path2id(to_rel):
1097
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1098
 
 
1099
 
            to_dir, to_tail = os.path.split(to_rel)
1100
 
            to_dir_id = inv.path2id(to_dir)
1101
 
            if to_dir_id == None and to_dir != '':
1102
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
1103
 
 
1104
 
            mutter("rename_one:")
1105
 
            mutter("  file_id    {%s}" % file_id)
1106
 
            mutter("  from_rel   %r" % from_rel)
1107
 
            mutter("  to_rel     %r" % to_rel)
1108
 
            mutter("  to_dir     %r" % to_dir)
1109
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
1110
 
 
1111
 
            inv.rename(file_id, to_dir_id, to_tail)
1112
 
 
1113
 
            from_abs = self.abspath(from_rel)
1114
 
            to_abs = self.abspath(to_rel)
1115
 
            try:
1116
 
                os.rename(from_abs, to_abs)
1117
 
            except OSError, e:
1118
 
                raise BzrError("failed to rename %r to %r: %s"
1119
 
                        % (from_abs, to_abs, e[1]),
1120
 
                        ["rename rolled back"])
1121
 
 
1122
 
            self._write_inventory(inv)
1123
 
        finally:
1124
 
            self.unlock()
 
858
            os.rename(from_abs, to_abs)
 
859
        except OSError, e:
 
860
            bailout("failed to rename %r to %r: %s"
 
861
                    % (from_abs, to_abs, e[1]),
 
862
                    ["rename rolled back"])
 
863
 
 
864
        self._write_inventory(inv)
 
865
            
1125
866
 
1126
867
 
1127
868
    def move(self, from_paths, to_name):
1134
875
 
1135
876
        Note that to_name is only the last component of the new name;
1136
877
        this doesn't change the directory.
1137
 
 
1138
 
        This returns a list of (from_path, to_path) pairs for each
1139
 
        entry that is moved.
1140
 
        """
1141
 
        result = []
1142
 
        self.lock_write()
1143
 
        try:
1144
 
            ## TODO: Option to move IDs only
1145
 
            assert not isinstance(from_paths, basestring)
1146
 
            tree = self.working_tree()
1147
 
            inv = tree.inventory
1148
 
            to_abs = self.abspath(to_name)
1149
 
            if not isdir(to_abs):
1150
 
                raise BzrError("destination %r is not a directory" % to_abs)
1151
 
            if not tree.has_filename(to_name):
1152
 
                raise BzrError("destination %r not in working directory" % to_abs)
1153
 
            to_dir_id = inv.path2id(to_name)
1154
 
            if to_dir_id == None and to_name != '':
1155
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
1156
 
            to_dir_ie = inv[to_dir_id]
1157
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
1158
 
                raise BzrError("destination %r is not a directory" % to_abs)
1159
 
 
1160
 
            to_idpath = inv.get_idpath(to_dir_id)
1161
 
 
1162
 
            for f in from_paths:
1163
 
                if not tree.has_filename(f):
1164
 
                    raise BzrError("%r does not exist in working tree" % f)
1165
 
                f_id = inv.path2id(f)
1166
 
                if f_id == None:
1167
 
                    raise BzrError("%r is not versioned" % f)
1168
 
                name_tail = splitpath(f)[-1]
1169
 
                dest_path = appendpath(to_name, name_tail)
1170
 
                if tree.has_filename(dest_path):
1171
 
                    raise BzrError("destination %r already exists" % dest_path)
1172
 
                if f_id in to_idpath:
1173
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
1174
 
 
1175
 
            # OK, so there's a race here, it's possible that someone will
1176
 
            # create a file in this interval and then the rename might be
1177
 
            # left half-done.  But we should have caught most problems.
1178
 
 
1179
 
            for f in from_paths:
1180
 
                name_tail = splitpath(f)[-1]
1181
 
                dest_path = appendpath(to_name, name_tail)
1182
 
                result.append((f, dest_path))
1183
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1184
 
                try:
1185
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
1186
 
                except OSError, e:
1187
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1188
 
                            ["rename rolled back"])
1189
 
 
1190
 
            self._write_inventory(inv)
1191
 
        finally:
1192
 
            self.unlock()
1193
 
 
1194
 
        return result
1195
 
 
1196
 
 
1197
 
    def revert(self, filenames, old_tree=None, backups=True):
1198
 
        """Restore selected files to the versions from a previous tree.
1199
 
 
1200
 
        backups
1201
 
            If true (default) backups are made of files before
1202
 
            they're renamed.
1203
 
        """
1204
 
        from bzrlib.errors import NotVersionedError, BzrError
1205
 
        from bzrlib.atomicfile import AtomicFile
1206
 
        from bzrlib.osutils import backup_file
 
878
        """
 
879
        self._need_writelock()
 
880
        ## TODO: Option to move IDs only
 
881
        assert not isinstance(from_paths, basestring)
 
882
        tree = self.working_tree()
 
883
        inv = tree.inventory
 
884
        to_abs = self.abspath(to_name)
 
885
        if not isdir(to_abs):
 
886
            bailout("destination %r is not a directory" % to_abs)
 
887
        if not tree.has_filename(to_name):
 
888
            bailout("destination %r not in working directory" % to_abs)
 
889
        to_dir_id = inv.path2id(to_name)
 
890
        if to_dir_id == None and to_name != '':
 
891
            bailout("destination %r is not a versioned directory" % to_name)
 
892
        to_dir_ie = inv[to_dir_id]
 
893
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
894
            bailout("destination %r is not a directory" % to_abs)
 
895
 
 
896
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
897
 
 
898
        for f in from_paths:
 
899
            if not tree.has_filename(f):
 
900
                bailout("%r does not exist in working tree" % f)
 
901
            f_id = inv.path2id(f)
 
902
            if f_id == None:
 
903
                bailout("%r is not versioned" % f)
 
904
            name_tail = splitpath(f)[-1]
 
905
            dest_path = appendpath(to_name, name_tail)
 
906
            if tree.has_filename(dest_path):
 
907
                bailout("destination %r already exists" % dest_path)
 
908
            if f_id in to_idpath:
 
909
                bailout("can't move %r to a subdirectory of itself" % f)
 
910
 
 
911
        # OK, so there's a race here, it's possible that someone will
 
912
        # create a file in this interval and then the rename might be
 
913
        # left half-done.  But we should have caught most problems.
 
914
 
 
915
        for f in from_paths:
 
916
            name_tail = splitpath(f)[-1]
 
917
            dest_path = appendpath(to_name, name_tail)
 
918
            print "%s => %s" % (f, dest_path)
 
919
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
920
            try:
 
921
                os.rename(self.abspath(f), self.abspath(dest_path))
 
922
            except OSError, e:
 
923
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
924
                        ["rename rolled back"])
 
925
 
 
926
        self._write_inventory(inv)
 
927
 
 
928
 
 
929
 
 
930
    def show_status(self, show_all=False):
 
931
        """Display single-line status for non-ignored working files.
 
932
 
 
933
        The list is show sorted in order by file name.
 
934
 
 
935
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
936
        >>> b.show_status()
 
937
        ?       foo
 
938
        >>> b.add('foo')
 
939
        >>> b.show_status()
 
940
        A       foo
 
941
        >>> b.commit("add foo")
 
942
        >>> b.show_status()
 
943
        >>> os.unlink(b.abspath('foo'))
 
944
        >>> b.show_status()
 
945
        D       foo
1207
946
        
1208
 
        inv = self.read_working_inventory()
1209
 
        if old_tree is None:
1210
 
            old_tree = self.basis_tree()
1211
 
        old_inv = old_tree.inventory
1212
 
 
1213
 
        nids = []
1214
 
        for fn in filenames:
1215
 
            file_id = inv.path2id(fn)
1216
 
            if not file_id:
1217
 
                raise NotVersionedError("not a versioned file", fn)
1218
 
            if not old_inv.has_id(file_id):
1219
 
                raise BzrError("file not present in old tree", fn, file_id)
1220
 
            nids.append((fn, file_id))
1221
 
            
1222
 
        # TODO: Rename back if it was previously at a different location
1223
 
 
1224
 
        # TODO: If given a directory, restore the entire contents from
1225
 
        # the previous version.
1226
 
 
1227
 
        # TODO: Make a backup to a temporary file.
1228
 
 
1229
 
        # TODO: If the file previously didn't exist, delete it?
1230
 
        for fn, file_id in nids:
1231
 
            backup_file(fn)
1232
 
            
1233
 
            f = AtomicFile(fn, 'wb')
1234
 
            try:
1235
 
                f.write(old_tree.get_file(file_id).read())
1236
 
                f.commit()
1237
 
            finally:
1238
 
                f.close()
1239
 
 
1240
 
 
1241
 
    def pending_merges(self):
1242
 
        """Return a list of pending merges.
1243
 
 
1244
 
        These are revisions that have been merged into the working
1245
 
        directory but not yet committed.
 
947
        TODO: Get state for single files.
1246
948
        """
1247
 
        cfn = self.controlfilename('pending-merges')
1248
 
        if not os.path.exists(cfn):
1249
 
            return []
1250
 
        p = []
1251
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1252
 
            p.append(l.rstrip('\n'))
1253
 
        return p
1254
 
 
1255
 
 
1256
 
    def add_pending_merge(self, revision_id):
1257
 
        from bzrlib.revision import validate_revision_id
1258
 
 
1259
 
        validate_revision_id(revision_id)
1260
 
 
1261
 
        p = self.pending_merges()
1262
 
        if revision_id in p:
1263
 
            return
1264
 
        p.append(revision_id)
1265
 
        self.set_pending_merges(p)
1266
 
 
1267
 
 
1268
 
    def set_pending_merges(self, rev_list):
1269
 
        from bzrlib.atomicfile import AtomicFile
1270
 
        self.lock_write()
1271
 
        try:
1272
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1273
 
            try:
1274
 
                for l in rev_list:
1275
 
                    print >>f, l
1276
 
                f.commit()
1277
 
            finally:
1278
 
                f.close()
1279
 
        finally:
1280
 
            self.unlock()
1281
 
 
 
949
        self._need_readlock()
 
950
 
 
951
        # We have to build everything into a list first so that it can
 
952
        # sorted by name, incorporating all the different sources.
 
953
 
 
954
        # FIXME: Rather than getting things in random order and then sorting,
 
955
        # just step through in order.
 
956
 
 
957
        # Interesting case: the old ID for a file has been removed,
 
958
        # but a new file has been created under that name.
 
959
 
 
960
        old = self.basis_tree()
 
961
        new = self.working_tree()
 
962
 
 
963
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
964
            if fs == 'R':
 
965
                show_status(fs, kind,
 
966
                            oldname + ' => ' + newname)
 
967
            elif fs == 'A' or fs == 'M':
 
968
                show_status(fs, kind, newname)
 
969
            elif fs == 'D':
 
970
                show_status(fs, kind, oldname)
 
971
            elif fs == '.':
 
972
                if show_all:
 
973
                    show_status(fs, kind, newname)
 
974
            elif fs == 'I':
 
975
                if show_all:
 
976
                    show_status(fs, kind, newname)
 
977
            elif fs == '?':
 
978
                show_status(fs, kind, newname)
 
979
            else:
 
980
                bailout("weird file state %r" % ((fs, fid),))
 
981
                
1282
982
 
1283
983
 
1284
984
class ScratchBranch(Branch):
1288
988
    >>> isdir(b.base)
1289
989
    True
1290
990
    >>> bd = b.base
1291
 
    >>> b.destroy()
 
991
    >>> del b
1292
992
    >>> isdir(bd)
1293
993
    False
1294
994
    """
1295
 
    def __init__(self, files=[], dirs=[], base=None):
 
995
    def __init__(self, files=[], dirs=[]):
1296
996
        """Make a test branch.
1297
997
 
1298
998
        This creates a temporary directory and runs init-tree in it.
1299
999
 
1300
1000
        If any files are listed, they are created in the working copy.
1301
1001
        """
1302
 
        from tempfile import mkdtemp
1303
 
        init = False
1304
 
        if base is None:
1305
 
            base = mkdtemp()
1306
 
            init = True
1307
 
        Branch.__init__(self, base, init=init)
 
1002
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1308
1003
        for d in dirs:
1309
1004
            os.mkdir(self.abspath(d))
1310
1005
            
1312
1007
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1313
1008
 
1314
1009
 
1315
 
    def clone(self):
1316
 
        """
1317
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1318
 
        >>> clone = orig.clone()
1319
 
        >>> os.path.samefile(orig.base, clone.base)
1320
 
        False
1321
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1322
 
        True
1323
 
        """
1324
 
        from shutil import copytree
1325
 
        from tempfile import mkdtemp
1326
 
        base = mkdtemp()
1327
 
        os.rmdir(base)
1328
 
        copytree(self.base, base, symlinks=True)
1329
 
        return ScratchBranch(base=base)
1330
 
        
1331
1010
    def __del__(self):
1332
 
        self.destroy()
1333
 
 
1334
 
    def destroy(self):
1335
1011
        """Destroy the test branch, removing the scratch directory."""
1336
 
        from shutil import rmtree
1337
1012
        try:
1338
 
            if self.base:
1339
 
                mutter("delete ScratchBranch %s" % self.base)
1340
 
                rmtree(self.base)
1341
 
        except OSError, e:
 
1013
            shutil.rmtree(self.base)
 
1014
        except OSError:
1342
1015
            # Work around for shutil.rmtree failing on Windows when
1343
1016
            # readonly files are encountered
1344
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
1345
1017
            for root, dirs, files in os.walk(self.base, topdown=False):
1346
1018
                for name in files:
1347
1019
                    os.chmod(os.path.join(root, name), 0700)
1348
 
            rmtree(self.base)
1349
 
        self.base = None
 
1020
            shutil.rmtree(self.base)
1350
1021
 
1351
1022
    
1352
1023
 
1369
1040
 
1370
1041
 
1371
1042
 
 
1043
def _gen_revision_id(when):
 
1044
    """Return new revision-id."""
 
1045
    s = '%s-%s-' % (user_email(), compact_date(when))
 
1046
    s += hexlify(rand_bytes(8))
 
1047
    return s
 
1048
 
 
1049
 
1372
1050
def gen_file_id(name):
1373
1051
    """Return new file id.
1374
1052
 
1375
1053
    This should probably generate proper UUIDs, but for the moment we
1376
1054
    cope with just randomness because running uuidgen every time is
1377
1055
    slow."""
1378
 
    import re
1379
 
    from binascii import hexlify
1380
 
    from time import time
1381
 
 
1382
 
    # get last component
1383
1056
    idx = name.rfind('/')
1384
1057
    if idx != -1:
1385
1058
        name = name[idx+1 : ]
1387
1060
    if idx != -1:
1388
1061
        name = name[idx+1 : ]
1389
1062
 
1390
 
    # make it not a hidden file
1391
1063
    name = name.lstrip('.')
1392
1064
 
1393
 
    # remove any wierd characters; we don't escape them but rather
1394
 
    # just pull them out
1395
 
    name = re.sub(r'[^\w.]', '', name)
1396
 
 
1397
1065
    s = hexlify(rand_bytes(8))
1398
 
    return '-'.join((name, compact_date(time()), s))
1399
 
 
1400
 
 
1401
 
def gen_root_id():
1402
 
    """Return a new tree-root file id."""
1403
 
    return gen_file_id('TREE_ROOT')
1404
 
 
1405
 
 
1406
 
def pull_loc(branch):
1407
 
    # TODO: Should perhaps just make attribute be 'base' in
1408
 
    # RemoteBranch and Branch?
1409
 
    if hasattr(branch, "baseurl"):
1410
 
        return branch.baseurl
1411
 
    else:
1412
 
        return branch.base
1413
 
 
1414
 
 
1415
 
def copy_branch(branch_from, to_location, revision=None):
1416
 
    """Copy branch_from into the existing directory to_location.
1417
 
 
1418
 
    If revision is not None, the head of the new branch will be revision.
1419
 
    """
1420
 
    from bzrlib.merge import merge
1421
 
    from bzrlib.branch import Branch
1422
 
    br_to = Branch(to_location, init=True)
1423
 
    br_to.set_root_id(branch_from.get_root_id())
1424
 
    if revision is None:
1425
 
        revno = branch_from.revno()
1426
 
    else:
1427
 
        revno, rev_id = branch_from.get_revision_info(revision)
1428
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1429
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1430
 
          check_clean=False, ignore_zero=True)
1431
 
    from_location = pull_loc(branch_from)
1432
 
    br_to.controlfile("x-pull", "wb").write(from_location + "\n")
1433
 
 
 
1066
    return '-'.join((name, compact_date(time.time()), s))