~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-08-25 05:58:05 UTC
  • mfrom: (974.1.36)
  • Revision ID: mbp@sourcefrog.net-20050825055805-8c892bc3c2d75131
- merge aaron's merge improvements:

  * When merging, pull in all missing revisions from the source
    branch. 

  * Detect common ancestors by looking at the whole ancestry graph, 
    rather than just mainline history.

  Some changes to reconcile this with parallel updates to the test and
  trace code.

aaron.bentley@utoronto.ca-20050823052551-f3401a8b57d9126f

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
18
17
"""Tree classes, representing directory at point in time.
19
18
"""
20
19
 
21
 
from sets import Set
22
 
import os.path, os, fnmatch
23
 
 
24
 
from inventory import Inventory
25
 
from trace import mutter, note
26
 
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
27
 
     joinpath, splitpath, appendpath, isdir, isfile, file_kind
28
 
from errors import bailout
29
 
import branch
30
 
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
 
20
import os
31
21
 
32
22
import bzrlib
33
 
 
34
 
class Tree:
 
23
from bzrlib.trace import mutter, note
 
24
from bzrlib.errors import BzrError
 
25
from bzrlib.inventory import Inventory
 
26
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
 
27
 
 
28
 
 
29
exporters = {}
 
30
 
 
31
class Tree(object):
35
32
    """Abstract file tree.
36
33
 
37
34
    There are several subclasses:
53
50
    trees or versioned trees.
54
51
    """
55
52
    
56
 
    def get_file(self, file_id):
57
 
        """Return an open file-like object for given file id."""
58
 
        raise NotImplementedError()
59
 
 
60
53
    def has_filename(self, filename):
61
54
        """True if the tree has given filename."""
62
55
        raise NotImplementedError()
64
57
    def has_id(self, file_id):
65
58
        return self.inventory.has_id(file_id)
66
59
 
67
 
    def id_set(self):
68
 
        """Return set of all ids in this tree."""
69
 
        return self.inventory.id_set()
 
60
    __contains__ = has_id
 
61
 
 
62
    def __iter__(self):
 
63
        return iter(self.inventory)
70
64
 
71
65
    def id2path(self, file_id):
72
66
        return self.inventory.id2path(file_id)
73
67
 
74
68
    def _get_inventory(self):
75
69
        return self._inventory
 
70
    
 
71
    def get_file_by_path(self, path):
 
72
        return self.get_file(self._inventory.path2id(path))
76
73
 
77
74
    inventory = property(_get_inventory,
78
75
                         doc="Inventory of this Tree")
79
76
 
80
77
    def _check_retrieved(self, ie, f):
81
 
        # TODO: Test this check by damaging the store?
82
 
        if ie.text_size is not None:
83
 
            fs = filesize(f)
84
 
            if fs != ie.text_size:
85
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
78
        fp = fingerprint_file(f)
 
79
        f.seek(0)
 
80
        
 
81
        if ie.text_size != None:
 
82
            if ie.text_size != fp['size']:
 
83
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
86
84
                        ["inventory expects %d bytes" % ie.text_size,
87
 
                         "file is actually %d bytes" % fs,
 
85
                         "file is actually %d bytes" % fp['size'],
88
86
                         "store is probably damaged/corrupt"])
89
87
 
90
 
        f_hash = sha_file(f)
91
 
        f.seek(0)
92
 
        if ie.text_sha1 != f_hash:
93
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
88
        if ie.text_sha1 != fp['sha1']:
 
89
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
94
90
                    ["inventory expects %s" % ie.text_sha1,
95
 
                     "file is actually %s" % f_hash,
 
91
                     "file is actually %s" % fp['sha1'],
96
92
                     "store is probably damaged/corrupt"])
97
93
 
98
94
 
99
 
    def export(self, dest):
100
 
        """Export this tree to a new directory.
101
 
 
102
 
        `dest` should not exist, and will be created holding the
103
 
        contents of this tree.
104
 
 
105
 
        :todo: To handle subdirectories we need to create the
106
 
               directories first.
107
 
 
108
 
        :note: If the export fails, the destination directory will be
109
 
               left in a half-assed state.
110
 
        """
111
 
        os.mkdir(dest)
112
 
        mutter('export version %r' % self)
113
 
        inv = self.inventory
114
 
        for dp, ie in inv.iter_entries():
115
 
            kind = ie.kind
116
 
            fullpath = appendpath(dest, dp)
117
 
            if kind == 'directory':
118
 
                os.mkdir(fullpath)
119
 
            elif kind == 'file':
120
 
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
121
 
            else:
122
 
                bailout("don't know how to export {%s} of kind %r", fid, kind)
123
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
124
 
 
125
 
 
126
 
 
127
 
class WorkingTree(Tree):
128
 
    """Working copy tree.
129
 
 
130
 
    The inventory is held in the `Branch` working-inventory, and the
131
 
    files are in a directory on disk.
132
 
 
133
 
    It is possible for a `WorkingTree` to have a filename which is
134
 
    not listed in the Inventory and vice versa.
135
 
    """
136
 
    def __init__(self, basedir, inv):
137
 
        self._inventory = inv
138
 
        self.basedir = basedir
139
 
        self.path2id = inv.path2id
140
 
 
141
 
    def __repr__(self):
142
 
        return "<%s of %s>" % (self.__class__.__name__,
143
 
                               self.basedir)
144
 
 
145
 
    def _rel(self, filename):
146
 
        return os.path.join(self.basedir, filename)
147
 
 
148
 
    def has_filename(self, filename):
149
 
        return os.path.exists(self._rel(filename))
150
 
 
151
 
    def get_file(self, file_id):
152
 
        return file(self._get_store_filename(file_id), 'rb')
153
 
 
154
 
    def _get_store_filename(self, file_id):
155
 
        return self._rel(self.id2path(file_id))
156
 
 
157
 
    def get_file_size(self, file_id):
158
 
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
159
 
 
160
 
    def get_file_sha1(self, file_id):
161
 
        f = self.get_file(file_id)
162
 
        return sha_file(f)
163
 
 
164
 
 
165
 
    def file_class(self, filename):
166
 
        if self.path2id(filename):
167
 
            return 'V'
168
 
        elif self.is_ignored(filename):
169
 
            return 'I'
170
 
        else:
171
 
            return '?'
172
 
 
173
 
 
174
 
    def file_kind(self, filename):
175
 
        if isfile(self._rel(filename)):
176
 
            return 'file'
177
 
        elif isdir(self._rel(filename)):
178
 
            return 'directory'
179
 
        else:
180
 
            return 'unknown'
181
 
 
182
 
 
183
 
    def list_files(self):
184
 
        """Recursively list all files as (path, class, kind, id).
185
 
 
186
 
        Lists, but does not descend into unversioned directories.
187
 
 
188
 
        This does not include files that have been deleted in this
189
 
        tree.
190
 
 
191
 
        Skips the control directory.
192
 
        """
193
 
        inv = self.inventory
194
 
 
195
 
        def descend(from_dir, from_dir_id, dp):
196
 
            ls = os.listdir(dp)
197
 
            ls.sort()
198
 
            for f in ls:
199
 
                if bzrlib.BZRDIR == f:
200
 
                    continue
201
 
 
202
 
                # path within tree
203
 
                fp = appendpath(from_dir, f)
204
 
 
205
 
                # absolute path
206
 
                fap = appendpath(dp, f)
207
 
                
208
 
                f_ie = inv.get_child(from_dir_id, f)
209
 
                if f_ie:
210
 
                    c = 'V'
211
 
                elif self.is_ignored(fp):
212
 
                    c = 'I'
213
 
                else:
214
 
                    c = '?'
215
 
 
216
 
                fk = file_kind(fap)
217
 
 
218
 
                if f_ie:
219
 
                    if f_ie.kind != fk:
220
 
                        bailout("file %r entered as kind %r id %r, now of kind %r"
221
 
                                % (fap, f_ie.kind, f_ie.file_id, fk))
222
 
 
223
 
                yield fp, c, fk, (f_ie and f_ie.file_id)
224
 
 
225
 
                if fk != 'directory':
226
 
                    continue
227
 
 
228
 
                if c != 'V':
229
 
                    # don't descend unversioned directories
230
 
                    continue
231
 
                
232
 
                for ff in descend(fp, f_ie.file_id, fap):
233
 
                    yield ff
234
 
 
235
 
        for f in descend('', None, self.basedir):
236
 
            yield f
237
 
            
238
 
 
239
 
 
240
 
    def unknowns(self, path='', dir_id=None):
241
 
        """Yield names of unknown files in this WorkingTree.
242
 
 
243
 
        If there are any unknown directories then only the directory is
244
 
        returned, not all its children.  But if there are unknown files
245
 
        under a versioned subdirectory, they are returned.
246
 
 
247
 
        Currently returned depth-first, sorted by name within directories.
248
 
        """
249
 
        for fpath, fclass, fkind, fid in self.list_files():
250
 
            if fclass == '?':
251
 
                yield fpath
252
 
                
253
 
 
254
 
    def ignored_files(self):
255
 
        for fpath, fclass, fkind, fid in self.list_files():
256
 
            if fclass == 'I':
257
 
                yield fpath
258
 
 
259
 
 
260
 
    def is_ignored(self, filename):
261
 
        """Check whether the filename matches an ignore pattern."""
262
 
        ## TODO: Take them from a file, not hardcoded
263
 
        ## TODO: Use extended zsh-style globs maybe?
264
 
        ## TODO: Use '**' to match directories?
265
 
        ## TODO: Patterns without / should match in subdirectories?
266
 
        for i in bzrlib.DEFAULT_IGNORE:
267
 
            if fnmatch.fnmatchcase(filename, i):
268
 
                return True
269
 
        return False
270
 
        
271
 
 
272
 
        
273
 
        
 
95
    def print_file(self, fileid):
 
96
        """Print file with id `fileid` to stdout."""
 
97
        import sys
 
98
        pumpfile(self.get_file(fileid), sys.stdout)
 
99
        
 
100
        
 
101
    def export(self, dest, format='dir', root=None):
 
102
        """Export this tree."""
 
103
        try:
 
104
            exporter = exporters[format]
 
105
        except KeyError:
 
106
            from bzrlib.errors import BzrCommandError
 
107
            raise BzrCommandError("export format %r not supported" % format)
 
108
        exporter(self, dest, root)
 
109
 
 
110
 
274
111
 
275
112
class RevisionTree(Tree):
276
113
    """Tree viewing a previous revision.
277
114
 
278
115
    File text can be retrieved from the text store.
279
116
 
280
 
    :todo: Some kind of `__repr__` method, but a good one
 
117
    TODO: Some kind of `__repr__` method, but a good one
281
118
           probably means knowing the branch and revision number,
282
119
           or at least passing a description to the constructor.
283
120
    """
290
127
        ie = self._inventory[file_id]
291
128
        f = self._store[ie.text_id]
292
129
        mutter("  get fileid{%s} from %r" % (file_id, self))
293
 
        fs = filesize(f)
294
 
        if ie.text_size is None:
295
 
            note("warning: no text size recorded on %r" % ie)
296
130
        self._check_retrieved(ie, f)
297
131
        return f
298
132
 
301
135
 
302
136
    def get_file_sha1(self, file_id):
303
137
        ie = self._inventory[file_id]
304
 
        return ie.text_sha1
 
138
        if ie.kind == "file":
 
139
            return ie.text_sha1
305
140
 
306
141
    def has_filename(self, filename):
307
142
        return bool(self.inventory.path2id(filename))
323
158
        if False:  # just to make it a generator
324
159
            yield None
325
160
    
 
161
    def __contains__(self, file_id):
 
162
        return file_id in self._inventory
 
163
 
 
164
    def get_file_sha1(self, file_id):
 
165
        assert self._inventory[file_id].kind == "root_directory"
 
166
        return None
 
167
 
 
168
 
326
169
 
327
170
 
328
171
######################################################################
380
223
 
381
224
    
382
225
 
 
226
def find_renames(old_inv, new_inv):
 
227
    for file_id in old_inv:
 
228
        if file_id not in new_inv:
 
229
            continue
 
230
        old_name = old_inv.id2path(file_id)
 
231
        new_name = new_inv.id2path(file_id)
 
232
        if old_name != new_name:
 
233
            yield (old_name, new_name)
 
234
            
 
235
 
 
236
 
 
237
######################################################################
 
238
# export
 
239
 
 
240
def dir_exporter(tree, dest, root):
 
241
    """Export this tree to a new directory.
 
242
 
 
243
    `dest` should not exist, and will be created holding the
 
244
    contents of this tree.
 
245
 
 
246
    TODO: To handle subdirectories we need to create the
 
247
           directories first.
 
248
 
 
249
    :note: If the export fails, the destination directory will be
 
250
           left in a half-assed state.
 
251
    """
 
252
    import os
 
253
    os.mkdir(dest)
 
254
    mutter('export version %r' % tree)
 
255
    inv = tree.inventory
 
256
    for dp, ie in inv.iter_entries():
 
257
        kind = ie.kind
 
258
        fullpath = appendpath(dest, dp)
 
259
        if kind == 'directory':
 
260
            os.mkdir(fullpath)
 
261
        elif kind == 'file':
 
262
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
 
263
        else:
 
264
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
 
265
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
266
exporters['dir'] = dir_exporter
 
267
 
 
268
try:
 
269
    import tarfile
 
270
except ImportError:
 
271
    pass
 
272
else:
 
273
    def get_root_name(dest):
 
274
        """Get just the root name for a tarball.
 
275
 
 
276
        >>> get_root_name('mytar.tar')
 
277
        'mytar'
 
278
        >>> get_root_name('mytar.tar.bz2')
 
279
        'mytar'
 
280
        >>> get_root_name('tar.tar.tar.tgz')
 
281
        'tar.tar.tar'
 
282
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
283
        'bzr-0.0.5'
 
284
        >>> get_root_name('a/long/path/mytar.tgz')
 
285
        'mytar'
 
286
        >>> get_root_name('../parent/../dir/other.tbz2')
 
287
        'other'
 
288
        """
 
289
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
290
        dest = os.path.basename(dest)
 
291
        for end in endings:
 
292
            if dest.endswith(end):
 
293
                return dest[:-len(end)]
 
294
 
 
295
    def tar_exporter(tree, dest, root, compression=None):
 
296
        """Export this tree to a new tar file.
 
297
 
 
298
        `dest` will be created holding the contents of this tree; if it
 
299
        already exists, it will be clobbered, like with "tar -c".
 
300
        """
 
301
        from time import time
 
302
        now = time()
 
303
        compression = str(compression or '')
 
304
        if root is None:
 
305
            root = get_root_name(dest)
 
306
        try:
 
307
            ball = tarfile.open(dest, 'w:' + compression)
 
308
        except tarfile.CompressionError, e:
 
309
            raise BzrError(str(e))
 
310
        mutter('export version %r' % tree)
 
311
        inv = tree.inventory
 
312
        for dp, ie in inv.iter_entries():
 
313
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
314
            item = tarfile.TarInfo(os.path.join(root, dp))
 
315
            # TODO: would be cool to actually set it to the timestamp of the
 
316
            # revision it was last changed
 
317
            item.mtime = now
 
318
            if ie.kind == 'directory':
 
319
                item.type = tarfile.DIRTYPE
 
320
                fileobj = None
 
321
                item.name += '/'
 
322
                item.size = 0
 
323
                item.mode = 0755
 
324
            elif ie.kind == 'file':
 
325
                item.type = tarfile.REGTYPE
 
326
                fileobj = tree.get_file(ie.file_id)
 
327
                item.size = _find_file_size(fileobj)
 
328
                item.mode = 0644
 
329
            else:
 
330
                raise BzrError("don't know how to export {%s} of kind %r" %
 
331
                        (ie.file_id, ie.kind))
 
332
 
 
333
            ball.addfile(item, fileobj)
 
334
        ball.close()
 
335
    exporters['tar'] = tar_exporter
 
336
 
 
337
    def tgz_exporter(tree, dest, root):
 
338
        tar_exporter(tree, dest, root, compression='gz')
 
339
    exporters['tgz'] = tgz_exporter
 
340
 
 
341
    def tbz_exporter(tree, dest, root):
 
342
        tar_exporter(tree, dest, root, compression='bz2')
 
343
    exporters['tbz2'] = tbz_exporter
 
344
 
 
345
 
 
346
def _find_file_size(fileobj):
 
347
    offset = fileobj.tell()
 
348
    try:
 
349
        fileobj.seek(0, 2)
 
350
        size = fileobj.tell()
 
351
    except TypeError:
 
352
        # gzip doesn't accept second argument to seek()
 
353
        fileobj.seek(0)
 
354
        size = 0
 
355
        while True:
 
356
            nread = len(fileobj.read())
 
357
            if nread == 0:
 
358
                break
 
359
            size += nread
 
360
    fileobj.seek(offset)
 
361
    return size