~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-11 06:20:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050511062005-297af3451635dae0
- Don't lose first line of command help!

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