← 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-09 09:44:03 UTC
  • Revision ID: mbp@sourcefrog.net-20050909094403-ddad5896b0b12c68
- weave commit records per-file ancestors

 - commits of merges are currently forbidden

 - files that existed in the previous revision are recorded with that 
   parent

 'weave annotate' on woven files now gives the correct result!

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