~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-07-06 05:24:29 UTC
  • Revision ID: mbp@sourcefrog.net-20050706052429-2b1f11b4fc99a62f
- workaround for flaky TestLoader in python2.3
  
  Now we just list all the test classes manually -- a bit of a pain, but does
  mean we can run the simpler tests first.

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