← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-09-13 23:42:32 UTC
  • mto: (1185.8.2) (974.1.91)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: mbp@sourcefrog.net-20050913234232-4d901f2d843a35f3
- ignore .DS_Store by default

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
import bzrlib.errors
 
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
        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
        
42
102
 
43
103
def find_branch_root(f=None):
44
104
    """Find the branch root enclosing f, or pwd.
45
105
 
 
106
    f may be a filename or a URL.
 
107
 
46
108
    It is not necessary that f exists.
47
109
 
48
110
    Basically we keep looking up until we find the control directory or
49
 
    run into the root."""
 
111
    run into the root.  If there isn't one, raises NotBranchError.
 
112
    """
50
113
    if f == None:
51
114
        f = os.getcwd()
52
115
    elif hasattr(os.path, 'realpath'):
53
116
        f = os.path.realpath(f)
54
117
    else:
55
118
        f = os.path.abspath(f)
 
119
    if not os.path.exists(f):
 
120
        raise BzrError('%r does not exist' % f)
 
121
        
56
122
 
57
123
    orig_f = f
58
124
 
62
128
        head, tail = os.path.split(f)
63
129
        if head == f:
64
130
            # reached the root, whatever that may be
65
 
            raise BzrError('%r is not in a branch' % orig_f)
 
131
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
66
132
        f = head
67
 
    
 
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.")
68
142
 
69
143
 
70
144
######################################################################
71
145
# branch objects
72
146
 
73
 
class Branch:
 
147
class Branch(object):
74
148
    """Branch holding a history of revisions.
75
149
 
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.
 
150
    base
 
151
        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.
88
162
    """
 
163
    base = None
 
164
    _lock_mode = None
 
165
    _lock_count = None
 
166
    _lock = None
 
167
    
 
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
 
89
173
    def __init__(self, base, init=False, find_root=True):
90
174
        """Create new branch object at a particular location.
91
175
 
101
185
        In the test suite, creation of new trees is tested using the
102
186
        `ScratchBranch` class.
103
187
        """
 
188
        from bzrlib.store import ImmutableStore
104
189
        if init:
105
190
            self.base = os.path.realpath(base)
106
191
            self._make_control()
109
194
        else:
110
195
            self.base = os.path.realpath(base)
111
196
            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'])
 
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'])
115
201
        self._check_format()
116
202
 
117
203
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
126
212
    __repr__ = __str__
127
213
 
128
214
 
 
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
 
260
 
129
261
    def abspath(self, name):
130
262
        """Return absolute filename for something in the branch"""
131
263
        return os.path.join(self.base, name)
132
264
 
133
 
 
134
265
    def relpath(self, path):
135
266
        """Return path relative to this branch of something inside it.
136
267
 
137
268
        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
 
 
 
269
        return _relpath(self.base, path)
146
270
 
147
271
    def controlfilename(self, file_or_path):
148
272
        """Return location relative to branch."""
149
 
        if isinstance(file_or_path, types.StringTypes):
 
273
        if isinstance(file_or_path, basestring):
150
274
            file_or_path = [file_or_path]
151
275
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
152
276
 
158
282
        and binary.  binary files are untranslated byte streams.  Text
159
283
        control files are stored with Unix newlines and in UTF-8, even
160
284
        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.
161
288
        """
162
289
 
163
290
        fn = self.controlfilename(file_or_path)
173
300
        else:
174
301
            raise BzrError("invalid controlfile mode %r" % mode)
175
302
 
176
 
 
177
 
 
178
303
    def _make_control(self):
 
304
        from bzrlib.inventory import Inventory
 
305
        
179
306
        os.mkdir(self.controlfilename([]))
180
307
        self.controlfile('README', 'w').write(
181
308
            "This is a Bazaar-NG control directory.\n"
182
 
            "Do not change any files in this directory.")
 
309
            "Do not change any files in this directory.\n")
183
310
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
184
311
        for d in ('text-store', 'inventory-store', 'revision-store'):
185
312
            os.mkdir(self.controlfilename(d))
186
313
        for f in ('revision-history', 'merged-patches',
187
 
                  'pending-merged-patches', 'branch-name'):
 
314
                  'pending-merged-patches', 'branch-name',
 
315
                  'branch-lock',
 
316
                  'pending-merges'):
188
317
            self.controlfile(f, 'w').write('')
189
318
        mutter('created control directory in ' + self.base)
190
 
        Inventory().write_xml(self.controlfile('inventory','w'))
 
319
 
 
320
        # if we want per-tree root ids then this is the place to set
 
321
        # them; they're not needed for now and so ommitted for
 
322
        # simplicity.
 
323
        f = self.controlfile('inventory','w')
 
324
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
191
325
 
192
326
 
193
327
    def _check_format(self):
202
336
        # on Windows from Linux and so on.  I think it might be better
203
337
        # to always make all internal files in unix format.
204
338
        fmt = self.controlfile('branch-format', 'r').read()
205
 
        fmt.replace('\r\n', '')
 
339
        fmt = fmt.replace('\r\n', '\n')
206
340
        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
 
 
 
341
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
342
                           ['use a different bzr version',
 
343
                            'or remove the .bzr directory and "bzr init" again'])
 
344
 
 
345
    def get_root_id(self):
 
346
        """Return the id of this branches root"""
 
347
        inv = self.read_working_inventory()
 
348
        return inv.root.file_id
 
349
 
 
350
    def set_root_id(self, file_id):
 
351
        inv = self.read_working_inventory()
 
352
        orig_root_id = inv.root.file_id
 
353
        del inv._byid[inv.root.file_id]
 
354
        inv.root.file_id = file_id
 
355
        inv._byid[inv.root.file_id] = inv.root
 
356
        for fid in inv:
 
357
            entry = inv[fid]
 
358
            if entry.parent_id in (None, orig_root_id):
 
359
                entry.parent_id = inv.root.file_id
 
360
        self._write_inventory(inv)
211
361
 
212
362
    def read_working_inventory(self):
213
363
        """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
 
 
 
364
        from bzrlib.inventory import Inventory
 
365
        self.lock_read()
 
366
        try:
 
367
            # ElementTree does its own conversion from UTF-8, so open in
 
368
            # binary.
 
369
            f = self.controlfile('inventory', 'rb')
 
370
            return bzrlib.xml.serializer_v4.read_inventory(f)
 
371
        finally:
 
372
            self.unlock()
 
373
            
222
374
 
223
375
    def _write_inventory(self, inv):
224
376
        """Update the working inventory.
226
378
        That is to say, the inventory describing changes underway, that
227
379
        will be committed to the next revision.
228
380
        """
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)
 
381
        from bzrlib.atomicfile import AtomicFile
 
382
        
 
383
        self.lock_write()
 
384
        try:
 
385
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
386
            try:
 
387
                bzrlib.xml.serializer_v4.write_inventory(inv, f)
 
388
                f.commit()
 
389
            finally:
 
390
                f.close()
 
391
        finally:
 
392
            self.unlock()
 
393
        
239
394
        mutter('wrote working inventory')
240
 
 
 
395
            
241
396
 
242
397
    inventory = property(read_working_inventory, _write_inventory, None,
243
398
                         """Inventory for the working copy.""")
244
399
 
245
400
 
246
 
    def add(self, files, verbose=False):
 
401
    def add(self, files, ids=None):
247
402
        """Make files versioned.
248
403
 
249
 
        Note that the command line normally calls smart_add instead.
 
404
        Note that the command line normally calls smart_add instead,
 
405
        which can automatically recurse.
250
406
 
251
407
        This puts the files in the Added state, so that they will be
252
408
        recorded by the next commit.
253
409
 
 
410
        files
 
411
            List of paths to add, relative to the base of the tree.
 
412
 
 
413
        ids
 
414
            If set, use these instead of automatically generated ids.
 
415
            Must be the same length as the list of files, but may
 
416
            contain None for ids that are to be autogenerated.
 
417
 
254
418
        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', [])
 
419
              not (yet) exist.
 
420
 
 
421
        TODO: Perhaps yield the ids and paths as they're added.
287
422
        """
288
 
 
289
423
        # TODO: Re-adding a file that is removed in the working copy
290
424
        # should probably put it back with the previous ID.
291
 
        if isinstance(files, types.StringTypes):
 
425
        if isinstance(files, basestring):
 
426
            assert(ids is None or isinstance(ids, basestring))
292
427
            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
 
 
 
428
            if ids is not None:
 
429
                ids = [ids]
 
430
 
 
431
        if ids is None:
 
432
            ids = [None] * len(files)
 
433
        else:
 
434
            assert(len(ids) == len(files))
 
435
 
 
436
        self.lock_write()
 
437
        try:
 
438
            inv = self.read_working_inventory()
 
439
            for f,file_id in zip(files, ids):
 
440
                if is_control_file(f):
 
441
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
442
 
 
443
                fp = splitpath(f)
 
444
 
 
445
                if len(fp) == 0:
 
446
                    raise BzrError("cannot add top-level %r" % f)
 
447
 
 
448
                fullpath = os.path.normpath(self.abspath(f))
 
449
 
 
450
                try:
 
451
                    kind = file_kind(fullpath)
 
452
                except OSError:
 
453
                    # maybe something better?
 
454
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
455
 
 
456
                if kind != 'file' and kind != 'directory':
 
457
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
458
 
 
459
                if file_id is None:
 
460
                    file_id = gen_file_id(f)
 
461
                inv.add_path(f, kind=kind, file_id=file_id)
 
462
 
 
463
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
464
 
 
465
            self._write_inventory(inv)
 
466
        finally:
 
467
            self.unlock()
 
468
            
325
469
 
326
470
    def print_file(self, file, revno):
327
471
        """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
 
        
 
472
        self.lock_read()
 
473
        try:
 
474
            tree = self.revision_tree(self.lookup_revision(revno))
 
475
            # use inventory as it was in that revision
 
476
            file_id = tree.inventory.path2id(file)
 
477
            if not file_id:
 
478
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
479
            tree.print_file(file_id)
 
480
        finally:
 
481
            self.unlock()
 
482
 
335
483
 
336
484
    def remove(self, files, verbose=False):
337
485
        """Mark nominated files for removal from the inventory.
340
488
 
341
489
        TODO: Refuse to remove modified files unless --force is given?
342
490
 
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
491
        TODO: Do something useful with directories.
366
492
 
367
493
        TODO: Should this remove the text or not?  Tough call; not
371
497
        """
372
498
        ## TODO: Normalize names
373
499
        ## TODO: Remove nested loops; better scalability
374
 
 
375
 
        if isinstance(files, types.StringTypes):
 
500
        if isinstance(files, basestring):
376
501
            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
 
 
 
502
 
 
503
        self.lock_write()
 
504
 
 
505
        try:
 
506
            tree = self.working_tree()
 
507
            inv = tree.inventory
 
508
 
 
509
            # do this before any modifications
 
510
            for f in files:
 
511
                fid = inv.path2id(f)
 
512
                if not fid:
 
513
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
514
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
515
                if verbose:
 
516
                    # having remove it, it must be either ignored or unknown
 
517
                    if tree.is_ignored(f):
 
518
                        new_status = 'I'
 
519
                    else:
 
520
                        new_status = '?'
 
521
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
522
                del inv[fid]
 
523
 
 
524
            self._write_inventory(inv)
 
525
        finally:
 
526
            self.unlock()
 
527
 
 
528
 
 
529
    # FIXME: this doesn't need to be a branch method
 
530
    def set_inventory(self, new_inventory_list):
 
531
        from bzrlib.inventory import Inventory, InventoryEntry
 
532
        inv = Inventory(self.get_root_id())
 
533
        for path, file_id, parent, kind in new_inventory_list:
 
534
            name = os.path.basename(path)
 
535
            if name == "":
 
536
                continue
 
537
            inv.add(InventoryEntry(file_id, name, kind, parent))
396
538
        self._write_inventory(inv)
397
539
 
398
540
 
415
557
        return self.working_tree().unknowns()
416
558
 
417
559
 
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)
 
560
    def append_revision(self, *revision_ids):
 
561
        from bzrlib.atomicfile import AtomicFile
 
562
 
 
563
        for revision_id in revision_ids:
 
564
            mutter("add {%s} to revision-history" % revision_id)
 
565
 
590
566
        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
 
        
 
567
        rev_history.extend(revision_ids)
 
568
 
 
569
        f = AtomicFile(self.controlfilename('revision-history'))
 
570
        try:
 
571
            for rev_id in rev_history:
 
572
                print >>f, rev_id
 
573
            f.commit()
 
574
        finally:
 
575
            f.close()
 
576
 
 
577
 
 
578
    def get_revision_xml_file(self, revision_id):
 
579
        """Return XML file object for revision object."""
 
580
        if not revision_id or not isinstance(revision_id, basestring):
 
581
            raise InvalidRevisionId(revision_id)
 
582
 
 
583
        self.lock_read()
 
584
        try:
 
585
            try:
 
586
                return self.revision_store[revision_id]
 
587
            except KeyError:
 
588
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
589
        finally:
 
590
            self.unlock()
 
591
 
 
592
 
 
593
    #deprecated
 
594
    get_revision_xml = get_revision_xml_file
605
595
 
606
596
 
607
597
    def get_revision(self, revision_id):
608
598
        """Return the Revision object for a named revision"""
609
 
        r = Revision.read_xml(self.revision_store[revision_id])
 
599
        xml_file = self.get_revision_xml_file(revision_id)
 
600
 
 
601
        try:
 
602
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
 
603
        except SyntaxError, e:
 
604
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
605
                                         [revision_id,
 
606
                                          str(e)])
 
607
            
610
608
        assert r.revision_id == revision_id
611
609
        return r
612
610
 
613
611
 
 
612
    def get_revision_delta(self, revno):
 
613
        """Return the delta for one revision.
 
614
 
 
615
        The delta is relative to its mainline predecessor, or the
 
616
        empty tree for revision 1.
 
617
        """
 
618
        assert isinstance(revno, int)
 
619
        rh = self.revision_history()
 
620
        if not (1 <= revno <= len(rh)):
 
621
            raise InvalidRevisionNumber(revno)
 
622
 
 
623
        # revno is 1-based; list is 0-based
 
624
 
 
625
        new_tree = self.revision_tree(rh[revno-1])
 
626
        if revno == 1:
 
627
            old_tree = EmptyTree()
 
628
        else:
 
629
            old_tree = self.revision_tree(rh[revno-2])
 
630
 
 
631
        return compare_trees(old_tree, new_tree)
 
632
 
 
633
        
 
634
 
 
635
    def get_revision_sha1(self, revision_id):
 
636
        """Hash the stored value of a revision, and return it."""
 
637
        # In the future, revision entries will be signed. At that
 
638
        # point, it is probably best *not* to include the signature
 
639
        # in the revision hash. Because that lets you re-sign
 
640
        # the revision, (add signatures/remove signatures) and still
 
641
        # have all hash pointers stay consistent.
 
642
        # But for now, just hash the contents.
 
643
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
 
644
 
 
645
 
614
646
    def get_inventory(self, inventory_id):
615
647
        """Get Inventory object by hash.
616
648
 
617
649
        TODO: Perhaps for this and similar methods, take a revision
618
650
               parameter which can be either an integer revno or a
619
651
               string hash."""
620
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
621
 
        return i
 
652
        from bzrlib.inventory import Inventory
 
653
 
 
654
        f = self.get_inventory_xml_file(inventory_id)
 
655
        return bzrlib.xml.serializer_v4.read_inventory(f)
 
656
 
 
657
 
 
658
    def get_inventory_xml(self, inventory_id):
 
659
        """Get inventory XML as a file object."""
 
660
        return self.inventory_store[inventory_id]
 
661
 
 
662
    get_inventory_xml_file = get_inventory_xml
 
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))
622
669
 
623
670
 
624
671
    def get_revision_inventory(self, revision_id):
625
672
        """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.
626
675
        if revision_id == None:
627
 
            return Inventory()
 
676
            from bzrlib.inventory import Inventory
 
677
            return Inventory(self.get_root_id())
628
678
        else:
629
 
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
679
            return self.get_inventory(revision_id)
630
680
 
631
681
 
632
682
    def revision_history(self):
635
685
        >>> ScratchBranch().revision_history()
636
686
        []
637
687
        """
638
 
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
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
639
739
 
640
740
 
641
741
    def revno(self):
643
743
 
644
744
        That is equivalent to the number of revisions committed to
645
745
        this branch.
646
 
 
647
 
        >>> b = ScratchBranch()
648
 
        >>> b.revno()
649
 
        0
650
 
        >>> b.commit('no foo')
651
 
        >>> b.revno()
652
 
        1
653
746
        """
654
747
        return len(self.revision_history())
655
748
 
656
749
 
657
750
    def last_patch(self):
658
751
        """Return last patch hash, or None if no history.
659
 
 
660
 
        >>> ScratchBranch().last_patch() == None
661
 
        True
662
752
        """
663
753
        ph = self.revision_history()
664
754
        if ph:
665
755
            return ph[-1]
666
756
        else:
667
757
            return None
668
 
        
669
 
 
670
 
    def lookup_revision(self, revno):
671
 
        """Return revision hash for revision number."""
 
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
        from bzrlib.revision import get_intervening_revisions
 
809
 
 
810
        pb = bzrlib.ui.ui_factory.progress_bar()
 
811
        pb.update('comparing histories')
 
812
 
 
813
        try:
 
814
            revision_ids = self.missing_revisions(other, stop_revision)
 
815
        except DivergedBranches, e:
 
816
            try:
 
817
                if stop_revision is None:
 
818
                    end_revision = other.last_patch()
 
819
                revision_ids = get_intervening_revisions(self.last_patch(), 
 
820
                                                         end_revision, other)
 
821
                assert self.last_patch() not in revision_ids
 
822
            except bzrlib.errors.NotAncestor:
 
823
                raise e
 
824
 
 
825
        if len(revision_ids) > 0:
 
826
            count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
 
827
        else:
 
828
            count = 0
 
829
        self.append_revision(*revision_ids)
 
830
        ## note("Added %d revisions." % count)
 
831
        pb.clear()
 
832
 
 
833
    def install_revisions(self, other, revision_ids, pb):
 
834
        if hasattr(other.revision_store, "prefetch"):
 
835
            other.revision_store.prefetch(revision_ids)
 
836
        if hasattr(other.inventory_store, "prefetch"):
 
837
            inventory_ids = []
 
838
            for rev_id in revision_ids:
 
839
                try:
 
840
                    revision = other.get_revision(rev_id).inventory_id
 
841
                    inventory_ids.append(revision)
 
842
                except bzrlib.errors.NoSuchRevision:
 
843
                    pass
 
844
            other.inventory_store.prefetch(inventory_ids)
 
845
 
 
846
        if pb is None:
 
847
            pb = bzrlib.ui.ui_factory.progress_bar()
 
848
                
 
849
        revisions = []
 
850
        needed_texts = set()
 
851
        i = 0
 
852
 
 
853
        failures = set()
 
854
        for i, rev_id in enumerate(revision_ids):
 
855
            pb.update('fetching revision', i+1, len(revision_ids))
 
856
            try:
 
857
                rev = other.get_revision(rev_id)
 
858
            except bzrlib.errors.NoSuchRevision:
 
859
                failures.add(rev_id)
 
860
                continue
 
861
 
 
862
            revisions.append(rev)
 
863
            inv = other.get_inventory(str(rev.inventory_id))
 
864
            for key, entry in inv.iter_entries():
 
865
                if entry.text_id is None:
 
866
                    continue
 
867
                if entry.text_id not in self.text_store:
 
868
                    needed_texts.add(entry.text_id)
 
869
 
 
870
        pb.clear()
 
871
                    
 
872
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
 
873
                                                    needed_texts)
 
874
        #print "Added %d texts." % count 
 
875
        inventory_ids = [ f.inventory_id for f in revisions ]
 
876
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
 
877
                                                         inventory_ids)
 
878
        #print "Added %d inventories." % count 
 
879
        revision_ids = [ f.revision_id for f in revisions]
 
880
 
 
881
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
 
882
                                                          revision_ids,
 
883
                                                          permit_failure=True)
 
884
        assert len(cp_fail) == 0 
 
885
        return count, failures
 
886
       
 
887
 
 
888
    def commit(self, *args, **kw):
 
889
        from bzrlib.commit import commit
 
890
        commit(self, *args, **kw)
 
891
        
 
892
 
 
893
    def lookup_revision(self, revision):
 
894
        """Return the revision identifier for a given revision information."""
 
895
        revno, info = self._get_revision_info(revision)
 
896
        return info
 
897
 
 
898
 
 
899
    def revision_id_to_revno(self, revision_id):
 
900
        """Given a revision id, return its revno"""
 
901
        history = self.revision_history()
 
902
        try:
 
903
            return history.index(revision_id) + 1
 
904
        except ValueError:
 
905
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
906
 
 
907
 
 
908
    def get_revision_info(self, revision):
 
909
        """Return (revno, revision id) for revision identifier.
 
910
 
 
911
        revision can be an integer, in which case it is assumed to be revno (though
 
912
            this will translate negative values into positive ones)
 
913
        revision can also be a string, in which case it is parsed for something like
 
914
            'date:' or 'revid:' etc.
 
915
        """
 
916
        revno, rev_id = self._get_revision_info(revision)
 
917
        if revno is None:
 
918
            raise bzrlib.errors.NoSuchRevision(self, revision)
 
919
        return revno, rev_id
 
920
 
 
921
    def get_rev_id(self, revno, history=None):
 
922
        """Find the revision id of the specified revno."""
672
923
        if revno == 0:
673
924
            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
 
 
 
925
        if history is None:
 
926
            history = self.revision_history()
 
927
        elif revno <= 0 or revno > len(history):
 
928
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
929
        return history[revno - 1]
 
930
 
 
931
    def _get_revision_info(self, revision):
 
932
        """Return (revno, revision id) for revision specifier.
 
933
 
 
934
        revision can be an integer, in which case it is assumed to be revno
 
935
        (though this will translate negative values into positive ones)
 
936
        revision can also be a string, in which case it is parsed for something
 
937
        like 'date:' or 'revid:' etc.
 
938
 
 
939
        A revid is always returned.  If it is None, the specifier referred to
 
940
        the null revision.  If the revid does not occur in the revision
 
941
        history, revno will be None.
 
942
        """
 
943
        
 
944
        if revision is None:
 
945
            return 0, None
 
946
        revno = None
 
947
        try:# Convert to int if possible
 
948
            revision = int(revision)
 
949
        except ValueError:
 
950
            pass
 
951
        revs = self.revision_history()
 
952
        if isinstance(revision, int):
 
953
            if revision < 0:
 
954
                revno = len(revs) + revision + 1
 
955
            else:
 
956
                revno = revision
 
957
            rev_id = self.get_rev_id(revno, revs)
 
958
        elif isinstance(revision, basestring):
 
959
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
960
                if revision.startswith(prefix):
 
961
                    result = func(self, revs, revision)
 
962
                    if len(result) > 1:
 
963
                        revno, rev_id = result
 
964
                    else:
 
965
                        revno = result[0]
 
966
                        rev_id = self.get_rev_id(revno, revs)
 
967
                    break
 
968
            else:
 
969
                raise BzrError('No namespace registered for string: %r' %
 
970
                               revision)
 
971
        else:
 
972
            raise TypeError('Unhandled revision type %s' % revision)
 
973
 
 
974
        if revno is None:
 
975
            if rev_id is None:
 
976
                raise bzrlib.errors.NoSuchRevision(self, revision)
 
977
        return revno, rev_id
 
978
 
 
979
    def _namespace_revno(self, revs, revision):
 
980
        """Lookup a revision by revision number"""
 
981
        assert revision.startswith('revno:')
 
982
        try:
 
983
            return (int(revision[6:]),)
 
984
        except ValueError:
 
985
            return None
 
986
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
987
 
 
988
    def _namespace_revid(self, revs, revision):
 
989
        assert revision.startswith('revid:')
 
990
        rev_id = revision[len('revid:'):]
 
991
        try:
 
992
            return revs.index(rev_id) + 1, rev_id
 
993
        except ValueError:
 
994
            return None, rev_id
 
995
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
996
 
 
997
    def _namespace_last(self, revs, revision):
 
998
        assert revision.startswith('last:')
 
999
        try:
 
1000
            offset = int(revision[5:])
 
1001
        except ValueError:
 
1002
            return (None,)
 
1003
        else:
 
1004
            if offset <= 0:
 
1005
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
1006
            return (len(revs) - offset + 1,)
 
1007
    REVISION_NAMESPACES['last:'] = _namespace_last
 
1008
 
 
1009
    def _namespace_tag(self, revs, revision):
 
1010
        assert revision.startswith('tag:')
 
1011
        raise BzrError('tag: namespace registered, but not implemented.')
 
1012
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
1013
 
 
1014
    def _namespace_date(self, revs, revision):
 
1015
        assert revision.startswith('date:')
 
1016
        import datetime
 
1017
        # Spec for date revisions:
 
1018
        #   date:value
 
1019
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
1020
        #   it can also start with a '+/-/='. '+' says match the first
 
1021
        #   entry after the given date. '-' is match the first entry before the date
 
1022
        #   '=' is match the first entry after, but still on the given date.
 
1023
        #
 
1024
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
1025
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
1026
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
1027
        #       May 13th, 2005 at 0:00
 
1028
        #
 
1029
        #   So the proper way of saying 'give me all entries for today' is:
 
1030
        #       -r {date:+today}:{date:-tomorrow}
 
1031
        #   The default is '=' when not supplied
 
1032
        val = revision[5:]
 
1033
        match_style = '='
 
1034
        if val[:1] in ('+', '-', '='):
 
1035
            match_style = val[:1]
 
1036
            val = val[1:]
 
1037
 
 
1038
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
1039
        if val.lower() == 'yesterday':
 
1040
            dt = today - datetime.timedelta(days=1)
 
1041
        elif val.lower() == 'today':
 
1042
            dt = today
 
1043
        elif val.lower() == 'tomorrow':
 
1044
            dt = today + datetime.timedelta(days=1)
 
1045
        else:
 
1046
            import re
 
1047
            # This should be done outside the function to avoid recompiling it.
 
1048
            _date_re = re.compile(
 
1049
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
1050
                    r'(,|T)?\s*'
 
1051
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
1052
                )
 
1053
            m = _date_re.match(val)
 
1054
            if not m or (not m.group('date') and not m.group('time')):
 
1055
                raise BzrError('Invalid revision date %r' % revision)
 
1056
 
 
1057
            if m.group('date'):
 
1058
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
1059
            else:
 
1060
                year, month, day = today.year, today.month, today.day
 
1061
            if m.group('time'):
 
1062
                hour = int(m.group('hour'))
 
1063
                minute = int(m.group('minute'))
 
1064
                if m.group('second'):
 
1065
                    second = int(m.group('second'))
 
1066
                else:
 
1067
                    second = 0
 
1068
            else:
 
1069
                hour, minute, second = 0,0,0
 
1070
 
 
1071
            dt = datetime.datetime(year=year, month=month, day=day,
 
1072
                    hour=hour, minute=minute, second=second)
 
1073
        first = dt
 
1074
        last = None
 
1075
        reversed = False
 
1076
        if match_style == '-':
 
1077
            reversed = True
 
1078
        elif match_style == '=':
 
1079
            last = dt + datetime.timedelta(days=1)
 
1080
 
 
1081
        if reversed:
 
1082
            for i in range(len(revs)-1, -1, -1):
 
1083
                r = self.get_revision(revs[i])
 
1084
                # TODO: Handle timezone.
 
1085
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1086
                if first >= dt and (last is None or dt >= last):
 
1087
                    return (i+1,)
 
1088
        else:
 
1089
            for i in range(len(revs)):
 
1090
                r = self.get_revision(revs[i])
 
1091
                # TODO: Handle timezone.
 
1092
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
1093
                if first <= dt and (last is None or dt <= last):
 
1094
                    return (i+1,)
 
1095
    REVISION_NAMESPACES['date:'] = _namespace_date
681
1096
 
682
1097
    def revision_tree(self, revision_id):
683
1098
        """Return Tree for a revision on this branch.
684
1099
 
685
1100
        `revision_id` may be None for the null revision, in which case
686
1101
        an `EmptyTree` is returned."""
687
 
 
 
1102
        # TODO: refactor this to use an existing revision object
 
1103
        # so we don't need to read it in twice.
688
1104
        if revision_id == None:
689
1105
            return EmptyTree()
690
1106
        else:
694
1110
 
695
1111
    def working_tree(self):
696
1112
        """Return a `Tree` for the working copy."""
 
1113
        from workingtree import WorkingTree
697
1114
        return WorkingTree(self.base, self.read_working_inventory())
698
1115
 
699
1116
 
701
1118
        """Return `Tree` object for last revision.
702
1119
 
703
1120
        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
1121
        """
715
1122
        r = self.last_patch()
716
1123
        if r == None:
720
1127
 
721
1128
 
722
1129
 
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
1130
    def rename_one(self, from_rel, to_rel):
771
1131
        """Rename one file.
772
1132
 
773
1133
        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)
 
1134
        """
 
1135
        self.lock_write()
807
1136
        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
 
            
 
1137
            tree = self.working_tree()
 
1138
            inv = tree.inventory
 
1139
            if not tree.has_filename(from_rel):
 
1140
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1141
            if tree.has_filename(to_rel):
 
1142
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1143
 
 
1144
            file_id = inv.path2id(from_rel)
 
1145
            if file_id == None:
 
1146
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1147
 
 
1148
            if inv.path2id(to_rel):
 
1149
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1150
 
 
1151
            to_dir, to_tail = os.path.split(to_rel)
 
1152
            to_dir_id = inv.path2id(to_dir)
 
1153
            if to_dir_id == None and to_dir != '':
 
1154
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1155
 
 
1156
            mutter("rename_one:")
 
1157
            mutter("  file_id    {%s}" % file_id)
 
1158
            mutter("  from_rel   %r" % from_rel)
 
1159
            mutter("  to_rel     %r" % to_rel)
 
1160
            mutter("  to_dir     %r" % to_dir)
 
1161
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1162
 
 
1163
            inv.rename(file_id, to_dir_id, to_tail)
 
1164
 
 
1165
            from_abs = self.abspath(from_rel)
 
1166
            to_abs = self.abspath(to_rel)
 
1167
            try:
 
1168
                os.rename(from_abs, to_abs)
 
1169
            except OSError, e:
 
1170
                raise BzrError("failed to rename %r to %r: %s"
 
1171
                        % (from_abs, to_abs, e[1]),
 
1172
                        ["rename rolled back"])
 
1173
 
 
1174
            self._write_inventory(inv)
 
1175
        finally:
 
1176
            self.unlock()
816
1177
 
817
1178
 
818
1179
    def move(self, from_paths, to_name):
825
1186
 
826
1187
        Note that to_name is only the last component of the new name;
827
1188
        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
 
                
 
1189
 
 
1190
        This returns a list of (from_path, to_path) pairs for each
 
1191
        entry that is moved.
 
1192
        """
 
1193
        result = []
 
1194
        self.lock_write()
 
1195
        try:
 
1196
            ## TODO: Option to move IDs only
 
1197
            assert not isinstance(from_paths, basestring)
 
1198
            tree = self.working_tree()
 
1199
            inv = tree.inventory
 
1200
            to_abs = self.abspath(to_name)
 
1201
            if not isdir(to_abs):
 
1202
                raise BzrError("destination %r is not a directory" % to_abs)
 
1203
            if not tree.has_filename(to_name):
 
1204
                raise BzrError("destination %r not in working directory" % to_abs)
 
1205
            to_dir_id = inv.path2id(to_name)
 
1206
            if to_dir_id == None and to_name != '':
 
1207
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1208
            to_dir_ie = inv[to_dir_id]
 
1209
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1210
                raise BzrError("destination %r is not a directory" % to_abs)
 
1211
 
 
1212
            to_idpath = inv.get_idpath(to_dir_id)
 
1213
 
 
1214
            for f in from_paths:
 
1215
                if not tree.has_filename(f):
 
1216
                    raise BzrError("%r does not exist in working tree" % f)
 
1217
                f_id = inv.path2id(f)
 
1218
                if f_id == None:
 
1219
                    raise BzrError("%r is not versioned" % f)
 
1220
                name_tail = splitpath(f)[-1]
 
1221
                dest_path = appendpath(to_name, name_tail)
 
1222
                if tree.has_filename(dest_path):
 
1223
                    raise BzrError("destination %r already exists" % dest_path)
 
1224
                if f_id in to_idpath:
 
1225
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1226
 
 
1227
            # OK, so there's a race here, it's possible that someone will
 
1228
            # create a file in this interval and then the rename might be
 
1229
            # left half-done.  But we should have caught most problems.
 
1230
 
 
1231
            for f in from_paths:
 
1232
                name_tail = splitpath(f)[-1]
 
1233
                dest_path = appendpath(to_name, name_tail)
 
1234
                result.append((f, dest_path))
 
1235
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1236
                try:
 
1237
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1238
                except OSError, e:
 
1239
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1240
                            ["rename rolled back"])
 
1241
 
 
1242
            self._write_inventory(inv)
 
1243
        finally:
 
1244
            self.unlock()
 
1245
 
 
1246
        return result
 
1247
 
 
1248
 
 
1249
    def revert(self, filenames, old_tree=None, backups=True):
 
1250
        """Restore selected files to the versions from a previous tree.
 
1251
 
 
1252
        backups
 
1253
            If true (default) backups are made of files before
 
1254
            they're renamed.
 
1255
        """
 
1256
        from bzrlib.errors import NotVersionedError, BzrError
 
1257
        from bzrlib.atomicfile import AtomicFile
 
1258
        from bzrlib.osutils import backup_file
 
1259
        
 
1260
        inv = self.read_working_inventory()
 
1261
        if old_tree is None:
 
1262
            old_tree = self.basis_tree()
 
1263
        old_inv = old_tree.inventory
 
1264
 
 
1265
        nids = []
 
1266
        for fn in filenames:
 
1267
            file_id = inv.path2id(fn)
 
1268
            if not file_id:
 
1269
                raise NotVersionedError("not a versioned file", fn)
 
1270
            if not old_inv.has_id(file_id):
 
1271
                raise BzrError("file not present in old tree", fn, file_id)
 
1272
            nids.append((fn, file_id))
 
1273
            
 
1274
        # TODO: Rename back if it was previously at a different location
 
1275
 
 
1276
        # TODO: If given a directory, restore the entire contents from
 
1277
        # the previous version.
 
1278
 
 
1279
        # TODO: Make a backup to a temporary file.
 
1280
 
 
1281
        # TODO: If the file previously didn't exist, delete it?
 
1282
        for fn, file_id in nids:
 
1283
            backup_file(fn)
 
1284
            
 
1285
            f = AtomicFile(fn, 'wb')
 
1286
            try:
 
1287
                f.write(old_tree.get_file(file_id).read())
 
1288
                f.commit()
 
1289
            finally:
 
1290
                f.close()
 
1291
 
 
1292
 
 
1293
    def pending_merges(self):
 
1294
        """Return a list of pending merges.
 
1295
 
 
1296
        These are revisions that have been merged into the working
 
1297
        directory but not yet committed.
 
1298
        """
 
1299
        cfn = self.controlfilename('pending-merges')
 
1300
        if not os.path.exists(cfn):
 
1301
            return []
 
1302
        p = []
 
1303
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1304
            p.append(l.rstrip('\n'))
 
1305
        return p
 
1306
 
 
1307
 
 
1308
    def add_pending_merge(self, revision_id):
 
1309
        from bzrlib.revision import validate_revision_id
 
1310
 
 
1311
        validate_revision_id(revision_id)
 
1312
 
 
1313
        p = self.pending_merges()
 
1314
        if revision_id in p:
 
1315
            return
 
1316
        p.append(revision_id)
 
1317
        self.set_pending_merges(p)
 
1318
 
 
1319
 
 
1320
    def set_pending_merges(self, rev_list):
 
1321
        from bzrlib.atomicfile import AtomicFile
 
1322
        self.lock_write()
 
1323
        try:
 
1324
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1325
            try:
 
1326
                for l in rev_list:
 
1327
                    print >>f, l
 
1328
                f.commit()
 
1329
            finally:
 
1330
                f.close()
 
1331
        finally:
 
1332
            self.unlock()
 
1333
 
 
1334
 
 
1335
    def get_parent(self):
 
1336
        """Return the parent location of the branch.
 
1337
 
 
1338
        This is the default location for push/pull/missing.  The usual
 
1339
        pattern is that the user can override it by specifying a
 
1340
        location.
 
1341
        """
 
1342
        import errno
 
1343
        _locs = ['parent', 'pull', 'x-pull']
 
1344
        for l in _locs:
 
1345
            try:
 
1346
                return self.controlfile(l, 'r').read().strip('\n')
 
1347
            except IOError, e:
 
1348
                if e.errno != errno.ENOENT:
 
1349
                    raise
 
1350
        return None
 
1351
 
 
1352
 
 
1353
    def set_parent(self, url):
 
1354
        # TODO: Maybe delete old location files?
 
1355
        from bzrlib.atomicfile import AtomicFile
 
1356
        self.lock_write()
 
1357
        try:
 
1358
            f = AtomicFile(self.controlfilename('parent'))
 
1359
            try:
 
1360
                f.write(url + '\n')
 
1361
                f.commit()
 
1362
            finally:
 
1363
                f.close()
 
1364
        finally:
 
1365
            self.unlock()
 
1366
 
 
1367
    def check_revno(self, revno):
 
1368
        """\
 
1369
        Check whether a revno corresponds to any revision.
 
1370
        Zero (the NULL revision) is considered valid.
 
1371
        """
 
1372
        if revno != 0:
 
1373
            self.check_real_revno(revno)
 
1374
            
 
1375
    def check_real_revno(self, revno):
 
1376
        """\
 
1377
        Check whether a revno corresponds to a real revision.
 
1378
        Zero (the NULL revision) is considered invalid
 
1379
        """
 
1380
        if revno < 1 or revno > self.revno():
 
1381
            raise InvalidRevisionNumber(revno)
 
1382
        
 
1383
        
930
1384
 
931
1385
 
932
1386
class ScratchBranch(Branch):
936
1390
    >>> isdir(b.base)
937
1391
    True
938
1392
    >>> bd = b.base
939
 
    >>> del b
 
1393
    >>> b.destroy()
940
1394
    >>> isdir(bd)
941
1395
    False
942
1396
    """
943
 
    def __init__(self, files=[], dirs=[]):
 
1397
    def __init__(self, files=[], dirs=[], base=None):
944
1398
        """Make a test branch.
945
1399
 
946
1400
        This creates a temporary directory and runs init-tree in it.
947
1401
 
948
1402
        If any files are listed, they are created in the working copy.
949
1403
        """
950
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
1404
        from tempfile import mkdtemp
 
1405
        init = False
 
1406
        if base is None:
 
1407
            base = mkdtemp()
 
1408
            init = True
 
1409
        Branch.__init__(self, base, init=init)
951
1410
        for d in dirs:
952
1411
            os.mkdir(self.abspath(d))
953
1412
            
955
1414
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
956
1415
 
957
1416
 
 
1417
    def clone(self):
 
1418
        """
 
1419
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1420
        >>> clone = orig.clone()
 
1421
        >>> os.path.samefile(orig.base, clone.base)
 
1422
        False
 
1423
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1424
        True
 
1425
        """
 
1426
        from shutil import copytree
 
1427
        from tempfile import mkdtemp
 
1428
        base = mkdtemp()
 
1429
        os.rmdir(base)
 
1430
        copytree(self.base, base, symlinks=True)
 
1431
        return ScratchBranch(base=base)
 
1432
 
 
1433
 
 
1434
        
958
1435
    def __del__(self):
 
1436
        self.destroy()
 
1437
 
 
1438
    def destroy(self):
959
1439
        """Destroy the test branch, removing the scratch directory."""
 
1440
        from shutil import rmtree
960
1441
        try:
961
 
            shutil.rmtree(self.base)
962
 
        except OSError:
 
1442
            if self.base:
 
1443
                mutter("delete ScratchBranch %s" % self.base)
 
1444
                rmtree(self.base)
 
1445
        except OSError, e:
963
1446
            # Work around for shutil.rmtree failing on Windows when
964
1447
            # readonly files are encountered
 
1448
            mutter("hit exception in destroying ScratchBranch: %s" % e)
965
1449
            for root, dirs, files in os.walk(self.base, topdown=False):
966
1450
                for name in files:
967
1451
                    os.chmod(os.path.join(root, name), 0700)
968
 
            shutil.rmtree(self.base)
 
1452
            rmtree(self.base)
 
1453
        self.base = None
969
1454
 
970
1455
    
971
1456
 
988
1473
 
989
1474
 
990
1475
 
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
1476
def gen_file_id(name):
999
1477
    """Return new file id.
1000
1478
 
1001
1479
    This should probably generate proper UUIDs, but for the moment we
1002
1480
    cope with just randomness because running uuidgen every time is
1003
1481
    slow."""
 
1482
    import re
 
1483
    from binascii import hexlify
 
1484
    from time import time
 
1485
 
 
1486
    # get last component
1004
1487
    idx = name.rfind('/')
1005
1488
    if idx != -1:
1006
1489
        name = name[idx+1 : ]
1008
1491
    if idx != -1:
1009
1492
        name = name[idx+1 : ]
1010
1493
 
 
1494
    # make it not a hidden file
1011
1495
    name = name.lstrip('.')
1012
1496
 
 
1497
    # remove any wierd characters; we don't escape them but rather
 
1498
    # just pull them out
 
1499
    name = re.sub(r'[^\w.]', '', name)
 
1500
 
1013
1501
    s = hexlify(rand_bytes(8))
1014
 
    return '-'.join((name, compact_date(time.time()), s))
 
1502
    return '-'.join((name, compact_date(time()), s))
 
1503
 
 
1504
 
 
1505
def gen_root_id():
 
1506
    """Return a new tree-root file id."""
 
1507
    return gen_file_id('TREE_ROOT')
 
1508
 
 
1509
 
 
1510
def pull_loc(branch):
 
1511
    # TODO: Should perhaps just make attribute be 'base' in
 
1512
    # RemoteBranch and Branch?
 
1513
    if hasattr(branch, "baseurl"):
 
1514
        return branch.baseurl
 
1515
    else:
 
1516
        return branch.base
 
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
    from bzrlib.branch import Branch
 
1531
 
 
1532
    assert isinstance(branch_from, Branch)
 
1533
    assert isinstance(to_location, basestring)
 
1534
    
 
1535
    br_to = Branch(to_location, init=True)
 
1536
    br_to.set_root_id(branch_from.get_root_id())
 
1537
    if revision is None:
 
1538
        revno = branch_from.revno()
 
1539
    else:
 
1540
        revno, rev_id = branch_from.get_revision_info(revision)
 
1541
    br_to.update_revisions(branch_from, stop_revision=revno)
 
1542
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
1543
          check_clean=False, ignore_zero=True)
 
1544
    
 
1545
    from_location = pull_loc(branch_from)
 
1546
    br_to.set_parent(pull_loc(branch_from))
 
1547