~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-03-14 04:35:14 UTC
  • Revision ID: mbp@sourcefrog.net-20050314043514-08ebd6f07d26d7e1
human-assigned revision ids?

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
17
18
"""Tree classes, representing directory at point in time.
18
19
"""
19
20
 
20
 
from osutils import pumpfile, appendpath, fingerprint_file
21
 
import os
 
21
from sets import Set
 
22
import os.path, os, fnmatch
22
23
 
23
 
from bzrlib.trace import mutter, note
24
 
from bzrlib.errors import BzrError
 
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
25
31
 
26
32
import bzrlib
27
33
 
28
 
exporters = {}
29
 
 
30
 
class Tree(object):
 
34
class Tree:
31
35
    """Abstract file tree.
32
36
 
33
37
    There are several subclasses:
56
60
    def has_id(self, file_id):
57
61
        return self.inventory.has_id(file_id)
58
62
 
59
 
    __contains__ = has_id
60
 
 
61
 
    def __iter__(self):
62
 
        return iter(self.inventory)
 
63
    def id_set(self):
 
64
        """Return set of all ids in this tree."""
 
65
        return self.inventory.id_set()
63
66
 
64
67
    def id2path(self, file_id):
65
68
        return self.inventory.id2path(file_id)
71
74
                         doc="Inventory of this Tree")
72
75
 
73
76
    def _check_retrieved(self, ie, f):
74
 
        fp = fingerprint_file(f)
75
 
        f.seek(0)
76
 
        
77
 
        if ie.text_size != None:
78
 
            if ie.text_size != fp['size']:
79
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
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),
80
82
                        ["inventory expects %d bytes" % ie.text_size,
81
 
                         "file is actually %d bytes" % fp['size'],
 
83
                         "file is actually %d bytes" % fs,
82
84
                         "store is probably damaged/corrupt"])
83
85
 
84
 
        if ie.text_sha1 != fp['sha1']:
85
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
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),
86
90
                    ["inventory expects %s" % ie.text_sha1,
87
 
                     "file is actually %s" % fp['sha1'],
 
91
                     "file is actually %s" % f_hash,
88
92
                     "store is probably damaged/corrupt"])
89
93
 
90
94
 
91
 
    def print_file(self, fileid):
92
 
        """Print file with id `fileid` to stdout."""
93
 
        import sys
94
 
        pumpfile(self.get_file(fileid), sys.stdout)
95
 
        
96
 
        
97
 
    def export(self, dest, format='dir', root=None):
98
 
        """Export this tree."""
99
 
        try:
100
 
            exporter = exporters[format]
101
 
        except KeyError:
102
 
            from bzrlib.errors import BzrCommandError
103
 
            raise BzrCommandError("export format %r not supported" % format)
104
 
        exporter(self, dest, root)
105
 
 
106
 
 
 
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
        
107
294
 
108
295
class RevisionTree(Tree):
109
296
    """Tree viewing a previous revision.
110
297
 
111
298
    File text can be retrieved from the text store.
112
299
 
113
 
    TODO: Some kind of `__repr__` method, but a good one
 
300
    :todo: Some kind of `__repr__` method, but a good one
114
301
           probably means knowing the branch and revision number,
115
302
           or at least passing a description to the constructor.
116
303
    """
123
310
        ie = self._inventory[file_id]
124
311
        f = self._store[ie.text_id]
125
312
        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)
126
316
        self._check_retrieved(ie, f)
127
317
        return f
128
318
 
143
333
 
144
334
 
145
335
class EmptyTree(Tree):
146
 
    def __init__(self, root_id):
147
 
        from bzrlib.inventory import Inventory
148
 
        self._inventory = Inventory(root_id)
 
336
    def __init__(self):
 
337
        self._inventory = Inventory()
149
338
 
150
339
    def has_filename(self, filename):
151
340
        return False
211
400
 
212
401
    
213
402
 
214
 
def find_renames(old_inv, new_inv):
215
 
    for file_id in old_inv:
216
 
        if file_id not in new_inv:
217
 
            continue
218
 
        old_name = old_inv.id2path(file_id)
219
 
        new_name = new_inv.id2path(file_id)
220
 
        if old_name != new_name:
221
 
            yield (old_name, new_name)
222
 
            
223
 
 
224
 
 
225
 
######################################################################
226
 
# export
227
 
 
228
 
def dir_exporter(tree, dest, root):
229
 
    """Export this tree to a new directory.
230
 
 
231
 
    `dest` should not exist, and will be created holding the
232
 
    contents of this tree.
233
 
 
234
 
    TODO: To handle subdirectories we need to create the
235
 
           directories first.
236
 
 
237
 
    :note: If the export fails, the destination directory will be
238
 
           left in a half-assed state.
239
 
    """
240
 
    import os
241
 
    os.mkdir(dest)
242
 
    mutter('export version %r' % tree)
243
 
    inv = tree.inventory
244
 
    for dp, ie in inv.iter_entries():
245
 
        kind = ie.kind
246
 
        fullpath = appendpath(dest, dp)
247
 
        if kind == 'directory':
248
 
            os.mkdir(fullpath)
249
 
        elif kind == 'file':
250
 
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
251
 
        else:
252
 
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
253
 
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
254
 
exporters['dir'] = dir_exporter
255
 
 
256
 
try:
257
 
    import tarfile
258
 
except ImportError:
259
 
    pass
260
 
else:
261
 
    def get_root_name(dest):
262
 
        """Get just the root name for a tarball.
263
 
 
264
 
        >>> get_root_name('mytar.tar')
265
 
        'mytar'
266
 
        >>> get_root_name('mytar.tar.bz2')
267
 
        'mytar'
268
 
        >>> get_root_name('tar.tar.tar.tgz')
269
 
        'tar.tar.tar'
270
 
        >>> get_root_name('bzr-0.0.5.tar.gz')
271
 
        'bzr-0.0.5'
272
 
        >>> get_root_name('a/long/path/mytar.tgz')
273
 
        'mytar'
274
 
        >>> get_root_name('../parent/../dir/other.tbz2')
275
 
        'other'
276
 
        """
277
 
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
278
 
        dest = os.path.basename(dest)
279
 
        for end in endings:
280
 
            if dest.endswith(end):
281
 
                return dest[:-len(end)]
282
 
 
283
 
    def tar_exporter(tree, dest, root, compression=None):
284
 
        """Export this tree to a new tar file.
285
 
 
286
 
        `dest` will be created holding the contents of this tree; if it
287
 
        already exists, it will be clobbered, like with "tar -c".
288
 
        """
289
 
        from time import time
290
 
        now = time()
291
 
        compression = str(compression or '')
292
 
        if root is None:
293
 
            root = get_root_name(dest)
294
 
        try:
295
 
            ball = tarfile.open(dest, 'w:' + compression)
296
 
        except tarfile.CompressionError, e:
297
 
            raise BzrError(str(e))
298
 
        mutter('export version %r' % tree)
299
 
        inv = tree.inventory
300
 
        for dp, ie in inv.iter_entries():
301
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
302
 
            item = tarfile.TarInfo(os.path.join(root, dp))
303
 
            # TODO: would be cool to actually set it to the timestamp of the
304
 
            # revision it was last changed
305
 
            item.mtime = now
306
 
            if ie.kind == 'directory':
307
 
                item.type = tarfile.DIRTYPE
308
 
                fileobj = None
309
 
                item.name += '/'
310
 
                item.size = 0
311
 
                item.mode = 0755
312
 
            elif ie.kind == 'file':
313
 
                item.type = tarfile.REGTYPE
314
 
                fileobj = tree.get_file(ie.file_id)
315
 
                item.size = _find_file_size(fileobj)
316
 
                item.mode = 0644
317
 
            else:
318
 
                raise BzrError("don't know how to export {%s} of kind %r" %
319
 
                        (ie.file_id, ie.kind))
320
 
 
321
 
            ball.addfile(item, fileobj)
322
 
        ball.close()
323
 
    exporters['tar'] = tar_exporter
324
 
 
325
 
    def tgz_exporter(tree, dest, root):
326
 
        tar_exporter(tree, dest, root, compression='gz')
327
 
    exporters['tgz'] = tgz_exporter
328
 
 
329
 
    def tbz_exporter(tree, dest, root):
330
 
        tar_exporter(tree, dest, root, compression='bz2')
331
 
    exporters['tbz2'] = tbz_exporter
332
 
 
333
 
 
334
 
def _find_file_size(fileobj):
335
 
    offset = fileobj.tell()
336
 
    try:
337
 
        fileobj.seek(0, 2)
338
 
        size = fileobj.tell()
339
 
    except TypeError:
340
 
        # gzip doesn't accept second argument to seek()
341
 
        fileobj.seek(0)
342
 
        size = 0
343
 
        while True:
344
 
            nread = len(fileobj.read())
345
 
            if nread == 0:
346
 
                break
347
 
            size += nread
348
 
    fileobj.seek(offset)
349
 
    return size