~bzr-pqm/bzr/bzr.dev

70 by mbp at sourcefrog
Prepare for smart recursive add.
1
# Copyright (C) 2005 Canonical Ltd
1 by mbp at sourcefrog
import from baz patch-364
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
"""Tree classes, representing directory at point in time.
18
"""
19
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
20
import os
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
21
from cStringIO import StringIO
800 by Martin Pool
Merge John's import-speedup branch:
22
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
23
import bzrlib
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
24
from bzrlib.trace import mutter, note
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
25
from bzrlib.errors import BzrError, BzrCheckError
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
26
from bzrlib.inventory import Inventory
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
27
from bzrlib.osutils import appendpath, fingerprint_file
1 by mbp at sourcefrog
import from baz patch-364
28
29
678 by Martin Pool
- export to tarballs
30
exporters = {}
31
558 by Martin Pool
- All top-level classes inherit from object
32
class Tree(object):
1 by mbp at sourcefrog
import from baz patch-364
33
    """Abstract file tree.
34
35
    There are several subclasses:
36
    
37
    * `WorkingTree` exists as files on disk editable by the user.
38
39
    * `RevisionTree` is a tree as recorded at some point in the past.
40
41
    * `EmptyTree`
42
43
    Trees contain an `Inventory` object, and also know how to retrieve
44
    file texts mentioned in the inventory, either from a working
45
    directory or from a store.
46
47
    It is possible for trees to contain files that are not described
48
    in their inventory or vice versa; for this use `filenames()`.
49
50
    Trees can be compared, etc, regardless of whether they are working
51
    trees or versioned trees.
52
    """
53
    
54
    def has_filename(self, filename):
55
        """True if the tree has given filename."""
56
        raise NotImplementedError()
57
58
    def has_id(self, file_id):
59
        return self.inventory.has_id(file_id)
60
462 by Martin Pool
- New form 'file_id in tree' to check if the file is present
61
    __contains__ = has_id
62
63
    def __iter__(self):
64
        return iter(self.inventory)
65
1 by mbp at sourcefrog
import from baz patch-364
66
    def id2path(self, file_id):
67
        return self.inventory.id2path(file_id)
68
69
    def _get_inventory(self):
70
        return self._inventory
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
71
    
72
    def get_file_by_path(self, path):
73
        return self.get_file(self._inventory.path2id(path))
1 by mbp at sourcefrog
import from baz patch-364
74
75
    inventory = property(_get_inventory,
76
                         doc="Inventory of this Tree")
77
78
    def _check_retrieved(self, ie, f):
1364 by Martin Pool
- remove extra verification of files retrieved from tree
79
        if not __debug__:
80
            return  
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
81
        fp = fingerprint_file(f)
82
        f.seek(0)
83
        
184 by mbp at sourcefrog
pychecker fixups
84
        if ie.text_size != None:
131 by mbp at sourcefrog
check size and sha1 of files retrieved from the tree
85
            if ie.text_size != fp['size']:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
86
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
1 by mbp at sourcefrog
import from baz patch-364
87
                        ["inventory expects %d bytes" % ie.text_size,
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
88
                         "file is actually %d bytes" % fp['size'],
1 by mbp at sourcefrog
import from baz patch-364
89
                         "store is probably damaged/corrupt"])
90
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
91
        if ie.text_sha1 != fp['sha1']:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
92
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
1 by mbp at sourcefrog
import from baz patch-364
93
                    ["inventory expects %s" % ie.text_sha1,
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
94
                     "file is actually %s" % fp['sha1'],
1 by mbp at sourcefrog
import from baz patch-364
95
                     "store is probably damaged/corrupt"])
96
97
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
98
    def print_file(self, file_id):
99
        """Print file with id `file_id` to stdout."""
176 by mbp at sourcefrog
New cat command contributed by janmar.
100
        import sys
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
101
        sys.stdout.write(self.get_file_text(file_id))
176 by mbp at sourcefrog
New cat command contributed by janmar.
102
        
103
        
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
104
    def export(self, dest, format='dir', root=None):
678 by Martin Pool
- export to tarballs
105
        """Export this tree."""
106
        try:
107
            exporter = exporters[format]
108
        except KeyError:
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
109
            from bzrlib.errors import BzrCommandError
678 by Martin Pool
- export to tarballs
110
            raise BzrCommandError("export format %r not supported" % format)
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
111
        exporter(self, dest, root)
1 by mbp at sourcefrog
import from baz patch-364
112
113
114
115
class RevisionTree(Tree):
116
    """Tree viewing a previous revision.
117
118
    File text can be retrieved from the text store.
119
254 by Martin Pool
- Doc cleanups from Magnus Therning
120
    TODO: Some kind of `__repr__` method, but a good one
1 by mbp at sourcefrog
import from baz patch-364
121
           probably means knowing the branch and revision number,
122
           or at least passing a description to the constructor.
123
    """
124
    
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
125
    def __init__(self, weave_store, inv, revision_id):
126
        self._weave_store = weave_store
1 by mbp at sourcefrog
import from baz patch-364
127
        self._inventory = inv
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
128
        self._revision_id = revision_id
129
1210 by Martin Pool
- get correct old file version in RevisionTree
130
    def get_weave(self, file_id):
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
131
        # FIXME: RevisionTree should be given a branch
132
        # not a store, or the store should know the branch.
133
        import bzrlib.transactions as transactions
134
        return self._weave_store.get_weave(file_id,
135
            transactions.PassThroughTransaction())
1369 by Martin Pool
- try to avoid redundant conversion of strings when retrieving from weaves
136
137
138
    def get_file_lines(self, file_id):
139
        ie = self._inventory[file_id]
140
        weave = self.get_weave(file_id)
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
141
        return weave.get(ie.revision)
1210 by Martin Pool
- get correct old file version in RevisionTree
142
        
143
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
144
    def get_file_text(self, file_id):
1369 by Martin Pool
- try to avoid redundant conversion of strings when retrieving from weaves
145
        return ''.join(self.get_file_lines(file_id))
146
1 by mbp at sourcefrog
import from baz patch-364
147
148
    def get_file(self, file_id):
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
149
        return StringIO(self.get_file_text(file_id))
1 by mbp at sourcefrog
import from baz patch-364
150
151
    def get_file_size(self, file_id):
152
        return self._inventory[file_id].text_size
153
154
    def get_file_sha1(self, file_id):
155
        ie = self._inventory[file_id]
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
156
        if ie.kind == "file":
157
            return ie.text_sha1
1 by mbp at sourcefrog
import from baz patch-364
158
1398 by Robert Collins
integrate in Gustavos x-bit patch
159
    def is_executable(self, file_id):
160
        return self._inventory[file_id].executable
161
1 by mbp at sourcefrog
import from baz patch-364
162
    def has_filename(self, filename):
163
        return bool(self.inventory.path2id(filename))
164
165
    def list_files(self):
166
        # The only files returned by this are those from the version
167
        for path, entry in self.inventory.iter_entries():
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
168
            yield path, 'V', entry.kind, entry.file_id, entry
1 by mbp at sourcefrog
import from baz patch-364
169
1092.2.6 by Robert Collins
symlink support updated to work
170
    def get_symlink_target(self, file_id):
171
        ie = self._inventory[file_id]
172
        return ie.symlink_target;
1 by mbp at sourcefrog
import from baz patch-364
173
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
174
1 by mbp at sourcefrog
import from baz patch-364
175
class EmptyTree(Tree):
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
176
    def __init__(self):
177
        self._inventory = Inventory()
1 by mbp at sourcefrog
import from baz patch-364
178
1092.2.6 by Robert Collins
symlink support updated to work
179
    def get_symlink_target(self, file_id):
180
        return None
181
1 by mbp at sourcefrog
import from baz patch-364
182
    def has_filename(self, filename):
183
        return False
184
185
    def list_files(self):
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
186
        return iter([])
1 by mbp at sourcefrog
import from baz patch-364
187
    
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
188
    def __contains__(self, file_id):
189
        return file_id in self._inventory
190
974.1.14 by aaron.bentley at utoronto
Fixed bugs in merge optimization
191
    def get_file_sha1(self, file_id):
192
        assert self._inventory[file_id].kind == "root_directory"
193
        return None
194
195
1 by mbp at sourcefrog
import from baz patch-364
196
######################################################################
197
# diff
198
199
# TODO: Merge these two functions into a single one that can operate
200
# on either a whole tree or a set of files.
201
202
# TODO: Return the diff in order by filename, not by category or in
203
# random order.  Can probably be done by lock-stepping through the
204
# filenames from both trees.
205
206
207
def file_status(filename, old_tree, new_tree):
208
    """Return single-letter status, old and new names for a file.
209
210
    The complexity here is in deciding how to represent renames;
211
    many complex cases are possible.
212
    """
213
    old_inv = old_tree.inventory
214
    new_inv = new_tree.inventory
215
    new_id = new_inv.path2id(filename)
216
    old_id = old_inv.path2id(filename)
217
218
    if not new_id and not old_id:
219
        # easy: doesn't exist in either; not versioned at all
220
        if new_tree.is_ignored(filename):
221
            return 'I', None, None
222
        else:
223
            return '?', None, None
224
    elif new_id:
225
        # There is now a file of this name, great.
226
        pass
227
    else:
228
        # There is no longer a file of this name, but we can describe
229
        # what happened to the file that used to have
230
        # this name.  There are two possibilities: either it was
231
        # deleted entirely, or renamed.
232
        assert old_id
233
        if new_inv.has_id(old_id):
234
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
235
        else:
236
            return 'D', old_inv.id2path(old_id), None
237
238
    # if the file_id is new in this revision, it is added
239
    if new_id and not old_inv.has_id(new_id):
240
        return 'A'
241
242
    # if there used to be a file of this name, but that ID has now
243
    # disappeared, it is deleted
244
    if old_id and not new_inv.has_id(old_id):
245
        return 'D'
246
247
    return 'wtf?'
248
249
    
250
164 by mbp at sourcefrog
new 'renames' command
251
def find_renames(old_inv, new_inv):
252
    for file_id in old_inv:
253
        if file_id not in new_inv:
254
            continue
255
        old_name = old_inv.id2path(file_id)
256
        new_name = new_inv.id2path(file_id)
257
        if old_name != new_name:
258
            yield (old_name, new_name)
259
            
678 by Martin Pool
- export to tarballs
260
261
262
######################################################################
263
# export
264
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
265
def dir_exporter(tree, dest, root):
678 by Martin Pool
- export to tarballs
266
    """Export this tree to a new directory.
267
268
    `dest` should not exist, and will be created holding the
269
    contents of this tree.
270
271
    TODO: To handle subdirectories we need to create the
272
           directories first.
273
274
    :note: If the export fails, the destination directory will be
275
           left in a half-assed state.
276
    """
800 by Martin Pool
Merge John's import-speedup branch:
277
    import os
678 by Martin Pool
- export to tarballs
278
    os.mkdir(dest)
279
    mutter('export version %r' % tree)
280
    inv = tree.inventory
281
    for dp, ie in inv.iter_entries():
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
282
        ie.put_on_disk(dest, dp, tree)
283
678 by Martin Pool
- export to tarballs
284
exporters['dir'] = dir_exporter
285
286
try:
287
    import tarfile
288
except ImportError:
289
    pass
290
else:
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
291
    def get_root_name(dest):
292
        """Get just the root name for a tarball.
293
294
        >>> get_root_name('mytar.tar')
295
        'mytar'
296
        >>> get_root_name('mytar.tar.bz2')
297
        'mytar'
298
        >>> get_root_name('tar.tar.tar.tgz')
299
        'tar.tar.tar'
300
        >>> get_root_name('bzr-0.0.5.tar.gz')
301
        'bzr-0.0.5'
302
        >>> get_root_name('a/long/path/mytar.tgz')
303
        'mytar'
304
        >>> get_root_name('../parent/../dir/other.tbz2')
305
        'other'
306
        """
307
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
308
        dest = os.path.basename(dest)
309
        for end in endings:
310
            if dest.endswith(end):
311
                return dest[:-len(end)]
312
313
    def tar_exporter(tree, dest, root, compression=None):
678 by Martin Pool
- export to tarballs
314
        """Export this tree to a new tar file.
315
316
        `dest` will be created holding the contents of this tree; if it
317
        already exists, it will be clobbered, like with "tar -c".
318
        """
800 by Martin Pool
Merge John's import-speedup branch:
319
        from time import time
320
        now = time()
678 by Martin Pool
- export to tarballs
321
        compression = str(compression or '')
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
322
        if root is None:
323
            root = get_root_name(dest)
678 by Martin Pool
- export to tarballs
324
        try:
325
            ball = tarfile.open(dest, 'w:' + compression)
326
        except tarfile.CompressionError, e:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
327
            raise BzrError(str(e))
678 by Martin Pool
- export to tarballs
328
        mutter('export version %r' % tree)
329
        inv = tree.inventory
330
        for dp, ie in inv.iter_entries():
331
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
332
            item, fileobj = ie.get_tar_item(root, dp, now, tree)
678 by Martin Pool
- export to tarballs
333
            ball.addfile(item, fileobj)
334
        ball.close()
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
335
678 by Martin Pool
- export to tarballs
336
    exporters['tar'] = tar_exporter
337
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
338
    def tgz_exporter(tree, dest, root):
339
        tar_exporter(tree, dest, root, compression='gz')
678 by Martin Pool
- export to tarballs
340
    exporters['tgz'] = tgz_exporter
341
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
342
    def tbz_exporter(tree, dest, root):
343
        tar_exporter(tree, dest, root, compression='bz2')
678 by Martin Pool
- export to tarballs
344
    exporters['tbz2'] = tbz_exporter