~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-10 03:56:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050510035602-242e1d56bc16e870
todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
import sys
19
 
import os
 
18
from sets import Set
 
19
 
 
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
 
21
import traceback, socket, fnmatch, difflib, time
 
22
from binascii import hexlify
20
23
 
21
24
import bzrlib
22
 
from bzrlib.trace import mutter, note
23
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
 
     splitpath, \
25
 
     sha_file, appendpath, file_kind
26
 
 
27
 
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
28
 
                           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"
 
25
from inventory import Inventory
 
26
from trace import mutter, note
 
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
 
28
from inventory import InventoryEntry, Inventory
 
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
 
30
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
 
31
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
32
from store import ImmutableStore
 
33
from revision import Revision
 
34
from errors import bailout, BzrError
 
35
from textui import show_status
 
36
from diff import diff_trees
 
37
 
 
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
42
39
## TODO: Maybe include checks for common corruption of newlines, etc?
43
40
 
44
41
 
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
42
 
53
43
def find_branch(f, **args):
54
 
    if f and (f.startswith('http://') or f.startswith('https://')):
 
44
    if f.startswith('http://') or f.startswith('https://'):
55
45
        import remotebranch 
56
46
        return remotebranch.RemoteBranch(f, **args)
57
47
    else:
58
48
        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
49
        
105
50
 
106
51
def find_branch_root(f=None):
111
56
    It is not necessary that f exists.
112
57
 
113
58
    Basically we keep looking up until we find the control directory or
114
 
    run into the root.  If there isn't one, raises NotBranchError.
115
 
    """
 
59
    run into the root."""
116
60
    if f == None:
117
61
        f = os.getcwd()
118
62
    elif hasattr(os.path, 'realpath'):
119
63
        f = os.path.realpath(f)
120
64
    else:
121
65
        f = os.path.abspath(f)
122
 
    if not os.path.exists(f):
123
 
        raise BzrError('%r does not exist' % f)
124
 
        
125
66
 
126
67
    orig_f = f
127
68
 
131
72
        head, tail = os.path.split(f)
132
73
        if head == f:
133
74
            # reached the root, whatever that may be
134
 
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
 
75
            raise BzrError('%r is not in a branch' % orig_f)
135
76
        f = head
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.")
 
77
    
145
78
 
146
79
 
147
80
######################################################################
148
81
# branch objects
149
82
 
150
 
class Branch(object):
 
83
class Branch:
151
84
    """Branch holding a history of revisions.
152
85
 
153
86
    base
154
87
        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.
165
88
    """
166
 
    base = None
167
 
    _lock_mode = None
168
 
    _lock_count = None
169
 
    _lock = None
 
89
    _lockmode = None
170
90
    
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
 
 
176
 
    def __init__(self, base, init=False, find_root=True):
 
91
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
177
92
        """Create new branch object at a particular location.
178
93
 
179
94
        base -- Base directory for the branch.
188
103
        In the test suite, creation of new trees is tested using the
189
104
        `ScratchBranch` class.
190
105
        """
191
 
        from bzrlib.store import ImmutableStore
192
106
        if init:
193
107
            self.base = os.path.realpath(base)
194
108
            self._make_control()
197
111
        else:
198
112
            self.base = os.path.realpath(base)
199
113
            if not isdir(self.controlfilename('.')):
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'])
 
114
                bailout("not a bzr branch: %s" % quotefn(base),
 
115
                        ['use "bzr init" to initialize a new working tree',
 
116
                         'current bzr can only operate from top-of-tree'])
204
117
        self._check_format()
 
118
        self.lock(lock_mode)
205
119
 
206
 
        self.weave_store = WeaveStore(self.controlfilename('weaves'))
 
120
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
207
121
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
208
122
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
209
123
 
215
129
    __repr__ = __str__
216
130
 
217
131
 
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
 
132
 
 
133
    def lock(self, mode='w'):
 
134
        """Lock the on-disk branch, excluding other processes."""
 
135
        try:
 
136
            import fcntl, errno
 
137
 
 
138
            if mode == 'w':
 
139
                lm = fcntl.LOCK_EX
 
140
                om = os.O_WRONLY | os.O_CREAT
 
141
            elif mode == 'r':
 
142
                lm = fcntl.LOCK_SH
 
143
                om = os.O_RDONLY
 
144
            else:
 
145
                raise BzrError("invalid locking mode %r" % mode)
 
146
 
 
147
            try:
 
148
                lockfile = os.open(self.controlfilename('branch-lock'), om)
 
149
            except OSError, e:
 
150
                if e.errno == errno.ENOENT:
 
151
                    # might not exist on branches from <0.0.4
 
152
                    self.controlfile('branch-lock', 'w').close()
 
153
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
 
154
                else:
 
155
                    raise e
 
156
            
 
157
            fcntl.lockf(lockfile, lm)
 
158
            def unlock():
 
159
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
160
                os.close(lockfile)
 
161
                self._lockmode = None
 
162
            self.unlock = unlock
 
163
            self._lockmode = mode
 
164
        except ImportError:
 
165
            warning("please write a locking method for platform %r" % sys.platform)
 
166
            def unlock():
 
167
                self._lockmode = None
 
168
            self.unlock = unlock
 
169
            self._lockmode = mode
 
170
 
 
171
 
 
172
    def _need_readlock(self):
 
173
        if self._lockmode not in ['r', 'w']:
 
174
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
175
 
 
176
    def _need_writelock(self):
 
177
        if self._lockmode not in ['w']:
 
178
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
179
 
263
180
 
264
181
    def abspath(self, name):
265
182
        """Return absolute filename for something in the branch"""
266
183
        return os.path.join(self.base, name)
267
184
 
 
185
 
268
186
    def relpath(self, path):
269
187
        """Return path relative to this branch of something inside it.
270
188
 
271
189
        Raises an error if path is not in this branch."""
272
 
        return _relpath(self.base, path)
 
190
        rp = os.path.realpath(path)
 
191
        # FIXME: windows
 
192
        if not rp.startswith(self.base):
 
193
            bailout("path %r is not within branch %r" % (rp, self.base))
 
194
        rp = rp[len(self.base):]
 
195
        rp = rp.lstrip(os.sep)
 
196
        return rp
 
197
 
273
198
 
274
199
    def controlfilename(self, file_or_path):
275
200
        """Return location relative to branch."""
276
 
        if isinstance(file_or_path, basestring):
 
201
        if isinstance(file_or_path, types.StringTypes):
277
202
            file_or_path = [file_or_path]
278
203
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
279
204
 
285
210
        and binary.  binary files are untranslated byte streams.  Text
286
211
        control files are stored with Unix newlines and in UTF-8, even
287
212
        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.
291
213
        """
292
214
 
293
215
        fn = self.controlfilename(file_or_path)
303
225
        else:
304
226
            raise BzrError("invalid controlfile mode %r" % mode)
305
227
 
 
228
 
 
229
 
306
230
    def _make_control(self):
307
231
        os.mkdir(self.controlfilename([]))
308
232
        self.controlfile('README', 'w').write(
309
233
            "This is a Bazaar-NG control directory.\n"
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'):
 
234
            "Do not change any files in this directory.")
 
235
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
236
        for d in ('text-store', 'inventory-store', 'revision-store'):
314
237
            os.mkdir(self.controlfilename(d))
315
238
        for f in ('revision-history', 'merged-patches',
316
239
                  'pending-merged-patches', 'branch-name',
317
 
                  'branch-lock',
318
 
                  'pending-merges'):
 
240
                  'branch-lock'):
319
241
            self.controlfile(f, 'w').write('')
320
242
        mutter('created control directory in ' + self.base)
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)
 
243
        Inventory().write_xml(self.controlfile('inventory','w'))
327
244
 
328
245
 
329
246
    def _check_format(self):
330
247
        """Check this branch format is supported.
331
248
 
332
 
        The format level is stored, as an integer, in
333
 
        self._branch_format for code that needs to check it later.
 
249
        The current tool only supports the current unstable format.
334
250
 
335
251
        In the future, we might need different in-memory Branch
336
252
        classes to support downlevel branches.  But not yet.
337
253
        """
 
254
        # This ignores newlines so that we can open branches created
 
255
        # on Windows from Linux and so on.  I think it might be better
 
256
        # to always make all internal files in unix format.
338
257
        fmt = self.controlfile('branch-format', 'r').read()
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)
 
258
        fmt.replace('\r\n', '')
 
259
        if fmt != BZR_BRANCH_FORMAT:
 
260
            bailout('sorry, branch format %r not supported' % fmt,
 
261
                    ['use a different bzr version',
 
262
                     'or remove the .bzr directory and "bzr init" again'])
 
263
 
364
264
 
365
265
    def read_working_inventory(self):
366
266
        """Read the working inventory."""
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
 
            
 
267
        self._need_readlock()
 
268
        before = time.time()
 
269
        # ElementTree does its own conversion from UTF-8, so open in
 
270
        # binary.
 
271
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
272
        mutter("loaded inventory of %d items in %f"
 
273
               % (len(inv), time.time() - before))
 
274
        return inv
 
275
 
376
276
 
377
277
    def _write_inventory(self, inv):
378
278
        """Update the working inventory.
380
280
        That is to say, the inventory describing changes underway, that
381
281
        will be committed to the next revision.
382
282
        """
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
 
        
 
283
        self._need_writelock()
 
284
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
285
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
286
        tmpfname = self.controlfilename('inventory.tmp')
 
287
        tmpf = file(tmpfname, 'wb')
 
288
        inv.write_xml(tmpf)
 
289
        tmpf.close()
 
290
        inv_fname = self.controlfilename('inventory')
 
291
        if sys.platform == 'win32':
 
292
            os.remove(inv_fname)
 
293
        os.rename(tmpfname, inv_fname)
396
294
        mutter('wrote working inventory')
397
 
            
 
295
 
398
296
 
399
297
    inventory = property(read_working_inventory, _write_inventory, None,
400
298
                         """Inventory for the working copy.""")
401
299
 
402
300
 
403
 
    def add(self, files, ids=None):
 
301
    def add(self, files, verbose=False):
404
302
        """Make files versioned.
405
303
 
406
 
        Note that the command line normally calls smart_add instead,
407
 
        which can automatically recurse.
 
304
        Note that the command line normally calls smart_add instead.
408
305
 
409
306
        This puts the files in the Added state, so that they will be
410
307
        recorded by the next commit.
411
308
 
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
 
 
420
309
        TODO: Perhaps have an option to add the ids even if the files do
421
 
              not (yet) exist.
422
 
 
423
 
        TODO: Perhaps yield the ids and paths as they're added.
 
310
               not (yet) exist.
 
311
 
 
312
        TODO: Perhaps return the ids of the files?  But then again it
 
313
               is easy to retrieve them if they're needed.
 
314
 
 
315
        TODO: Option to specify file id.
 
316
 
 
317
        TODO: Adding a directory should optionally recurse down and
 
318
               add all non-ignored children.  Perhaps do that in a
 
319
               higher-level method.
 
320
 
 
321
        >>> b = ScratchBranch(files=['foo'])
 
322
        >>> 'foo' in b.unknowns()
 
323
        True
 
324
        >>> b.show_status()
 
325
        ?       foo
 
326
        >>> b.add('foo')
 
327
        >>> 'foo' in b.unknowns()
 
328
        False
 
329
        >>> bool(b.inventory.path2id('foo'))
 
330
        True
 
331
        >>> b.show_status()
 
332
        A       foo
 
333
 
 
334
        >>> b.add('foo')
 
335
        Traceback (most recent call last):
 
336
        ...
 
337
        BzrError: ('foo is already versioned', [])
 
338
 
 
339
        >>> b.add(['nothere'])
 
340
        Traceback (most recent call last):
 
341
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
424
342
        """
 
343
        self._need_writelock()
 
344
 
425
345
        # TODO: Re-adding a file that is removed in the working copy
426
346
        # should probably put it back with the previous ID.
427
 
        if isinstance(files, basestring):
428
 
            assert(ids is None or isinstance(ids, basestring))
 
347
        if isinstance(files, types.StringTypes):
429
348
            files = [files]
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
 
            
 
349
        
 
350
        inv = self.read_working_inventory()
 
351
        for f in files:
 
352
            if is_control_file(f):
 
353
                bailout("cannot add control file %s" % quotefn(f))
 
354
 
 
355
            fp = splitpath(f)
 
356
 
 
357
            if len(fp) == 0:
 
358
                bailout("cannot add top-level %r" % f)
 
359
                
 
360
            fullpath = os.path.normpath(self.abspath(f))
 
361
 
 
362
            try:
 
363
                kind = file_kind(fullpath)
 
364
            except OSError:
 
365
                # maybe something better?
 
366
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
367
            
 
368
            if kind != 'file' and kind != 'directory':
 
369
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
370
 
 
371
            file_id = gen_file_id(f)
 
372
            inv.add_path(f, kind=kind, file_id=file_id)
 
373
 
 
374
            if verbose:
 
375
                show_status('A', kind, quotefn(f))
 
376
                
 
377
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
378
            
 
379
        self._write_inventory(inv)
 
380
 
471
381
 
472
382
    def print_file(self, file, revno):
473
383
        """Print `file` to stdout."""
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
 
 
 
384
        self._need_readlock()
 
385
        tree = self.revision_tree(self.lookup_revision(revno))
 
386
        # use inventory as it was in that revision
 
387
        file_id = tree.inventory.path2id(file)
 
388
        if not file_id:
 
389
            bailout("%r is not present in revision %d" % (file, revno))
 
390
        tree.print_file(file_id)
 
391
        
485
392
 
486
393
    def remove(self, files, verbose=False):
487
394
        """Mark nominated files for removal from the inventory.
490
397
 
491
398
        TODO: Refuse to remove modified files unless --force is given?
492
399
 
 
400
        >>> b = ScratchBranch(files=['foo'])
 
401
        >>> b.add('foo')
 
402
        >>> b.inventory.has_filename('foo')
 
403
        True
 
404
        >>> b.remove('foo')
 
405
        >>> b.working_tree().has_filename('foo')
 
406
        True
 
407
        >>> b.inventory.has_filename('foo')
 
408
        False
 
409
        
 
410
        >>> b = ScratchBranch(files=['foo'])
 
411
        >>> b.add('foo')
 
412
        >>> b.commit('one')
 
413
        >>> b.remove('foo')
 
414
        >>> b.commit('two')
 
415
        >>> b.inventory.has_filename('foo') 
 
416
        False
 
417
        >>> b.basis_tree().has_filename('foo') 
 
418
        False
 
419
        >>> b.working_tree().has_filename('foo') 
 
420
        True
 
421
 
493
422
        TODO: Do something useful with directories.
494
423
 
495
424
        TODO: Should this remove the text or not?  Tough call; not
499
428
        """
500
429
        ## TODO: Normalize names
501
430
        ## TODO: Remove nested loops; better scalability
502
 
        if isinstance(files, basestring):
 
431
        self._need_writelock()
 
432
 
 
433
        if isinstance(files, types.StringTypes):
503
434
            files = [files]
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))
 
435
        
 
436
        tree = self.working_tree()
 
437
        inv = tree.inventory
 
438
 
 
439
        # do this before any modifications
 
440
        for f in files:
 
441
            fid = inv.path2id(f)
 
442
            if not fid:
 
443
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
444
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
445
            if verbose:
 
446
                # having remove it, it must be either ignored or unknown
 
447
                if tree.is_ignored(f):
 
448
                    new_status = 'I'
 
449
                else:
 
450
                    new_status = '?'
 
451
                show_status(new_status, inv[fid].kind, quotefn(f))
 
452
            del inv[fid]
 
453
 
540
454
        self._write_inventory(inv)
541
455
 
542
456
 
559
473
        return self.working_tree().unknowns()
560
474
 
561
475
 
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
 
 
 
476
    def commit(self, message, timestamp=None, timezone=None,
 
477
               committer=None,
 
478
               verbose=False):
 
479
        """Commit working copy as a new revision.
 
480
        
 
481
        The basic approach is to add all the file texts into the
 
482
        store, then the inventory, then make a new revision pointing
 
483
        to that inventory and store that.
 
484
        
 
485
        This is not quite safe if the working copy changes during the
 
486
        commit; for the moment that is simply not allowed.  A better
 
487
        approach is to make a temporary copy of the files before
 
488
        computing their hashes, and then add those hashes in turn to
 
489
        the inventory.  This should mean at least that there are no
 
490
        broken hash pointers.  There is no way we can get a snapshot
 
491
        of the whole directory at an instant.  This would also have to
 
492
        be robust against files disappearing, moving, etc.  So the
 
493
        whole thing is a bit hard.
 
494
 
 
495
        timestamp -- if not None, seconds-since-epoch for a
 
496
             postdated/predated commit.
 
497
        """
 
498
        self._need_writelock()
 
499
 
 
500
        ## TODO: Show branch names
 
501
 
 
502
        # TODO: Don't commit if there are no changes, unless forced?
 
503
 
 
504
        # First walk over the working inventory; and both update that
 
505
        # and also build a new revision inventory.  The revision
 
506
        # inventory needs to hold the text-id, sha1 and size of the
 
507
        # actual file versions committed in the revision.  (These are
 
508
        # not present in the working inventory.)  We also need to
 
509
        # detect missing/deleted files, and remove them from the
 
510
        # working inventory.
 
511
 
 
512
        work_inv = self.read_working_inventory()
 
513
        inv = Inventory()
 
514
        basis = self.basis_tree()
 
515
        basis_inv = basis.inventory
 
516
        missing_ids = []
 
517
        for path, entry in work_inv.iter_entries():
 
518
            ## TODO: Cope with files that have gone missing.
 
519
 
 
520
            ## TODO: Check that the file kind has not changed from the previous
 
521
            ## revision of this file (if any).
 
522
 
 
523
            entry = entry.copy()
 
524
 
 
525
            p = self.abspath(path)
 
526
            file_id = entry.file_id
 
527
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
528
 
 
529
            if not os.path.exists(p):
 
530
                mutter("    file is missing, removing from inventory")
 
531
                if verbose:
 
532
                    show_status('D', entry.kind, quotefn(path))
 
533
                missing_ids.append(file_id)
 
534
                continue
 
535
 
 
536
            # TODO: Handle files that have been deleted
 
537
 
 
538
            # TODO: Maybe a special case for empty files?  Seems a
 
539
            # waste to store them many times.
 
540
 
 
541
            inv.add(entry)
 
542
 
 
543
            if basis_inv.has_id(file_id):
 
544
                old_kind = basis_inv[file_id].kind
 
545
                if old_kind != entry.kind:
 
546
                    bailout("entry %r changed kind from %r to %r"
 
547
                            % (file_id, old_kind, entry.kind))
 
548
 
 
549
            if entry.kind == 'directory':
 
550
                if not isdir(p):
 
551
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
552
            elif entry.kind == 'file':
 
553
                if not isfile(p):
 
554
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
555
 
 
556
                content = file(p, 'rb').read()
 
557
 
 
558
                entry.text_sha1 = sha_string(content)
 
559
                entry.text_size = len(content)
 
560
 
 
561
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
562
                if (old_ie
 
563
                    and (old_ie.text_size == entry.text_size)
 
564
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
565
                    ## assert content == basis.get_file(file_id).read()
 
566
                    entry.text_id = basis_inv[file_id].text_id
 
567
                    mutter('    unchanged from previous text_id {%s}' %
 
568
                           entry.text_id)
 
569
                    
 
570
                else:
 
571
                    entry.text_id = gen_file_id(entry.name)
 
572
                    self.text_store.add(content, entry.text_id)
 
573
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
574
                    if verbose:
 
575
                        if not old_ie:
 
576
                            state = 'A'
 
577
                        elif (old_ie.name == entry.name
 
578
                              and old_ie.parent_id == entry.parent_id):
 
579
                            state = 'M'
 
580
                        else:
 
581
                            state = 'R'
 
582
 
 
583
                        show_status(state, entry.kind, quotefn(path))
 
584
 
 
585
        for file_id in missing_ids:
 
586
            # have to do this later so we don't mess up the iterator.
 
587
            # since parents may be removed before their children we
 
588
            # have to test.
 
589
 
 
590
            # FIXME: There's probably a better way to do this; perhaps
 
591
            # the workingtree should know how to filter itself.
 
592
            if work_inv.has_id(file_id):
 
593
                del work_inv[file_id]
 
594
 
 
595
 
 
596
        inv_id = rev_id = _gen_revision_id(time.time())
 
597
        
 
598
        inv_tmp = tempfile.TemporaryFile()
 
599
        inv.write_xml(inv_tmp)
 
600
        inv_tmp.seek(0)
 
601
        self.inventory_store.add(inv_tmp, inv_id)
 
602
        mutter('new inventory_id is {%s}' % inv_id)
 
603
 
 
604
        self._write_inventory(work_inv)
 
605
 
 
606
        if timestamp == None:
 
607
            timestamp = time.time()
 
608
 
 
609
        if committer == None:
 
610
            committer = username()
 
611
 
 
612
        if timezone == None:
 
613
            timezone = local_time_offset()
 
614
 
 
615
        mutter("building commit log message")
 
616
        rev = Revision(timestamp=timestamp,
 
617
                       timezone=timezone,
 
618
                       committer=committer,
 
619
                       precursor = self.last_patch(),
 
620
                       message = message,
 
621
                       inventory_id=inv_id,
 
622
                       revision_id=rev_id)
 
623
 
 
624
        rev_tmp = tempfile.TemporaryFile()
 
625
        rev.write_xml(rev_tmp)
 
626
        rev_tmp.seek(0)
 
627
        self.revision_store.add(rev_tmp, rev_id)
 
628
        mutter("new revision_id is {%s}" % rev_id)
 
629
        
 
630
        ## XXX: Everything up to here can simply be orphaned if we abort
 
631
        ## the commit; it will leave junk files behind but that doesn't
 
632
        ## matter.
 
633
 
 
634
        ## TODO: Read back the just-generated changeset, and make sure it
 
635
        ## applies and recreates the right state.
 
636
 
 
637
        ## TODO: Also calculate and store the inventory SHA1
 
638
        mutter("committing patch r%d" % (self.revno() + 1))
 
639
 
 
640
 
 
641
        self.append_revision(rev_id)
 
642
        
 
643
        if verbose:
 
644
            note("commited r%d" % self.revno())
 
645
 
 
646
 
 
647
    def append_revision(self, revision_id):
 
648
        mutter("add {%s} to revision-history" % revision_id)
568
649
        rev_history = self.revision_history()
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
 
650
 
 
651
        tmprhname = self.controlfilename('revision-history.tmp')
 
652
        rhname = self.controlfilename('revision-history')
 
653
        
 
654
        f = file(tmprhname, 'wt')
 
655
        rev_history.append(revision_id)
 
656
        f.write('\n'.join(rev_history))
 
657
        f.write('\n')
 
658
        f.close()
 
659
 
 
660
        if sys.platform == 'win32':
 
661
            os.remove(rhname)
 
662
        os.rename(tmprhname, rhname)
 
663
        
597
664
 
598
665
 
599
666
    def get_revision(self, revision_id):
600
667
        """Return the Revision object for a named revision"""
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
 
            
 
668
        self._need_readlock()
 
669
        r = Revision.read_xml(self.revision_store[revision_id])
610
670
        assert r.revision_id == revision_id
611
671
        return r
612
672
 
613
673
 
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):
 
674
    def get_inventory(self, inventory_id):
649
675
        """Get Inventory object by hash.
650
676
 
651
677
        TODO: Perhaps for this and similar methods, take a revision
652
678
               parameter which can be either an integer revno or a
653
679
               string hash."""
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))
 
680
        self._need_readlock()
 
681
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
682
        return i
673
683
 
674
684
 
675
685
    def get_revision_inventory(self, revision_id):
676
686
        """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.
 
687
        self._need_readlock()
679
688
        if revision_id == None:
680
 
            return Inventory(self.get_root_id())
 
689
            return Inventory()
681
690
        else:
682
 
            return self.get_inventory(revision_id)
 
691
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
683
692
 
684
693
 
685
694
    def revision_history(self):
688
697
        >>> ScratchBranch().revision_history()
689
698
        []
690
699
        """
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
 
700
        self._need_readlock()
 
701
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
702
 
 
703
 
 
704
    def enum_history(self, direction):
 
705
        """Return (revno, revision_id) for history of branch.
 
706
 
 
707
        direction
 
708
            'forward' is from earliest to latest
 
709
            'reverse' is from latest to earliest
 
710
        """
 
711
        rh = self.revision_history()
 
712
        if direction == 'forward':
 
713
            i = 1
 
714
            for rid in rh:
 
715
                yield i, rid
 
716
                i += 1
 
717
        elif direction == 'reverse':
 
718
            i = len(rh)
 
719
            while i > 0:
 
720
                yield i, rh[i-1]
 
721
                i -= 1
 
722
        else:
 
723
            raise BzrError('invalid history direction %r' % direction)
742
724
 
743
725
 
744
726
    def revno(self):
746
728
 
747
729
        That is equivalent to the number of revisions committed to
748
730
        this branch.
 
731
 
 
732
        >>> b = ScratchBranch()
 
733
        >>> b.revno()
 
734
        0
 
735
        >>> b.commit('no foo')
 
736
        >>> b.revno()
 
737
        1
749
738
        """
750
739
        return len(self.revision_history())
751
740
 
752
741
 
753
742
    def last_patch(self):
754
743
        """Return last patch hash, or None if no history.
 
744
 
 
745
        >>> ScratchBranch().last_patch() == None
 
746
        True
755
747
        """
756
748
        ph = self.revision_history()
757
749
        if ph:
758
750
            return ph[-1]
759
751
        else:
760
752
            return None
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."""
 
753
        
 
754
 
 
755
    def lookup_revision(self, revno):
 
756
        """Return revision hash for revision number."""
910
757
        if revno == 0:
911
758
            return None
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
 
759
 
 
760
        try:
 
761
            # list is 0-based; revisions are 1-based
 
762
            return self.revision_history()[revno-1]
 
763
        except IndexError:
 
764
            raise BzrError("no such revision %s" % revno)
 
765
 
1083
766
 
1084
767
    def revision_tree(self, revision_id):
1085
768
        """Return Tree for a revision on this branch.
1086
769
 
1087
770
        `revision_id` may be None for the null revision, in which case
1088
771
        an `EmptyTree` is returned."""
1089
 
        # TODO: refactor this to use an existing revision object
1090
 
        # so we don't need to read it in twice.
 
772
        self._need_readlock()
1091
773
        if revision_id == None:
1092
774
            return EmptyTree()
1093
775
        else:
1094
776
            inv = self.get_revision_inventory(revision_id)
1095
 
            return RevisionTree(self.weave_store, inv, revision_id)
 
777
            return RevisionTree(self.text_store, inv)
1096
778
 
1097
779
 
1098
780
    def working_tree(self):
1099
781
        """Return a `Tree` for the working copy."""
1100
 
        from workingtree import WorkingTree
1101
782
        return WorkingTree(self.base, self.read_working_inventory())
1102
783
 
1103
784
 
1105
786
        """Return `Tree` object for last revision.
1106
787
 
1107
788
        If there are no revisions yet, return an `EmptyTree`.
 
789
 
 
790
        >>> b = ScratchBranch(files=['foo'])
 
791
        >>> b.basis_tree().has_filename('foo')
 
792
        False
 
793
        >>> b.working_tree().has_filename('foo')
 
794
        True
 
795
        >>> b.add('foo')
 
796
        >>> b.commit('add foo')
 
797
        >>> b.basis_tree().has_filename('foo')
 
798
        True
1108
799
        """
1109
 
        return self.revision_tree(self.last_patch())
 
800
        r = self.last_patch()
 
801
        if r == None:
 
802
            return EmptyTree()
 
803
        else:
 
804
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
805
 
1110
806
 
1111
807
 
1112
808
    def rename_one(self, from_rel, to_rel):
1114
810
 
1115
811
        This can change the directory or the filename or both.
1116
812
        """
1117
 
        self.lock_write()
 
813
        self._need_writelock()
 
814
        tree = self.working_tree()
 
815
        inv = tree.inventory
 
816
        if not tree.has_filename(from_rel):
 
817
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
818
        if tree.has_filename(to_rel):
 
819
            bailout("can't rename: new working file %r already exists" % to_rel)
 
820
            
 
821
        file_id = inv.path2id(from_rel)
 
822
        if file_id == None:
 
823
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
824
 
 
825
        if inv.path2id(to_rel):
 
826
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
827
 
 
828
        to_dir, to_tail = os.path.split(to_rel)
 
829
        to_dir_id = inv.path2id(to_dir)
 
830
        if to_dir_id == None and to_dir != '':
 
831
            bailout("can't determine destination directory id for %r" % to_dir)
 
832
 
 
833
        mutter("rename_one:")
 
834
        mutter("  file_id    {%s}" % file_id)
 
835
        mutter("  from_rel   %r" % from_rel)
 
836
        mutter("  to_rel     %r" % to_rel)
 
837
        mutter("  to_dir     %r" % to_dir)
 
838
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
839
            
 
840
        inv.rename(file_id, to_dir_id, to_tail)
 
841
 
 
842
        print "%s => %s" % (from_rel, to_rel)
 
843
        
 
844
        from_abs = self.abspath(from_rel)
 
845
        to_abs = self.abspath(to_rel)
1118
846
        try:
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()
 
847
            os.rename(from_abs, to_abs)
 
848
        except OSError, e:
 
849
            bailout("failed to rename %r to %r: %s"
 
850
                    % (from_abs, to_abs, e[1]),
 
851
                    ["rename rolled back"])
 
852
 
 
853
        self._write_inventory(inv)
 
854
            
1159
855
 
1160
856
 
1161
857
    def move(self, from_paths, to_name):
1168
864
 
1169
865
        Note that to_name is only the last component of the new name;
1170
866
        this doesn't change the directory.
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
 
        
 
867
        """
 
868
        self._need_writelock()
 
869
        ## TODO: Option to move IDs only
 
870
        assert not isinstance(from_paths, basestring)
 
871
        tree = self.working_tree()
 
872
        inv = tree.inventory
 
873
        to_abs = self.abspath(to_name)
 
874
        if not isdir(to_abs):
 
875
            bailout("destination %r is not a directory" % to_abs)
 
876
        if not tree.has_filename(to_name):
 
877
            bailout("destination %r not in working directory" % to_abs)
 
878
        to_dir_id = inv.path2id(to_name)
 
879
        if to_dir_id == None and to_name != '':
 
880
            bailout("destination %r is not a versioned directory" % to_name)
 
881
        to_dir_ie = inv[to_dir_id]
 
882
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
883
            bailout("destination %r is not a directory" % to_abs)
 
884
 
 
885
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
886
 
 
887
        for f in from_paths:
 
888
            if not tree.has_filename(f):
 
889
                bailout("%r does not exist in working tree" % f)
 
890
            f_id = inv.path2id(f)
 
891
            if f_id == None:
 
892
                bailout("%r is not versioned" % f)
 
893
            name_tail = splitpath(f)[-1]
 
894
            dest_path = appendpath(to_name, name_tail)
 
895
            if tree.has_filename(dest_path):
 
896
                bailout("destination %r already exists" % dest_path)
 
897
            if f_id in to_idpath:
 
898
                bailout("can't move %r to a subdirectory of itself" % f)
 
899
 
 
900
        # OK, so there's a race here, it's possible that someone will
 
901
        # create a file in this interval and then the rename might be
 
902
        # left half-done.  But we should have caught most problems.
 
903
 
 
904
        for f in from_paths:
 
905
            name_tail = splitpath(f)[-1]
 
906
            dest_path = appendpath(to_name, name_tail)
 
907
            print "%s => %s" % (f, dest_path)
 
908
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
909
            try:
 
910
                os.rename(self.abspath(f), self.abspath(dest_path))
 
911
            except OSError, e:
 
912
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
913
                        ["rename rolled back"])
 
914
 
 
915
        self._write_inventory(inv)
 
916
 
 
917
 
 
918
 
 
919
    def show_status(self, show_all=False, file_list=None):
 
920
        """Display single-line status for non-ignored working files.
 
921
 
 
922
        The list is show sorted in order by file name.
 
923
 
 
924
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
925
        >>> b.show_status()
 
926
        ?       foo
 
927
        >>> b.add('foo')
 
928
        >>> b.show_status()
 
929
        A       foo
 
930
        >>> b.commit("add foo")
 
931
        >>> b.show_status()
 
932
        >>> os.unlink(b.abspath('foo'))
 
933
        >>> b.show_status()
 
934
        D       foo
 
935
        """
 
936
        self._need_readlock()
 
937
 
 
938
        # We have to build everything into a list first so that it can
 
939
        # sorted by name, incorporating all the different sources.
 
940
 
 
941
        # FIXME: Rather than getting things in random order and then sorting,
 
942
        # just step through in order.
 
943
 
 
944
        # Interesting case: the old ID for a file has been removed,
 
945
        # but a new file has been created under that name.
 
946
 
 
947
        old = self.basis_tree()
 
948
        new = self.working_tree()
 
949
 
 
950
        items = diff_trees(old, new)
 
951
        # We want to filter out only if any file was provided in the file_list.
 
952
        if isinstance(file_list, list) and len(file_list):
 
953
            items = [item for item in items if item[3] in file_list]
 
954
 
 
955
        for fs, fid, oldname, newname, kind in items:
 
956
            if fs == 'R':
 
957
                show_status(fs, kind,
 
958
                            oldname + ' => ' + newname)
 
959
            elif fs == 'A' or fs == 'M':
 
960
                show_status(fs, kind, newname)
 
961
            elif fs == 'D':
 
962
                show_status(fs, kind, oldname)
 
963
            elif fs == '.':
 
964
                if show_all:
 
965
                    show_status(fs, kind, newname)
 
966
            elif fs == 'I':
 
967
                if show_all:
 
968
                    show_status(fs, kind, newname)
 
969
            elif fs == '?':
 
970
                show_status(fs, kind, newname)
 
971
            else:
 
972
                bailout("weird file state %r" % ((fs, fid),))
 
973
                
1366
974
 
1367
975
 
1368
976
class ScratchBranch(Branch):
1376
984
    >>> isdir(bd)
1377
985
    False
1378
986
    """
1379
 
    def __init__(self, files=[], dirs=[], base=None):
 
987
    def __init__(self, files=[], dirs=[]):
1380
988
        """Make a test branch.
1381
989
 
1382
990
        This creates a temporary directory and runs init-tree in it.
1383
991
 
1384
992
        If any files are listed, they are created in the working copy.
1385
993
        """
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)
 
994
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1392
995
        for d in dirs:
1393
996
            os.mkdir(self.abspath(d))
1394
997
            
1396
999
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1397
1000
 
1398
1001
 
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
 
        
1417
1002
    def __del__(self):
1418
1003
        self.destroy()
1419
1004
 
1420
1005
    def destroy(self):
1421
1006
        """Destroy the test branch, removing the scratch directory."""
1422
 
        from shutil import rmtree
1423
1007
        try:
1424
 
            if self.base:
1425
 
                mutter("delete ScratchBranch %s" % self.base)
1426
 
                rmtree(self.base)
 
1008
            mutter("delete ScratchBranch %s" % self.base)
 
1009
            shutil.rmtree(self.base)
1427
1010
        except OSError, e:
1428
1011
            # Work around for shutil.rmtree failing on Windows when
1429
1012
            # readonly files are encountered
1431
1014
            for root, dirs, files in os.walk(self.base, topdown=False):
1432
1015
                for name in files:
1433
1016
                    os.chmod(os.path.join(root, name), 0700)
1434
 
            rmtree(self.base)
 
1017
            shutil.rmtree(self.base)
1435
1018
        self.base = None
1436
1019
 
1437
1020
    
1455
1038
 
1456
1039
 
1457
1040
 
 
1041
def _gen_revision_id(when):
 
1042
    """Return new revision-id."""
 
1043
    s = '%s-%s-' % (user_email(), compact_date(when))
 
1044
    s += hexlify(rand_bytes(8))
 
1045
    return s
 
1046
 
 
1047
 
1458
1048
def gen_file_id(name):
1459
1049
    """Return new file id.
1460
1050
 
1461
1051
    This should probably generate proper UUIDs, but for the moment we
1462
1052
    cope with just randomness because running uuidgen every time is
1463
1053
    slow."""
1464
 
    import re
1465
 
    from binascii import hexlify
1466
 
    from time import time
1467
 
 
1468
 
    # get last component
1469
1054
    idx = name.rfind('/')
1470
1055
    if idx != -1:
1471
1056
        name = name[idx+1 : ]
1473
1058
    if idx != -1:
1474
1059
        name = name[idx+1 : ]
1475
1060
 
1476
 
    # make it not a hidden file
1477
1061
    name = name.lstrip('.')
1478
1062
 
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
 
 
1483
1063
    s = hexlify(rand_bytes(8))
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
 
 
 
1064
    return '-'.join((name, compact_date(time.time()), s))