~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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