← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

add a clean target

Show diffs side-by-side

added added

removed removed

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