~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-07-29 13:40:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050729134025-9abbcae0d0faf25f
- todo: discussion of an uncommit command

  and this is the thousandth revision! :-)

Show diffs side-by-side

added added

removed removed

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