~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-06-27 05:03:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050627050327-026aa1d4693cf62a
- rsync upload/download plugins from John A Meinel

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
import os
21
 
from cStringIO import StringIO
 
20
from sets import Set
 
21
import os.path, os, fnmatch, time
 
22
 
 
23
from osutils import pumpfile, filesize, quotefn, sha_file, \
 
24
     joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
 
25
import errno
 
26
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
 
27
 
 
28
from bzrlib.inventory import Inventory
 
29
from bzrlib.trace import mutter, note
 
30
from bzrlib.errors import BzrError
 
31
import branch
22
32
 
23
33
import bzrlib
24
 
from bzrlib.trace import mutter, note
25
 
from bzrlib.errors import BzrError, BzrCheckError
26
 
from bzrlib.inventory import Inventory
27
 
from bzrlib.osutils import appendpath, fingerprint_file
 
34
 
 
35
exporters = {}
28
36
 
29
37
class Tree(object):
30
38
    """Abstract file tree.
55
63
    def has_id(self, file_id):
56
64
        return self.inventory.has_id(file_id)
57
65
 
58
 
    def has_or_had_id(self, file_id):
59
 
        if file_id == self.inventory.root.file_id:
60
 
            return True
61
 
        return self.inventory.has_id(file_id)
62
 
 
63
66
    __contains__ = has_id
64
67
 
65
68
    def __iter__(self):
68
71
    def id2path(self, file_id):
69
72
        return self.inventory.id2path(file_id)
70
73
 
71
 
    def kind(self, file_id):
72
 
        raise NotImplementedError("subclasses must implement kind")
73
 
 
74
74
    def _get_inventory(self):
75
75
        return self._inventory
76
 
    
77
 
    def get_file_by_path(self, path):
78
 
        return self.get_file(self._inventory.path2id(path))
79
76
 
80
77
    inventory = property(_get_inventory,
81
78
                         doc="Inventory of this Tree")
82
79
 
83
80
    def _check_retrieved(self, ie, f):
84
 
        if not __debug__:
85
 
            return  
86
81
        fp = fingerprint_file(f)
87
82
        f.seek(0)
88
83
        
100
95
                     "store is probably damaged/corrupt"])
101
96
 
102
97
 
103
 
    def print_file(self, file_id):
104
 
        """Print file with id `file_id` to stdout."""
 
98
    def print_file(self, fileid):
 
99
        """Print file with id `fileid` to stdout."""
105
100
        import sys
106
 
        sys.stdout.write(self.get_file_text(file_id))
107
 
        
108
 
        
 
101
        pumpfile(self.get_file(fileid), sys.stdout)
 
102
        
 
103
        
 
104
    def export(self, dest, format='dir'):
 
105
        """Export this tree."""
 
106
        try:
 
107
            exporter = exporters[format]
 
108
        except KeyError:
 
109
            raise BzrCommandError("export format %r not supported" % format)
 
110
        exporter(self, dest)
 
111
 
 
112
 
 
113
 
109
114
class RevisionTree(Tree):
110
115
    """Tree viewing a previous revision.
111
116
 
116
121
           or at least passing a description to the constructor.
117
122
    """
118
123
    
119
 
    def __init__(self, branch, inv, revision_id):
120
 
        self._branch = branch
121
 
        self._weave_store = branch.weave_store
 
124
    def __init__(self, store, inv):
 
125
        self._store = store
122
126
        self._inventory = inv
123
 
        self._revision_id = revision_id
124
 
 
125
 
    def get_weave(self, file_id):
126
 
        import bzrlib.transactions as transactions
127
 
        return self._weave_store.get_weave(file_id,
128
 
                self._branch.get_transaction())
129
 
 
130
 
    def get_weave_prelude(self, file_id):
131
 
        import bzrlib.transactions as transactions
132
 
        return self._weave_store.get_weave_prelude(file_id,
133
 
                self._branch.get_transaction())
134
 
 
135
 
    def get_file_lines(self, file_id):
136
 
        ie = self._inventory[file_id]
137
 
        weave = self.get_weave(file_id)
138
 
        return weave.get(ie.revision)
139
 
 
140
 
    def get_file_text(self, file_id):
141
 
        return ''.join(self.get_file_lines(file_id))
142
127
 
143
128
    def get_file(self, file_id):
144
 
        return StringIO(self.get_file_text(file_id))
 
129
        ie = self._inventory[file_id]
 
130
        f = self._store[ie.text_id]
 
131
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
132
        self._check_retrieved(ie, f)
 
133
        return f
145
134
 
146
135
    def get_file_size(self, file_id):
147
136
        return self._inventory[file_id].text_size
148
137
 
149
138
    def get_file_sha1(self, file_id):
150
139
        ie = self._inventory[file_id]
151
 
        if ie.kind == "file":
152
 
            return ie.text_sha1
153
 
 
154
 
    def is_executable(self, file_id):
155
 
        ie = self._inventory[file_id]
156
 
        if ie.kind != "file":
157
 
            return None 
158
 
        return self._inventory[file_id].executable
 
140
        return ie.text_sha1
159
141
 
160
142
    def has_filename(self, filename):
161
143
        return bool(self.inventory.path2id(filename))
163
145
    def list_files(self):
164
146
        # The only files returned by this are those from the version
165
147
        for path, entry in self.inventory.iter_entries():
166
 
            yield path, 'V', entry.kind, entry.file_id, entry
167
 
 
168
 
    def get_symlink_target(self, file_id):
169
 
        ie = self._inventory[file_id]
170
 
        return ie.symlink_target;
171
 
 
172
 
    def kind(self, file_id):
173
 
        return self._inventory[file_id].kind
 
148
            yield path, 'V', entry.kind, entry.file_id
174
149
 
175
150
 
176
151
class EmptyTree(Tree):
177
152
    def __init__(self):
178
153
        self._inventory = Inventory()
179
154
 
180
 
    def get_symlink_target(self, file_id):
181
 
        return None
182
 
 
183
155
    def has_filename(self, filename):
184
156
        return False
185
157
 
186
 
    def kind(self, file_id):
187
 
        assert self._inventory[file_id].kind == "root_directory"
188
 
        return "root_directory"
189
 
 
190
158
    def list_files(self):
191
 
        return iter([])
 
159
        if False:  # just to make it a generator
 
160
            yield None
192
161
    
193
 
    def __contains__(self, file_id):
194
 
        return file_id in self._inventory
195
 
 
196
 
    def get_file_sha1(self, file_id):
197
 
        assert self._inventory[file_id].kind == "root_directory"
198
 
        return None
199
162
 
200
163
 
201
164
######################################################################
264
227
            
265
228
 
266
229
 
 
230
######################################################################
 
231
# export
 
232
 
 
233
def dir_exporter(tree, dest):
 
234
    """Export this tree to a new directory.
 
235
 
 
236
    `dest` should not exist, and will be created holding the
 
237
    contents of this tree.
 
238
 
 
239
    TODO: To handle subdirectories we need to create the
 
240
           directories first.
 
241
 
 
242
    :note: If the export fails, the destination directory will be
 
243
           left in a half-assed state.
 
244
    """
 
245
    os.mkdir(dest)
 
246
    mutter('export version %r' % tree)
 
247
    inv = tree.inventory
 
248
    for dp, ie in inv.iter_entries():
 
249
        kind = ie.kind
 
250
        fullpath = appendpath(dest, dp)
 
251
        if kind == 'directory':
 
252
            os.mkdir(fullpath)
 
253
        elif kind == 'file':
 
254
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
 
255
        else:
 
256
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
 
257
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
258
exporters['dir'] = dir_exporter
 
259
 
 
260
try:
 
261
    import tarfile
 
262
except ImportError:
 
263
    pass
 
264
else:
 
265
    def tar_exporter(tree, dest, compression=None):
 
266
        """Export this tree to a new tar file.
 
267
 
 
268
        `dest` will be created holding the contents of this tree; if it
 
269
        already exists, it will be clobbered, like with "tar -c".
 
270
        """
 
271
        now = time.time()
 
272
        compression = str(compression or '')
 
273
        try:
 
274
            ball = tarfile.open(dest, 'w:' + compression)
 
275
        except tarfile.CompressionError, e:
 
276
            raise BzrError(str(e))
 
277
        mutter('export version %r' % tree)
 
278
        inv = tree.inventory
 
279
        for dp, ie in inv.iter_entries():
 
280
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
281
            item = tarfile.TarInfo(dp)
 
282
            # TODO: would be cool to actually set it to the timestamp of the
 
283
            # revision it was last changed
 
284
            item.mtime = now
 
285
            if ie.kind == 'directory':
 
286
                item.type = tarfile.DIRTYPE
 
287
                fileobj = None
 
288
                item.name += '/'
 
289
                item.size = 0
 
290
                item.mode = 0755
 
291
            elif ie.kind == 'file':
 
292
                item.type = tarfile.REGTYPE
 
293
                fileobj = tree.get_file(ie.file_id)
 
294
                item.size = _find_file_size(fileobj)
 
295
                item.mode = 0644
 
296
            else:
 
297
                raise BzrError("don't know how to export {%s} of kind %r" %
 
298
                        (ie.file_id, ie.kind))
 
299
 
 
300
            ball.addfile(item, fileobj)
 
301
        ball.close()
 
302
    exporters['tar'] = tar_exporter
 
303
 
 
304
    def tgz_exporter(tree, dest):
 
305
        tar_exporter(tree, dest, compression='gz')
 
306
    exporters['tgz'] = tgz_exporter
 
307
 
 
308
    def tbz_exporter(tree, dest):
 
309
        tar_exporter(tree, dest, compression='bz2')
 
310
    exporters['tbz2'] = tbz_exporter
 
311
 
 
312
 
 
313
def _find_file_size(fileobj):
 
314
    offset = fileobj.tell()
 
315
    try:
 
316
        fileobj.seek(0, 2)
 
317
        size = fileobj.tell()
 
318
    except TypeError:
 
319
        # gzip doesn't accept second argument to seek()
 
320
        fileobj.seek(0)
 
321
        size = 0
 
322
        while True:
 
323
            nread = len(fileobj.read())
 
324
            if nread == 0:
 
325
                break
 
326
            size += nread
 
327
    fileobj.seek(offset)
 
328
    return size