← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 16:58:03 UTC
  • mfrom: (3224.3.1 news-typo)
  • Revision ID: pqm@pqm.ubuntu.com-20080316165803-tisoc9mpob9z544o
(Matt Nordhoff) Trivial NEWS typo fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import errno
19
 
from stat import S_ISREG, S_IEXEC
20
 
import time
 
19
from stat import S_ISREG
 
20
import tempfile
21
21
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    lazy_import,
25
 
    registry,
26
 
    trace,
27
 
    tree,
28
 
    )
29
 
lazy_import.lazy_import(globals(), """
30
 
from bzrlib import (
31
 
    annotate,
32
 
    bencode,
33
 
    controldir,
34
 
    commit,
35
 
    conflicts,
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
from bzrlib import (
 
25
    bzrdir,
36
26
    delta,
37
27
    errors,
38
 
    inventory,
39
 
    multiparent,
40
 
    osutils,
41
 
    revision as _mod_revision,
42
 
    ui,
43
 
    urlutils,
 
28
    inventory
44
29
    )
45
 
from bzrlib.i18n import gettext
46
30
""")
47
31
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
48
 
                           ReusingTransform, CantMoveRoot,
 
32
                           ReusingTransform, NotVersionedError, CantMoveRoot,
49
33
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
50
34
                           UnableCreateSymlink)
51
 
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
52
 
from bzrlib.osutils import (
53
 
    delete_any,
54
 
    file_kind,
55
 
    has_symlinks,
56
 
    pathjoin,
57
 
    sha_file,
58
 
    splitpath,
59
 
    supports_executable,
60
 
    )
61
 
from bzrlib.progress import ProgressPhase
 
35
from bzrlib.inventory import InventoryEntry
 
36
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
 
37
                            delete_any, has_symlinks)
 
38
from bzrlib.progress import DummyProgress, ProgressPhase
62
39
from bzrlib.symbol_versioning import (
63
 
    deprecated_function,
64
 
    deprecated_in,
65
 
    deprecated_method,
66
 
    )
 
40
        deprecated_function,
 
41
        zero_fifteen,
 
42
        zero_ninety,
 
43
        )
 
44
from bzrlib.trace import mutter, warning
 
45
from bzrlib import tree
 
46
import bzrlib.ui
 
47
import bzrlib.urlutils as urlutils
67
48
 
68
49
 
69
50
ROOT_PARENT = "root-parent"
70
51
 
 
52
 
71
53
def unique_add(map, key, value):
72
54
    if key in map:
73
55
        raise DuplicateKey(key=key)
74
56
    map[key] = value
75
57
 
76
58
 
77
 
 
78
59
class _TransformResults(object):
79
60
    def __init__(self, modified_paths, rename_count):
80
61
        object.__init__(self)
83
64
 
84
65
 
85
66
class TreeTransformBase(object):
86
 
    """The base class for TreeTransform and its kin."""
 
67
    """The base class for TreeTransform and TreeTransformBase"""
87
68
 
88
 
    def __init__(self, tree, pb=None,
 
69
    def __init__(self, tree, limbodir, pb=DummyProgress(),
89
70
                 case_sensitive=True):
90
71
        """Constructor.
91
72
 
92
73
        :param tree: The tree that will be transformed, but not necessarily
93
74
            the output tree.
94
 
        :param pb: ignored
 
75
        :param limbodir: A directory where new files can be stored until
 
76
            they are installed in their proper places
 
77
        :param pb: A ProgressBar indicating how much progress is being made
95
78
        :param case_sensitive: If True, the target of the transform is
96
79
            case sensitive, not just case preserving.
97
80
        """
98
81
        object.__init__(self)
99
82
        self._tree = tree
 
83
        self._limbodir = limbodir
 
84
        self._deletiondir = None
100
85
        self._id_number = 0
101
86
        # mapping of trans_id -> new basename
102
87
        self._new_name = {}
104
89
        self._new_parent = {}
105
90
        # mapping of trans_id with new contents -> new file_kind
106
91
        self._new_contents = {}
107
 
        # mapping of trans_id => (sha1 of content, stat_value)
108
 
        self._observed_sha1s = {}
 
92
        # A mapping of transform ids to their limbo filename
 
93
        self._limbo_files = {}
 
94
        # A mapping of transform ids to a set of the transform ids of children
 
95
        # that their limbo directory has
 
96
        self._limbo_children = {}
 
97
        # Map transform ids to maps of child filename to child transform id
 
98
        self._limbo_children_names = {}
 
99
        # List of transform ids that need to be renamed from limbo into place
 
100
        self._needs_rename = set()
109
101
        # Set of trans_ids whose contents will be removed
110
102
        self._removed_contents = set()
111
103
        # Mapping of trans_id -> new execute-bit value
118
110
        self._non_present_ids = {}
119
111
        # Mapping of new file_id -> trans_id
120
112
        self._r_new_id = {}
121
 
        # Set of trans_ids that will be removed
 
113
        # Set of file_ids that will be removed
122
114
        self._removed_id = set()
123
115
        # Mapping of path in old tree -> trans_id
124
116
        self._tree_path_ids = {}
125
117
        # Mapping trans_id -> path in old tree
126
118
        self._tree_id_paths = {}
 
119
        # Cache of realpath results, to speed up canonical_path
 
120
        self._realpaths = {}
 
121
        # Cache of relpath results, to speed up canonical_path
 
122
        self._relpaths = {}
127
123
        # The trans_id that will be used as the tree root
128
 
        root_id = tree.get_root_id()
129
 
        if root_id is not None:
130
 
            self._new_root = self.trans_id_tree_file_id(root_id)
131
 
        else:
132
 
            self._new_root = None
133
 
        # Indicator of whether the transform has been applied
 
124
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
 
125
        # Indictor of whether the transform has been applied
134
126
        self._done = False
135
127
        # A progress bar
136
128
        self._pb = pb
139
131
        # A counter of how many files have been renamed
140
132
        self.rename_count = 0
141
133
 
142
 
    def __enter__(self):
143
 
        """Support Context Manager API."""
144
 
        return self
145
 
 
146
 
    def __exit__(self, exc_type, exc_val, exc_tb):
147
 
        """Support Context Manager API."""
148
 
        self.finalize()
149
 
 
150
 
    def finalize(self):
151
 
        """Release the working tree lock, if held.
152
 
 
153
 
        This is required if apply has not been invoked, but can be invoked
154
 
        even after apply.
155
 
        """
156
 
        if self._tree is None:
157
 
            return
158
 
        self._tree.unlock()
159
 
        self._tree = None
160
 
 
161
134
    def __get_root(self):
162
135
        return self._new_root
163
136
 
164
137
    root = property(__get_root)
165
138
 
 
139
    def finalize(self):
 
140
        """Release the working tree lock, if held, clean up limbo dir.
 
141
 
 
142
        This is required if apply has not been invoked, but can be invoked
 
143
        even after apply.
 
144
        """
 
145
        if self._tree is None:
 
146
            return
 
147
        try:
 
148
            entries = [(self._limbo_name(t), t, k) for t, k in
 
149
                       self._new_contents.iteritems()]
 
150
            entries.sort(reverse=True)
 
151
            for path, trans_id, kind in entries:
 
152
                if kind == "directory":
 
153
                    os.rmdir(path)
 
154
                else:
 
155
                    os.unlink(path)
 
156
            try:
 
157
                os.rmdir(self._limbodir)
 
158
            except OSError:
 
159
                # We don't especially care *why* the dir is immortal.
 
160
                raise ImmortalLimbo(self._limbodir)
 
161
            try:
 
162
                if self._deletiondir is not None:
 
163
                    os.rmdir(self._deletiondir)
 
164
            except OSError:
 
165
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
166
        finally:
 
167
            self._tree.unlock()
 
168
            self._tree = None
 
169
 
166
170
    def _assign_id(self):
167
171
        """Produce a new tranform id"""
168
172
        new_id = "new-%s" % self._id_number
178
182
 
179
183
    def adjust_path(self, name, parent, trans_id):
180
184
        """Change the path that is assigned to a transaction id."""
181
 
        if parent is None:
182
 
            raise ValueError("Parent trans-id may not be None")
183
185
        if trans_id == self._new_root:
184
186
            raise CantMoveRoot
 
187
        previous_parent = self._new_parent.get(trans_id)
 
188
        previous_name = self._new_name.get(trans_id)
185
189
        self._new_name[trans_id] = name
186
190
        self._new_parent[trans_id] = parent
 
191
        if (trans_id in self._limbo_files and
 
192
            trans_id not in self._needs_rename):
 
193
            self._rename_in_limbo([trans_id])
 
194
            self._limbo_children[previous_parent].remove(trans_id)
 
195
            del self._limbo_children_names[previous_parent][previous_name]
 
196
 
 
197
    def _rename_in_limbo(self, trans_ids):
 
198
        """Fix limbo names so that the right final path is produced.
 
199
 
 
200
        This means we outsmarted ourselves-- we tried to avoid renaming
 
201
        these files later by creating them with their final names in their
 
202
        final parents.  But now the previous name or parent is no longer
 
203
        suitable, so we have to rename them.
 
204
 
 
205
        Even for trans_ids that have no new contents, we must remove their
 
206
        entries from _limbo_files, because they are now stale.
 
207
        """
 
208
        for trans_id in trans_ids:
 
209
            old_path = self._limbo_files.pop(trans_id)
 
210
            if trans_id not in self._new_contents:
 
211
                continue
 
212
            new_path = self._limbo_name(trans_id)
 
213
            os.rename(old_path, new_path)
187
214
 
188
215
    def adjust_root_path(self, name, parent):
189
216
        """Emulate moving the root by moving all children, instead.
190
 
 
 
217
        
191
218
        We do this by undoing the association of root's transaction id with the
192
219
        current tree.  This allows us to create a new directory with that
193
 
        transaction id.  We unversion the root directory and version the
 
220
        transaction id.  We unversion the root directory and version the 
194
221
        physically new directory, and hope someone versions the tree root
195
222
        later.
196
223
        """
199
226
        # force moving all children of root
200
227
        for child_id in self.iter_tree_children(old_root):
201
228
            if child_id != parent:
202
 
                self.adjust_path(self.final_name(child_id),
 
229
                self.adjust_path(self.final_name(child_id), 
203
230
                                 self.final_parent(child_id), child_id)
204
231
            file_id = self.final_file_id(child_id)
205
232
            if file_id is not None:
206
233
                self.unversion_file(child_id)
207
234
            self.version_file(file_id, child_id)
208
 
 
 
235
        
209
236
        # the physical root needs a new transaction id
210
237
        self._tree_path_ids.pop("")
211
238
        self._tree_id_paths.pop(old_root)
217
244
        self.version_file(old_root_file_id, old_root)
218
245
        self.unversion_file(self._new_root)
219
246
 
220
 
    def fixup_new_roots(self):
221
 
        """Reinterpret requests to change the root directory
222
 
 
223
 
        Instead of creating a root directory, or moving an existing directory,
224
 
        all the attributes and children of the new root are applied to the
225
 
        existing root directory.
226
 
 
227
 
        This means that the old root trans-id becomes obsolete, so it is
228
 
        recommended only to invoke this after the root trans-id has become
229
 
        irrelevant.
230
 
 
231
 
        """
232
 
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
233
 
                     ROOT_PARENT]
234
 
        if len(new_roots) < 1:
235
 
            return
236
 
        if len(new_roots) != 1:
237
 
            raise ValueError('A tree cannot have two roots!')
238
 
        if self._new_root is None:
239
 
            self._new_root = new_roots[0]
240
 
            return
241
 
        old_new_root = new_roots[0]
242
 
        # unversion the new root's directory.
243
 
        if self.final_kind(self._new_root) is None:
244
 
            file_id = self.final_file_id(old_new_root)
245
 
        else:
246
 
            file_id = self.final_file_id(self._new_root)
247
 
        if old_new_root in self._new_id:
248
 
            self.cancel_versioning(old_new_root)
249
 
        else:
250
 
            self.unversion_file(old_new_root)
251
 
        # if, at this stage, root still has an old file_id, zap it so we can
252
 
        # stick a new one in.
253
 
        if (self.tree_file_id(self._new_root) is not None and
254
 
            self._new_root not in self._removed_id):
255
 
            self.unversion_file(self._new_root)
256
 
        if file_id is not None:
257
 
            self.version_file(file_id, self._new_root)
258
 
 
259
 
        # Now move children of new root into old root directory.
260
 
        # Ensure all children are registered with the transaction, but don't
261
 
        # use directly-- some tree children have new parents
262
 
        list(self.iter_tree_children(old_new_root))
263
 
        # Move all children of new root into old root directory.
264
 
        for child in self.by_parent().get(old_new_root, []):
265
 
            self.adjust_path(self.final_name(child), self._new_root, child)
266
 
 
267
 
        # Ensure old_new_root has no directory.
268
 
        if old_new_root in self._new_contents:
269
 
            self.cancel_creation(old_new_root)
270
 
        else:
271
 
            self.delete_contents(old_new_root)
272
 
 
273
 
        # prevent deletion of root directory.
274
 
        if self._new_root in self._removed_contents:
275
 
            self.cancel_deletion(self._new_root)
276
 
 
277
 
        # destroy path info for old_new_root.
278
 
        del self._new_parent[old_new_root]
279
 
        del self._new_name[old_new_root]
280
 
 
281
247
    def trans_id_tree_file_id(self, inventory_id):
282
248
        """Determine the transaction id of a working tree file.
283
 
 
 
249
        
284
250
        This reflects only files that already exist, not ones that will be
285
251
        added by transactions.
286
252
        """
287
 
        if inventory_id is None:
288
 
            raise ValueError('None is not a valid file id')
289
253
        path = self._tree.id2path(inventory_id)
290
254
        return self.trans_id_tree_path(path)
291
255
 
295
259
        a transaction has been unversioned, it is deliberately still returned.
296
260
        (this will likely lead to an unversioned parent conflict.)
297
261
        """
298
 
        if file_id is None:
299
 
            raise ValueError('None is not a valid file id')
300
262
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
301
263
            return self._r_new_id[file_id]
302
 
        else:
303
 
            try:
304
 
                self._tree.iter_entries_by_dir([file_id]).next()
305
 
            except StopIteration:
306
 
                if file_id in self._non_present_ids:
307
 
                    return self._non_present_ids[file_id]
308
 
                else:
309
 
                    trans_id = self._assign_id()
310
 
                    self._non_present_ids[file_id] = trans_id
311
 
                    return trans_id
312
 
            else:
313
 
                return self.trans_id_tree_file_id(file_id)
 
264
        elif file_id in self._tree.inventory:
 
265
            return self.trans_id_tree_file_id(file_id)
 
266
        elif file_id in self._non_present_ids:
 
267
            return self._non_present_ids[file_id]
 
268
        else:
 
269
            trans_id = self._assign_id()
 
270
            self._non_present_ids[file_id] = trans_id
 
271
            return trans_id
 
272
 
 
273
    def canonical_path(self, path):
 
274
        """Get the canonical tree-relative path"""
 
275
        # don't follow final symlinks
 
276
        abs = self._tree.abspath(path)
 
277
        if abs in self._relpaths:
 
278
            return self._relpaths[abs]
 
279
        dirname, basename = os.path.split(abs)
 
280
        if dirname not in self._realpaths:
 
281
            self._realpaths[dirname] = os.path.realpath(dirname)
 
282
        dirname = self._realpaths[dirname]
 
283
        abs = pathjoin(dirname, basename)
 
284
        if dirname in self._relpaths:
 
285
            relpath = pathjoin(self._relpaths[dirname], basename)
 
286
            relpath = relpath.rstrip('/\\')
 
287
        else:
 
288
            relpath = self._tree.relpath(abs)
 
289
        self._relpaths[abs] = relpath
 
290
        return relpath
314
291
 
315
292
    def trans_id_tree_path(self, path):
316
293
        """Determine (and maybe set) the transaction ID for a tree path."""
327
304
            return ROOT_PARENT
328
305
        return self.trans_id_tree_path(os.path.dirname(path))
329
306
 
 
307
    def create_file(self, contents, trans_id, mode_id=None):
 
308
        """Schedule creation of a new file.
 
309
 
 
310
        See also new_file.
 
311
        
 
312
        Contents is an iterator of strings, all of which will be written
 
313
        to the target destination.
 
314
 
 
315
        New file takes the permissions of any existing file with that id,
 
316
        unless mode_id is specified.
 
317
        """
 
318
        name = self._limbo_name(trans_id)
 
319
        f = open(name, 'wb')
 
320
        try:
 
321
            try:
 
322
                unique_add(self._new_contents, trans_id, 'file')
 
323
            except:
 
324
                # Clean up the file, it never got registered so
 
325
                # TreeTransform.finalize() won't clean it up.
 
326
                f.close()
 
327
                os.unlink(name)
 
328
                raise
 
329
 
 
330
            f.writelines(contents)
 
331
        finally:
 
332
            f.close()
 
333
        self._set_mode(trans_id, mode_id, S_ISREG)
 
334
 
 
335
    def _set_mode(self, trans_id, mode_id, typefunc):
 
336
        """Set the mode of new file contents.
 
337
        The mode_id is the existing file to get the mode from (often the same
 
338
        as trans_id).  The operation is only performed if there's a mode match
 
339
        according to typefunc.
 
340
        """
 
341
        if mode_id is None:
 
342
            mode_id = trans_id
 
343
        try:
 
344
            old_path = self._tree_id_paths[mode_id]
 
345
        except KeyError:
 
346
            return
 
347
        try:
 
348
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
349
        except OSError, e:
 
350
            if e.errno == errno.ENOENT:
 
351
                return
 
352
            else:
 
353
                raise
 
354
        if typefunc(mode):
 
355
            os.chmod(self._limbo_name(trans_id), mode)
 
356
 
 
357
    def create_hardlink(self, path, trans_id):
 
358
        """Schedule creation of a hard link"""
 
359
        name = self._limbo_name(trans_id)
 
360
        try:
 
361
            os.link(path, name)
 
362
        except OSError, e:
 
363
            if e.errno != errno.EPERM:
 
364
                raise
 
365
            raise errors.HardLinkNotSupported(path)
 
366
        try:
 
367
            unique_add(self._new_contents, trans_id, 'file')
 
368
        except:
 
369
            # Clean up the file, it never got registered so
 
370
            # TreeTransform.finalize() won't clean it up.
 
371
            os.unlink(name)
 
372
            raise
 
373
 
 
374
    def create_directory(self, trans_id):
 
375
        """Schedule creation of a new directory.
 
376
        
 
377
        See also new_directory.
 
378
        """
 
379
        os.mkdir(self._limbo_name(trans_id))
 
380
        unique_add(self._new_contents, trans_id, 'directory')
 
381
 
 
382
    def create_symlink(self, target, trans_id):
 
383
        """Schedule creation of a new symbolic link.
 
384
 
 
385
        target is a bytestring.
 
386
        See also new_symlink.
 
387
        """
 
388
        if has_symlinks():
 
389
            os.symlink(target, self._limbo_name(trans_id))
 
390
            unique_add(self._new_contents, trans_id, 'symlink')
 
391
        else:
 
392
            try:
 
393
                path = FinalPaths(self).get_path(trans_id)
 
394
            except KeyError:
 
395
                path = None
 
396
            raise UnableCreateSymlink(path=path)
 
397
 
 
398
    def cancel_creation(self, trans_id):
 
399
        """Cancel the creation of new file contents."""
 
400
        del self._new_contents[trans_id]
 
401
        children = self._limbo_children.get(trans_id)
 
402
        # if this is a limbo directory with children, move them before removing
 
403
        # the directory
 
404
        if children is not None:
 
405
            self._rename_in_limbo(children)
 
406
            del self._limbo_children[trans_id]
 
407
            del self._limbo_children_names[trans_id]
 
408
        delete_any(self._limbo_name(trans_id))
 
409
 
330
410
    def delete_contents(self, trans_id):
331
411
        """Schedule the contents of a path entry for deletion"""
332
 
        kind = self.tree_kind(trans_id)
333
 
        if kind is not None:
334
 
            self._removed_contents.add(trans_id)
 
412
        self.tree_kind(trans_id)
 
413
        self._removed_contents.add(trans_id)
335
414
 
336
415
    def cancel_deletion(self, trans_id):
337
416
        """Cancel a scheduled deletion"""
361
440
 
362
441
    def version_file(self, file_id, trans_id):
363
442
        """Schedule a file to become versioned."""
364
 
        if file_id is None:
365
 
            raise ValueError()
 
443
        assert file_id is not None
366
444
        unique_add(self._new_id, trans_id, file_id)
367
445
        unique_add(self._r_new_id, file_id, trans_id)
368
446
 
372
450
        del self._new_id[trans_id]
373
451
        del self._r_new_id[file_id]
374
452
 
375
 
    def new_paths(self, filesystem_only=False):
376
 
        """Determine the paths of all new and changed files.
377
 
 
378
 
        :param filesystem_only: if True, only calculate values for files
379
 
            that require renames or execute bit changes.
380
 
        """
 
453
    def new_paths(self):
 
454
        """Determine the paths of all new and changed files"""
381
455
        new_ids = set()
382
 
        if filesystem_only:
383
 
            stale_ids = self._needs_rename.difference(self._new_name)
384
 
            stale_ids.difference_update(self._new_parent)
385
 
            stale_ids.difference_update(self._new_contents)
386
 
            stale_ids.difference_update(self._new_id)
387
 
            needs_rename = self._needs_rename.difference(stale_ids)
388
 
            id_sets = (needs_rename, self._new_executability)
389
 
        else:
390
 
            id_sets = (self._new_name, self._new_parent, self._new_contents,
391
 
                       self._new_id, self._new_executability)
392
 
        for id_set in id_sets:
 
456
        fp = FinalPaths(self)
 
457
        for id_set in (self._new_name, self._new_parent, self._new_contents,
 
458
                       self._new_id, self._new_executability):
393
459
            new_ids.update(id_set)
394
 
        return sorted(FinalPaths(self).get_paths(new_ids))
395
 
 
396
 
    def _inventory_altered(self):
397
 
        """Determine which trans_ids need new Inventory entries.
398
 
 
399
 
        An new entry is needed when anything that would be reflected by an
400
 
        inventory entry changes, including file name, file_id, parent file_id,
401
 
        file kind, and the execute bit.
402
 
 
403
 
        Some care is taken to return entries with real changes, not cases
404
 
        where the value is deleted and then restored to its original value,
405
 
        but some actually unchanged values may be returned.
406
 
 
407
 
        :returns: A list of (path, trans_id) for all items requiring an
408
 
            inventory change. Ordered by path.
 
460
        new_paths = [(fp.get_path(t), t) for t in new_ids]
 
461
        new_paths.sort()
 
462
        return new_paths
 
463
 
 
464
    def tree_kind(self, trans_id):
 
465
        """Determine the file kind in the working tree.
 
466
 
 
467
        Raises NoSuchFile if the file does not exist
409
468
        """
410
 
        changed_ids = set()
411
 
        # Find entries whose file_ids are new (or changed).
412
 
        new_file_id = set(t for t in self._new_id
413
 
                          if self._new_id[t] != self.tree_file_id(t))
414
 
        for id_set in [self._new_name, self._new_parent, new_file_id,
415
 
                       self._new_executability]:
416
 
            changed_ids.update(id_set)
417
 
        # removing implies a kind change
418
 
        changed_kind = set(self._removed_contents)
419
 
        # so does adding
420
 
        changed_kind.intersection_update(self._new_contents)
421
 
        # Ignore entries that are already known to have changed.
422
 
        changed_kind.difference_update(changed_ids)
423
 
        #  to keep only the truly changed ones
424
 
        changed_kind = (t for t in changed_kind
425
 
                        if self.tree_kind(t) != self.final_kind(t))
426
 
        # all kind changes will alter the inventory
427
 
        changed_ids.update(changed_kind)
428
 
        # To find entries with changed parent_ids, find parents which existed,
429
 
        # but changed file_id.
430
 
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
431
 
        # Now add all their children to the set.
432
 
        for parent_trans_id in new_file_id:
433
 
            changed_ids.update(self.iter_tree_children(parent_trans_id))
434
 
        return sorted(FinalPaths(self).get_paths(changed_ids))
 
469
        path = self._tree_id_paths.get(trans_id)
 
470
        if path is None:
 
471
            raise NoSuchFile(None)
 
472
        try:
 
473
            return file_kind(self._tree.abspath(path))
 
474
        except OSError, e:
 
475
            if e.errno != errno.ENOENT:
 
476
                raise
 
477
            else:
 
478
                raise NoSuchFile(path)
435
479
 
436
480
    def final_kind(self, trans_id):
437
481
        """Determine the final file kind, after any changes applied.
438
 
 
439
 
        :return: None if the file does not exist/has no contents.  (It is
440
 
            conceivable that a path would be created without the corresponding
441
 
            contents insertion command)
 
482
        
 
483
        Raises NoSuchFile if the file does not exist/has no contents.
 
484
        (It is conceivable that a path would be created without the
 
485
        corresponding contents insertion command)
442
486
        """
443
487
        if trans_id in self._new_contents:
444
488
            return self._new_contents[trans_id]
445
489
        elif trans_id in self._removed_contents:
446
 
            return None
 
490
            raise NoSuchFile(None)
447
491
        else:
448
492
            return self.tree_kind(trans_id)
449
493
 
457
501
        # the file is old; the old id is still valid
458
502
        if self._new_root == trans_id:
459
503
            return self._tree.get_root_id()
460
 
        return self._tree.path2id(path)
 
504
        return self._tree.inventory.path2id(path)
461
505
 
462
506
    def final_file_id(self, trans_id):
463
507
        """Determine the file id after any changes are applied, or None.
464
 
 
 
508
        
465
509
        None indicates that the file will not be versioned after changes are
466
510
        applied.
467
511
        """
468
512
        try:
 
513
            # there is a new id for this file
 
514
            assert self._new_id[trans_id] is not None
469
515
            return self._new_id[trans_id]
470
516
        except KeyError:
471
517
            if trans_id in self._removed_id:
506
552
 
507
553
    def by_parent(self):
508
554
        """Return a map of parent: children for known parents.
509
 
 
 
555
        
510
556
        Only new paths and parents of tree files with assigned ids are used.
511
557
        """
512
558
        by_parent = {}
513
559
        items = list(self._new_parent.iteritems())
514
 
        items.extend((t, self.final_parent(t)) for t in
 
560
        items.extend((t, self.final_parent(t)) for t in 
515
561
                      self._tree_id_paths.keys())
516
562
        for trans_id, parent_id in items:
517
563
            if parent_id not in by_parent:
545
591
        conflicts.extend(self._overwrite_conflicts())
546
592
        return conflicts
547
593
 
548
 
    def _check_malformed(self):
549
 
        conflicts = self.find_conflicts()
550
 
        if len(conflicts) != 0:
551
 
            raise MalformedTransform(conflicts=conflicts)
552
 
 
553
594
    def _add_tree_children(self):
554
595
        """Add all the children of all active parents to the known paths.
555
596
 
557
598
        removed.  This is a necessary first step in detecting conflicts.
558
599
        """
559
600
        parents = self.by_parent().keys()
560
 
        parents.extend([t for t in self._removed_contents if
 
601
        parents.extend([t for t in self._removed_contents if 
561
602
                        self.tree_kind(t) == 'directory'])
562
603
        for trans_id in self._removed_id:
563
604
            file_id = self.tree_file_id(trans_id)
564
605
            if file_id is not None:
565
 
                # XXX: This seems like something that should go via a different
566
 
                #      indirection.
567
606
                if self._tree.inventory[file_id].kind == 'directory':
568
607
                    parents.append(trans_id)
569
608
            elif self.tree_kind(trans_id) == 'directory':
573
612
            # ensure that all children are registered with the transaction
574
613
            list(self.iter_tree_children(parent_id))
575
614
 
576
 
    @deprecated_method(deprecated_in((2, 3, 0)))
 
615
    def iter_tree_children(self, parent_id):
 
616
        """Iterate through the entry's tree children, if any"""
 
617
        try:
 
618
            path = self._tree_id_paths[parent_id]
 
619
        except KeyError:
 
620
            return
 
621
        try:
 
622
            children = os.listdir(self._tree.abspath(path))
 
623
        except OSError, e:
 
624
            if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
 
625
                raise
 
626
            return
 
627
            
 
628
        for child in children:
 
629
            childpath = joinpath(path, child)
 
630
            if self._tree.is_control_filename(childpath):
 
631
                continue
 
632
            yield self.trans_id_tree_path(childpath)
 
633
 
577
634
    def has_named_child(self, by_parent, parent_id, name):
578
 
        return self._has_named_child(
579
 
            name, parent_id, known_children=by_parent.get(parent_id, []))
580
 
 
581
 
    def _has_named_child(self, name, parent_id, known_children):
582
 
        """Does a parent already have a name child.
583
 
 
584
 
        :param name: The searched for name.
585
 
 
586
 
        :param parent_id: The parent for which the check is made.
587
 
 
588
 
        :param known_children: The already known children. This should have
589
 
            been recently obtained from `self.by_parent.get(parent_id)`
590
 
            (or will be if None is passed).
591
 
        """
592
 
        if known_children is None:
593
 
            known_children = self.by_parent().get(parent_id, [])
594
 
        for child in known_children:
 
635
        try:
 
636
            children = by_parent[parent_id]
 
637
        except KeyError:
 
638
            children = []
 
639
        for child in children:
595
640
            if self.final_name(child) == name:
596
641
                return True
597
 
        parent_path = self._tree_id_paths.get(parent_id, None)
598
 
        if parent_path is None:
599
 
            # No parent... no children
 
642
        try:
 
643
            path = self._tree_id_paths[parent_id]
 
644
        except KeyError:
600
645
            return False
601
 
        child_path = joinpath(parent_path, name)
602
 
        child_id = self._tree_path_ids.get(child_path, None)
 
646
        childpath = joinpath(path, name)
 
647
        child_id = self._tree_path_ids.get(childpath)
603
648
        if child_id is None:
604
 
            # Not known by the tree transform yet, check the filesystem
605
 
            return osutils.lexists(self._tree.abspath(child_path))
 
649
            return lexists(self._tree.abspath(childpath))
606
650
        else:
607
 
            raise AssertionError('child_id is missing: %s, %s, %s'
608
 
                                 % (name, parent_id, child_id))
609
 
 
610
 
    def _available_backup_name(self, name, target_id):
611
 
        """Find an available backup name.
612
 
 
613
 
        :param name: The basename of the file.
614
 
 
615
 
        :param target_id: The directory trans_id where the backup should 
616
 
            be placed.
617
 
        """
618
 
        known_children = self.by_parent().get(target_id, [])
619
 
        return osutils.available_backup_name(
620
 
            name,
621
 
            lambda base: self._has_named_child(
622
 
                base, target_id, known_children))
 
651
            if self.final_parent(child_id) != parent_id:
 
652
                return False
 
653
            if child_id in self._removed_contents:
 
654
                # XXX What about dangling file-ids?
 
655
                return False
 
656
            else:
 
657
                return True
623
658
 
624
659
    def _parent_loops(self):
625
660
        """No entry should be its own ancestor"""
655
690
 
656
691
    def _improper_versioning(self):
657
692
        """Cannot version a file with no contents, or a bad type.
658
 
 
 
693
        
659
694
        However, existing entries with no contents are okay.
660
695
        """
661
696
        conflicts = []
662
697
        for trans_id in self._new_id.iterkeys():
663
 
            kind = self.final_kind(trans_id)
664
 
            if kind is None:
 
698
            try:
 
699
                kind = self.final_kind(trans_id)
 
700
            except NoSuchFile:
665
701
                conflicts.append(('versioning no contents', trans_id))
666
702
                continue
667
 
            if not inventory.InventoryEntry.versionable_kind(kind):
 
703
            if not InventoryEntry.versionable_kind(kind):
668
704
                conflicts.append(('versioning bad kind', trans_id, kind))
669
705
        return conflicts
670
706
 
671
707
    def _executability_conflicts(self):
672
708
        """Check for bad executability changes.
673
 
 
 
709
        
674
710
        Only versioned files may have their executability set, because
675
711
        1. only versioned entries can have executability under windows
676
712
        2. only files can be executable.  (The execute bit on a directory
681
717
            if self.final_file_id(trans_id) is None:
682
718
                conflicts.append(('unversioned executability', trans_id))
683
719
            else:
684
 
                if self.final_kind(trans_id) != "file":
 
720
                try:
 
721
                    non_file = self.final_kind(trans_id) != "file"
 
722
                except NoSuchFile:
 
723
                    non_file = True
 
724
                if non_file is True:
685
725
                    conflicts.append(('non-file executability', trans_id))
686
726
        return conflicts
687
727
 
689
729
        """Check for overwrites (not permitted on Win32)"""
690
730
        conflicts = []
691
731
        for trans_id in self._new_contents:
692
 
            if self.tree_kind(trans_id) is None:
 
732
            try:
 
733
                self.tree_kind(trans_id)
 
734
            except NoSuchFile:
693
735
                continue
694
736
            if trans_id not in self._removed_contents:
695
737
                conflicts.append(('overwrite', trans_id,
702
744
        if (self._new_name, self._new_parent) == ({}, {}):
703
745
            return conflicts
704
746
        for children in by_parent.itervalues():
705
 
            name_ids = []
706
 
            for child_tid in children:
707
 
                name = self.final_name(child_tid)
708
 
                if name is not None:
709
 
                    # Keep children only if they still exist in the end
710
 
                    if not self._case_sensitive_target:
711
 
                        name = name.lower()
712
 
                    name_ids.append((name, child_tid))
 
747
            name_ids = [(self.final_name(t), t) for t in children]
 
748
            if not self._case_sensitive_target:
 
749
                name_ids = [(n.lower(), t) for n, t in name_ids]
713
750
            name_ids.sort()
714
751
            last_name = None
715
752
            last_trans_id = None
716
753
            for name, trans_id in name_ids:
717
 
                kind = self.final_kind(trans_id)
 
754
                try:
 
755
                    kind = self.final_kind(trans_id)
 
756
                except NoSuchFile:
 
757
                    kind = None
718
758
                file_id = self.final_file_id(trans_id)
719
759
                if kind is None and file_id is None:
720
760
                    continue
739
779
        return conflicts
740
780
 
741
781
    def _parent_type_conflicts(self, by_parent):
742
 
        """Children must have a directory parent"""
 
782
        """parents must have directory 'contents'."""
743
783
        conflicts = []
744
784
        for parent_id, children in by_parent.iteritems():
745
785
            if parent_id is ROOT_PARENT:
746
786
                continue
747
 
            no_children = True
748
 
            for child_id in children:
749
 
                if self.final_kind(child_id) is not None:
750
 
                    no_children = False
751
 
                    break
752
 
            if no_children:
 
787
            if not self._any_contents(children):
753
788
                continue
754
 
            # There is at least a child, so we need an existing directory to
755
 
            # contain it.
756
 
            kind = self.final_kind(parent_id)
 
789
            for child in children:
 
790
                try:
 
791
                    self.final_kind(child)
 
792
                except NoSuchFile:
 
793
                    continue
 
794
            try:
 
795
                kind = self.final_kind(parent_id)
 
796
            except NoSuchFile:
 
797
                kind = None
757
798
            if kind is None:
758
 
                # The directory will be deleted
759
799
                conflicts.append(('missing parent', parent_id))
760
800
            elif kind != "directory":
761
 
                # Meh, we need a *directory* to put something in it
762
801
                conflicts.append(('non-directory parent', parent_id))
763
802
        return conflicts
764
803
 
765
 
    def _set_executability(self, path, trans_id):
 
804
    def _any_contents(self, trans_ids):
 
805
        """Return true if any of the trans_ids, will have contents."""
 
806
        for trans_id in trans_ids:
 
807
            try:
 
808
                kind = self.final_kind(trans_id)
 
809
            except NoSuchFile:
 
810
                continue
 
811
            return True
 
812
        return False
 
813
 
 
814
    def _limbo_name(self, trans_id):
 
815
        """Generate the limbo name of a file"""
 
816
        limbo_name = self._limbo_files.get(trans_id)
 
817
        if limbo_name is not None:
 
818
            return limbo_name
 
819
        parent = self._new_parent.get(trans_id)
 
820
        # if the parent directory is already in limbo (e.g. when building a
 
821
        # tree), choose a limbo name inside the parent, to reduce further
 
822
        # renames.
 
823
        use_direct_path = False
 
824
        if self._new_contents.get(parent) == 'directory':
 
825
            filename = self._new_name.get(trans_id)
 
826
            if filename is not None:
 
827
                if parent not in self._limbo_children:
 
828
                    self._limbo_children[parent] = set()
 
829
                    self._limbo_children_names[parent] = {}
 
830
                    use_direct_path = True
 
831
                # the direct path can only be used if no other file has
 
832
                # already taken this pathname, i.e. if the name is unused, or
 
833
                # if it is already associated with this trans_id.
 
834
                elif self._case_sensitive_target:
 
835
                    if (self._limbo_children_names[parent].get(filename)
 
836
                        in (trans_id, None)):
 
837
                        use_direct_path = True
 
838
                else:
 
839
                    for l_filename, l_trans_id in\
 
840
                        self._limbo_children_names[parent].iteritems():
 
841
                        if l_trans_id == trans_id:
 
842
                            continue
 
843
                        if l_filename.lower() == filename.lower():
 
844
                            break
 
845
                    else:
 
846
                        use_direct_path = True
 
847
 
 
848
        if use_direct_path:
 
849
            limbo_name = pathjoin(self._limbo_files[parent], filename)
 
850
            self._limbo_children[parent].add(trans_id)
 
851
            self._limbo_children_names[parent][filename] = trans_id
 
852
        else:
 
853
            limbo_name = pathjoin(self._limbodir, trans_id)
 
854
            self._needs_rename.add(trans_id)
 
855
        self._limbo_files[trans_id] = limbo_name
 
856
        return limbo_name
 
857
 
 
858
    def _set_executability(self, path, entry, trans_id):
766
859
        """Set the executability of versioned files """
 
860
        new_executability = self._new_executability[trans_id]
 
861
        entry.executable = new_executability
767
862
        if supports_executable():
768
 
            new_executability = self._new_executability[trans_id]
769
863
            abspath = self._tree.abspath(path)
770
864
            current_mode = os.stat(abspath).st_mode
771
865
            if new_executability:
788
882
            self.version_file(file_id, trans_id)
789
883
        return trans_id
790
884
 
791
 
    def new_file(self, name, parent_id, contents, file_id=None,
792
 
                 executable=None, sha1=None):
 
885
    def new_file(self, name, parent_id, contents, file_id=None, 
 
886
                 executable=None):
793
887
        """Convenience method to create files.
794
 
 
 
888
        
795
889
        name is the name of the file to create.
796
890
        parent_id is the transaction id of the parent directory of the file.
797
891
        contents is an iterator of bytestrings, which will be used to produce
802
896
        trans_id = self._new_entry(name, parent_id, file_id)
803
897
        # TODO: rather than scheduling a set_executable call,
804
898
        # have create_file create the file with the right mode.
805
 
        self.create_file(contents, trans_id, sha1=sha1)
 
899
        self.create_file(contents, trans_id)
806
900
        if executable is not None:
807
901
            self.set_executability(executable, trans_id)
808
902
        return trans_id
817
911
        """
818
912
        trans_id = self._new_entry(name, parent_id, file_id)
819
913
        self.create_directory(trans_id)
820
 
        return trans_id
 
914
        return trans_id 
821
915
 
822
916
    def new_symlink(self, name, parent_id, target, file_id=None):
823
917
        """Convenience method to create symbolic link.
824
 
 
 
918
        
825
919
        name is the name of the symlink to create.
826
920
        parent_id is the transaction id of the parent directory of the symlink.
827
921
        target is a bytestring of the target of the symlink.
831
925
        self.create_symlink(target, trans_id)
832
926
        return trans_id
833
927
 
834
 
    def new_orphan(self, trans_id, parent_id):
835
 
        """Schedule an item to be orphaned.
836
 
 
837
 
        When a directory is about to be removed, its children, if they are not
838
 
        versioned are moved out of the way: they don't have a parent anymore.
839
 
 
840
 
        :param trans_id: The trans_id of the existing item.
841
 
        :param parent_id: The parent trans_id of the item.
842
 
        """
843
 
        raise NotImplementedError(self.new_orphan)
844
 
 
845
 
    def _get_potential_orphans(self, dir_id):
846
 
        """Find the potential orphans in a directory.
847
 
 
848
 
        A directory can't be safely deleted if there are versioned files in it.
849
 
        If all the contained files are unversioned then they can be orphaned.
850
 
 
851
 
        The 'None' return value means that the directory contains at least one
852
 
        versioned file and should not be deleted.
853
 
 
854
 
        :param dir_id: The directory trans id.
855
 
 
856
 
        :return: A list of the orphan trans ids or None if at least one
857
 
             versioned file is present.
858
 
        """
859
 
        orphans = []
860
 
        # Find the potential orphans, stop if one item should be kept
861
 
        for child_tid in self.by_parent()[dir_id]:
862
 
            if child_tid in self._removed_contents:
863
 
                # The child is removed as part of the transform. Since it was
864
 
                # versioned before, it's not an orphan
865
 
                continue
866
 
            elif self.final_file_id(child_tid) is None:
867
 
                # The child is not versioned
868
 
                orphans.append(child_tid)
869
 
            else:
870
 
                # We have a versioned file here, searching for orphans is
871
 
                # meaningless.
872
 
                orphans = None
873
 
                break
874
 
        return orphans
875
 
 
876
928
    def _affected_ids(self):
877
929
        """Return the set of transform ids affected by the transform"""
878
930
        trans_ids = set(self._removed_id)
908
960
        from_path = self._tree_id_paths.get(from_trans_id)
909
961
        if from_versioned:
910
962
            # get data from working tree if versioned
911
 
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
963
            from_entry = self._tree.inventory[file_id]
912
964
            from_name = from_entry.name
913
965
            from_parent = from_entry.parent_id
914
966
        else:
937
989
        Return a (name, parent, kind, executable) tuple
938
990
        """
939
991
        to_name = self.final_name(to_trans_id)
940
 
        to_kind = self.final_kind(to_trans_id)
 
992
        try:
 
993
            to_kind = self.final_kind(to_trans_id)
 
994
        except NoSuchFile:
 
995
            to_kind = None
941
996
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
942
997
        if to_trans_id in self._new_executability:
943
998
            to_executable = self._new_executability[to_trans_id]
1012
1067
    def get_preview_tree(self):
1013
1068
        """Return a tree representing the result of the transform.
1014
1069
 
1015
 
        The tree is a snapshot, and altering the TreeTransform will invalidate
1016
 
        it.
 
1070
        This tree only supports the subset of Tree functionality required
 
1071
        by show_diff_trees.  It must only be compared to tt._tree.
1017
1072
        """
1018
1073
        return _PreviewTree(self)
1019
1074
 
1020
 
    def commit(self, branch, message, merge_parents=None, strict=False,
1021
 
               timestamp=None, timezone=None, committer=None, authors=None,
1022
 
               revprops=None, revision_id=None):
1023
 
        """Commit the result of this TreeTransform to a branch.
1024
 
 
1025
 
        :param branch: The branch to commit to.
1026
 
        :param message: The message to attach to the commit.
1027
 
        :param merge_parents: Additional parent revision-ids specified by
1028
 
            pending merges.
1029
 
        :param strict: If True, abort the commit if there are unversioned
1030
 
            files.
1031
 
        :param timestamp: if not None, seconds-since-epoch for the time and
1032
 
            date.  (May be a float.)
1033
 
        :param timezone: Optional timezone for timestamp, as an offset in
1034
 
            seconds.
1035
 
        :param committer: Optional committer in email-id format.
1036
 
            (e.g. "J Random Hacker <jrandom@example.com>")
1037
 
        :param authors: Optional list of authors in email-id format.
1038
 
        :param revprops: Optional dictionary of revision properties.
1039
 
        :param revision_id: Optional revision id.  (Specifying a revision-id
1040
 
            may reduce performance for some non-native formats.)
1041
 
        :return: The revision_id of the revision committed.
1042
 
        """
1043
 
        self._check_malformed()
1044
 
        if strict:
1045
 
            unversioned = set(self._new_contents).difference(set(self._new_id))
1046
 
            for trans_id in unversioned:
1047
 
                if self.final_file_id(trans_id) is None:
1048
 
                    raise errors.StrictCommitFailed()
1049
 
 
1050
 
        revno, last_rev_id = branch.last_revision_info()
1051
 
        if last_rev_id == _mod_revision.NULL_REVISION:
1052
 
            if merge_parents is not None:
1053
 
                raise ValueError('Cannot supply merge parents for first'
1054
 
                                 ' commit.')
1055
 
            parent_ids = []
1056
 
        else:
1057
 
            parent_ids = [last_rev_id]
1058
 
            if merge_parents is not None:
1059
 
                parent_ids.extend(merge_parents)
1060
 
        if self._tree.get_revision_id() != last_rev_id:
1061
 
            raise ValueError('TreeTransform not based on branch basis: %s' %
1062
 
                             self._tree.get_revision_id())
1063
 
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
1064
 
        builder = branch.get_commit_builder(parent_ids,
1065
 
                                            timestamp=timestamp,
1066
 
                                            timezone=timezone,
1067
 
                                            committer=committer,
1068
 
                                            revprops=revprops,
1069
 
                                            revision_id=revision_id)
1070
 
        preview = self.get_preview_tree()
1071
 
        list(builder.record_iter_changes(preview, last_rev_id,
1072
 
                                         self.iter_changes()))
1073
 
        builder.finish_inventory()
1074
 
        revision_id = builder.commit(message)
1075
 
        branch.set_last_revision_info(revno + 1, revision_id)
1076
 
        return revision_id
1077
 
 
1078
 
    def _text_parent(self, trans_id):
1079
 
        file_id = self.tree_file_id(trans_id)
1080
 
        try:
1081
 
            if file_id is None or self._tree.kind(file_id) != 'file':
1082
 
                return None
1083
 
        except errors.NoSuchFile:
1084
 
            return None
1085
 
        return file_id
1086
 
 
1087
 
    def _get_parents_texts(self, trans_id):
1088
 
        """Get texts for compression parents of this file."""
1089
 
        file_id = self._text_parent(trans_id)
1090
 
        if file_id is None:
1091
 
            return ()
1092
 
        return (self._tree.get_file_text(file_id),)
1093
 
 
1094
 
    def _get_parents_lines(self, trans_id):
1095
 
        """Get lines for compression parents of this file."""
1096
 
        file_id = self._text_parent(trans_id)
1097
 
        if file_id is None:
1098
 
            return ()
1099
 
        return (self._tree.get_file_lines(file_id),)
1100
 
 
1101
 
    def serialize(self, serializer):
1102
 
        """Serialize this TreeTransform.
1103
 
 
1104
 
        :param serializer: A Serialiser like pack.ContainerSerializer.
1105
 
        """
1106
 
        new_name = dict((k, v.encode('utf-8')) for k, v in
1107
 
                        self._new_name.items())
1108
 
        new_executability = dict((k, int(v)) for k, v in
1109
 
                                 self._new_executability.items())
1110
 
        tree_path_ids = dict((k.encode('utf-8'), v)
1111
 
                             for k, v in self._tree_path_ids.items())
1112
 
        attribs = {
1113
 
            '_id_number': self._id_number,
1114
 
            '_new_name': new_name,
1115
 
            '_new_parent': self._new_parent,
1116
 
            '_new_executability': new_executability,
1117
 
            '_new_id': self._new_id,
1118
 
            '_tree_path_ids': tree_path_ids,
1119
 
            '_removed_id': list(self._removed_id),
1120
 
            '_removed_contents': list(self._removed_contents),
1121
 
            '_non_present_ids': self._non_present_ids,
1122
 
            }
1123
 
        yield serializer.bytes_record(bencode.bencode(attribs),
1124
 
                                      (('attribs',),))
1125
 
        for trans_id, kind in self._new_contents.items():
1126
 
            if kind == 'file':
1127
 
                lines = osutils.chunks_to_lines(
1128
 
                    self._read_file_chunks(trans_id))
1129
 
                parents = self._get_parents_lines(trans_id)
1130
 
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1131
 
                content = ''.join(mpdiff.to_patch())
1132
 
            if kind == 'directory':
1133
 
                content = ''
1134
 
            if kind == 'symlink':
1135
 
                content = self._read_symlink_target(trans_id)
1136
 
            yield serializer.bytes_record(content, ((trans_id, kind),))
1137
 
 
1138
 
    def deserialize(self, records):
1139
 
        """Deserialize a stored TreeTransform.
1140
 
 
1141
 
        :param records: An iterable of (names, content) tuples, as per
1142
 
            pack.ContainerPushParser.
1143
 
        """
1144
 
        names, content = records.next()
1145
 
        attribs = bencode.bdecode(content)
1146
 
        self._id_number = attribs['_id_number']
1147
 
        self._new_name = dict((k, v.decode('utf-8'))
1148
 
                            for k, v in attribs['_new_name'].items())
1149
 
        self._new_parent = attribs['_new_parent']
1150
 
        self._new_executability = dict((k, bool(v)) for k, v in
1151
 
            attribs['_new_executability'].items())
1152
 
        self._new_id = attribs['_new_id']
1153
 
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1154
 
        self._tree_path_ids = {}
1155
 
        self._tree_id_paths = {}
1156
 
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
1157
 
            path = bytepath.decode('utf-8')
1158
 
            self._tree_path_ids[path] = trans_id
1159
 
            self._tree_id_paths[trans_id] = path
1160
 
        self._removed_id = set(attribs['_removed_id'])
1161
 
        self._removed_contents = set(attribs['_removed_contents'])
1162
 
        self._non_present_ids = attribs['_non_present_ids']
1163
 
        for ((trans_id, kind),), content in records:
1164
 
            if kind == 'file':
1165
 
                mpdiff = multiparent.MultiParent.from_patch(content)
1166
 
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1167
 
                self.create_file(lines, trans_id)
1168
 
            if kind == 'directory':
1169
 
                self.create_directory(trans_id)
1170
 
            if kind == 'symlink':
1171
 
                self.create_symlink(content.decode('utf-8'), trans_id)
1172
 
 
1173
 
 
1174
 
class DiskTreeTransform(TreeTransformBase):
1175
 
    """Tree transform storing its contents on disk."""
1176
 
 
1177
 
    def __init__(self, tree, limbodir, pb=None,
1178
 
                 case_sensitive=True):
1179
 
        """Constructor.
1180
 
        :param tree: The tree that will be transformed, but not necessarily
1181
 
            the output tree.
1182
 
        :param limbodir: A directory where new files can be stored until
1183
 
            they are installed in their proper places
1184
 
        :param pb: ignored
1185
 
        :param case_sensitive: If True, the target of the transform is
1186
 
            case sensitive, not just case preserving.
1187
 
        """
1188
 
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1189
 
        self._limbodir = limbodir
1190
 
        self._deletiondir = None
1191
 
        # A mapping of transform ids to their limbo filename
1192
 
        self._limbo_files = {}
1193
 
        self._possibly_stale_limbo_files = set()
1194
 
        # A mapping of transform ids to a set of the transform ids of children
1195
 
        # that their limbo directory has
1196
 
        self._limbo_children = {}
1197
 
        # Map transform ids to maps of child filename to child transform id
1198
 
        self._limbo_children_names = {}
1199
 
        # List of transform ids that need to be renamed from limbo into place
1200
 
        self._needs_rename = set()
1201
 
        self._creation_mtime = None
1202
 
 
1203
 
    def finalize(self):
1204
 
        """Release the working tree lock, if held, clean up limbo dir.
1205
 
 
1206
 
        This is required if apply has not been invoked, but can be invoked
1207
 
        even after apply.
1208
 
        """
1209
 
        if self._tree is None:
1210
 
            return
1211
 
        try:
1212
 
            limbo_paths = self._limbo_files.values() + list(
1213
 
                self._possibly_stale_limbo_files)
1214
 
            limbo_paths = sorted(limbo_paths, reverse=True)
1215
 
            for path in limbo_paths:
1216
 
                try:
1217
 
                    delete_any(path)
1218
 
                except OSError, e:
1219
 
                    if e.errno != errno.ENOENT:
1220
 
                        raise
1221
 
                    # XXX: warn? perhaps we just got interrupted at an
1222
 
                    # inconvenient moment, but perhaps files are disappearing
1223
 
                    # from under us?
1224
 
            try:
1225
 
                delete_any(self._limbodir)
1226
 
            except OSError:
1227
 
                # We don't especially care *why* the dir is immortal.
1228
 
                raise ImmortalLimbo(self._limbodir)
1229
 
            try:
1230
 
                if self._deletiondir is not None:
1231
 
                    delete_any(self._deletiondir)
1232
 
            except OSError:
1233
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
1234
 
        finally:
1235
 
            TreeTransformBase.finalize(self)
1236
 
 
1237
 
    def _limbo_name(self, trans_id):
1238
 
        """Generate the limbo name of a file"""
1239
 
        limbo_name = self._limbo_files.get(trans_id)
1240
 
        if limbo_name is None:
1241
 
            limbo_name = self._generate_limbo_path(trans_id)
1242
 
            self._limbo_files[trans_id] = limbo_name
1243
 
        return limbo_name
1244
 
 
1245
 
    def _generate_limbo_path(self, trans_id):
1246
 
        """Generate a limbo path using the trans_id as the relative path.
1247
 
 
1248
 
        This is suitable as a fallback, and when the transform should not be
1249
 
        sensitive to the path encoding of the limbo directory.
1250
 
        """
1251
 
        self._needs_rename.add(trans_id)
1252
 
        return pathjoin(self._limbodir, trans_id)
1253
 
 
1254
 
    def adjust_path(self, name, parent, trans_id):
1255
 
        previous_parent = self._new_parent.get(trans_id)
1256
 
        previous_name = self._new_name.get(trans_id)
1257
 
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
1258
 
        if (trans_id in self._limbo_files and
1259
 
            trans_id not in self._needs_rename):
1260
 
            self._rename_in_limbo([trans_id])
1261
 
            if previous_parent != parent:
1262
 
                self._limbo_children[previous_parent].remove(trans_id)
1263
 
            if previous_parent != parent or previous_name != name:
1264
 
                del self._limbo_children_names[previous_parent][previous_name]
1265
 
 
1266
 
    def _rename_in_limbo(self, trans_ids):
1267
 
        """Fix limbo names so that the right final path is produced.
1268
 
 
1269
 
        This means we outsmarted ourselves-- we tried to avoid renaming
1270
 
        these files later by creating them with their final names in their
1271
 
        final parents.  But now the previous name or parent is no longer
1272
 
        suitable, so we have to rename them.
1273
 
 
1274
 
        Even for trans_ids that have no new contents, we must remove their
1275
 
        entries from _limbo_files, because they are now stale.
1276
 
        """
1277
 
        for trans_id in trans_ids:
1278
 
            old_path = self._limbo_files[trans_id]
1279
 
            self._possibly_stale_limbo_files.add(old_path)
1280
 
            del self._limbo_files[trans_id]
1281
 
            if trans_id not in self._new_contents:
1282
 
                continue
1283
 
            new_path = self._limbo_name(trans_id)
1284
 
            os.rename(old_path, new_path)
1285
 
            self._possibly_stale_limbo_files.remove(old_path)
1286
 
            for descendant in self._limbo_descendants(trans_id):
1287
 
                desc_path = self._limbo_files[descendant]
1288
 
                desc_path = new_path + desc_path[len(old_path):]
1289
 
                self._limbo_files[descendant] = desc_path
1290
 
 
1291
 
    def _limbo_descendants(self, trans_id):
1292
 
        """Return the set of trans_ids whose limbo paths descend from this."""
1293
 
        descendants = set(self._limbo_children.get(trans_id, []))
1294
 
        for descendant in list(descendants):
1295
 
            descendants.update(self._limbo_descendants(descendant))
1296
 
        return descendants
1297
 
 
1298
 
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1299
 
        """Schedule creation of a new file.
1300
 
 
1301
 
        :seealso: new_file.
1302
 
 
1303
 
        :param contents: an iterator of strings, all of which will be written
1304
 
            to the target destination.
1305
 
        :param trans_id: TreeTransform handle
1306
 
        :param mode_id: If not None, force the mode of the target file to match
1307
 
            the mode of the object referenced by mode_id.
1308
 
            Otherwise, we will try to preserve mode bits of an existing file.
1309
 
        :param sha1: If the sha1 of this content is already known, pass it in.
1310
 
            We can use it to prevent future sha1 computations.
1311
 
        """
1312
 
        name = self._limbo_name(trans_id)
1313
 
        f = open(name, 'wb')
1314
 
        try:
1315
 
            unique_add(self._new_contents, trans_id, 'file')
1316
 
            f.writelines(contents)
1317
 
        finally:
1318
 
            f.close()
1319
 
        self._set_mtime(name)
1320
 
        self._set_mode(trans_id, mode_id, S_ISREG)
1321
 
        # It is unfortunate we have to use lstat instead of fstat, but we just
1322
 
        # used utime and chmod on the file, so we need the accurate final
1323
 
        # details.
1324
 
        if sha1 is not None:
1325
 
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1326
 
 
1327
 
    def _read_file_chunks(self, trans_id):
1328
 
        cur_file = open(self._limbo_name(trans_id), 'rb')
1329
 
        try:
1330
 
            return cur_file.readlines()
1331
 
        finally:
1332
 
            cur_file.close()
1333
 
 
1334
 
    def _read_symlink_target(self, trans_id):
1335
 
        return os.readlink(self._limbo_name(trans_id))
1336
 
 
1337
 
    def _set_mtime(self, path):
1338
 
        """All files that are created get the same mtime.
1339
 
 
1340
 
        This time is set by the first object to be created.
1341
 
        """
1342
 
        if self._creation_mtime is None:
1343
 
            self._creation_mtime = time.time()
1344
 
        os.utime(path, (self._creation_mtime, self._creation_mtime))
1345
 
 
1346
 
    def create_hardlink(self, path, trans_id):
1347
 
        """Schedule creation of a hard link"""
1348
 
        name = self._limbo_name(trans_id)
1349
 
        try:
1350
 
            os.link(path, name)
1351
 
        except OSError, e:
1352
 
            if e.errno != errno.EPERM:
1353
 
                raise
1354
 
            raise errors.HardLinkNotSupported(path)
1355
 
        try:
1356
 
            unique_add(self._new_contents, trans_id, 'file')
1357
 
        except:
1358
 
            # Clean up the file, it never got registered so
1359
 
            # TreeTransform.finalize() won't clean it up.
1360
 
            os.unlink(name)
1361
 
            raise
1362
 
 
1363
 
    def create_directory(self, trans_id):
1364
 
        """Schedule creation of a new directory.
1365
 
 
1366
 
        See also new_directory.
1367
 
        """
1368
 
        os.mkdir(self._limbo_name(trans_id))
1369
 
        unique_add(self._new_contents, trans_id, 'directory')
1370
 
 
1371
 
    def create_symlink(self, target, trans_id):
1372
 
        """Schedule creation of a new symbolic link.
1373
 
 
1374
 
        target is a bytestring.
1375
 
        See also new_symlink.
1376
 
        """
1377
 
        if has_symlinks():
1378
 
            os.symlink(target, self._limbo_name(trans_id))
1379
 
            unique_add(self._new_contents, trans_id, 'symlink')
1380
 
        else:
1381
 
            try:
1382
 
                path = FinalPaths(self).get_path(trans_id)
1383
 
            except KeyError:
1384
 
                path = None
1385
 
            raise UnableCreateSymlink(path=path)
1386
 
 
1387
 
    def cancel_creation(self, trans_id):
1388
 
        """Cancel the creation of new file contents."""
1389
 
        del self._new_contents[trans_id]
1390
 
        if trans_id in self._observed_sha1s:
1391
 
            del self._observed_sha1s[trans_id]
1392
 
        children = self._limbo_children.get(trans_id)
1393
 
        # if this is a limbo directory with children, move them before removing
1394
 
        # the directory
1395
 
        if children is not None:
1396
 
            self._rename_in_limbo(children)
1397
 
            del self._limbo_children[trans_id]
1398
 
            del self._limbo_children_names[trans_id]
1399
 
        delete_any(self._limbo_name(trans_id))
1400
 
 
1401
 
    def new_orphan(self, trans_id, parent_id):
1402
 
        # FIXME: There is no tree config, so we use the branch one (it's weird
1403
 
        # to define it this way as orphaning can only occur in a working tree,
1404
 
        # but that's all we have (for now). It will find the option in
1405
 
        # locations.conf or bazaar.conf though) -- vila 20100916
1406
 
        conf = self._tree.branch.get_config()
1407
 
        conf_var_name = 'bzr.transform.orphan_policy'
1408
 
        orphan_policy = conf.get_user_option(conf_var_name)
1409
 
        default_policy = orphaning_registry.default_key
1410
 
        if orphan_policy is None:
1411
 
            orphan_policy = default_policy
1412
 
        if orphan_policy not in orphaning_registry:
1413
 
            trace.warning('%s (from %s) is not a known policy, defaulting '
1414
 
                'to %s' % (orphan_policy, conf_var_name, default_policy))
1415
 
            orphan_policy = default_policy
1416
 
        handle_orphan = orphaning_registry.get(orphan_policy)
1417
 
        handle_orphan(self, trans_id, parent_id)
1418
 
 
1419
 
 
1420
 
class OrphaningError(errors.BzrError):
1421
 
 
1422
 
    # Only bugs could lead to such exception being seen by the user
1423
 
    internal_error = True
1424
 
    _fmt = "Error while orphaning %s in %s directory"
1425
 
 
1426
 
    def __init__(self, orphan, parent):
1427
 
        errors.BzrError.__init__(self)
1428
 
        self.orphan = orphan
1429
 
        self.parent = parent
1430
 
 
1431
 
 
1432
 
class OrphaningForbidden(OrphaningError):
1433
 
 
1434
 
    _fmt = "Policy: %s doesn't allow creating orphans."
1435
 
 
1436
 
    def __init__(self, policy):
1437
 
        errors.BzrError.__init__(self)
1438
 
        self.policy = policy
1439
 
 
1440
 
 
1441
 
def move_orphan(tt, orphan_id, parent_id):
1442
 
    """See TreeTransformBase.new_orphan.
1443
 
 
1444
 
    This creates a new orphan in the `bzr-orphans` dir at the root of the
1445
 
    `TreeTransform`.
1446
 
 
1447
 
    :param tt: The TreeTransform orphaning `trans_id`.
1448
 
 
1449
 
    :param orphan_id: The trans id that should be orphaned.
1450
 
 
1451
 
    :param parent_id: The orphan parent trans id.
1452
 
    """
1453
 
    # Add the orphan dir if it doesn't exist
1454
 
    orphan_dir_basename = 'bzr-orphans'
1455
 
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
1456
 
    if tt.final_kind(od_id) is None:
1457
 
        tt.create_directory(od_id)
1458
 
    parent_path = tt._tree_id_paths[parent_id]
1459
 
    # Find a name that doesn't exist yet in the orphan dir
1460
 
    actual_name = tt.final_name(orphan_id)
1461
 
    new_name = tt._available_backup_name(actual_name, od_id)
1462
 
    tt.adjust_path(new_name, od_id, orphan_id)
1463
 
    trace.warning('%s has been orphaned in %s'
1464
 
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
1465
 
 
1466
 
 
1467
 
def refuse_orphan(tt, orphan_id, parent_id):
1468
 
    """See TreeTransformBase.new_orphan.
1469
 
 
1470
 
    This refuses to create orphan, letting the caller handle the conflict.
1471
 
    """
1472
 
    raise OrphaningForbidden('never')
1473
 
 
1474
 
 
1475
 
orphaning_registry = registry.Registry()
1476
 
orphaning_registry.register(
1477
 
    'conflict', refuse_orphan,
1478
 
    'Leave orphans in place and create a conflict on the directory.')
1479
 
orphaning_registry.register(
1480
 
    'move', move_orphan,
1481
 
    'Move orphans into the bzr-orphans directory.')
1482
 
orphaning_registry._set_default_key('conflict')
1483
 
 
1484
 
 
1485
 
class TreeTransform(DiskTreeTransform):
 
1075
 
 
1076
class TreeTransform(TreeTransformBase):
1486
1077
    """Represent a tree transformation.
1487
1078
 
1488
1079
    This object is designed to support incremental generation of the transform,
1547
1138
    FileMover does not delete files until it is sure that a rollback will not
1548
1139
    happen.
1549
1140
    """
1550
 
    def __init__(self, tree, pb=None):
 
1141
    def __init__(self, tree, pb=DummyProgress()):
1551
1142
        """Note: a tree_write lock is taken on the tree.
1552
1143
 
1553
1144
        Use TreeTransform.finalize() to release the lock (can be omitted if
1556
1147
        tree.lock_tree_write()
1557
1148
 
1558
1149
        try:
 
1150
            control_files = tree._control_files
1559
1151
            limbodir = urlutils.local_path_from_url(
1560
 
                tree._transport.abspath('limbo'))
 
1152
                control_files.controlfilename('limbo'))
1561
1153
            try:
1562
1154
                os.mkdir(limbodir)
1563
1155
            except OSError, e:
1564
1156
                if e.errno == errno.EEXIST:
1565
1157
                    raise ExistingLimbo(limbodir)
1566
1158
            deletiondir = urlutils.local_path_from_url(
1567
 
                tree._transport.abspath('pending-deletion'))
 
1159
                control_files.controlfilename('pending-deletion'))
1568
1160
            try:
1569
1161
                os.mkdir(deletiondir)
1570
1162
            except OSError, e:
1574
1166
            tree.unlock()
1575
1167
            raise
1576
1168
 
1577
 
        # Cache of realpath results, to speed up canonical_path
1578
 
        self._realpaths = {}
1579
 
        # Cache of relpath results, to speed up canonical_path
1580
 
        self._relpaths = {}
1581
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1169
        TreeTransformBase.__init__(self, tree, limbodir, pb,
1582
1170
                                   tree.case_sensitive)
1583
1171
        self._deletiondir = deletiondir
1584
1172
 
1585
 
    def canonical_path(self, path):
1586
 
        """Get the canonical tree-relative path"""
1587
 
        # don't follow final symlinks
1588
 
        abs = self._tree.abspath(path)
1589
 
        if abs in self._relpaths:
1590
 
            return self._relpaths[abs]
1591
 
        dirname, basename = os.path.split(abs)
1592
 
        if dirname not in self._realpaths:
1593
 
            self._realpaths[dirname] = os.path.realpath(dirname)
1594
 
        dirname = self._realpaths[dirname]
1595
 
        abs = pathjoin(dirname, basename)
1596
 
        if dirname in self._relpaths:
1597
 
            relpath = pathjoin(self._relpaths[dirname], basename)
1598
 
            relpath = relpath.rstrip('/\\')
1599
 
        else:
1600
 
            relpath = self._tree.relpath(abs)
1601
 
        self._relpaths[abs] = relpath
1602
 
        return relpath
1603
 
 
1604
 
    def tree_kind(self, trans_id):
1605
 
        """Determine the file kind in the working tree.
1606
 
 
1607
 
        :returns: The file kind or None if the file does not exist
1608
 
        """
1609
 
        path = self._tree_id_paths.get(trans_id)
1610
 
        if path is None:
1611
 
            return None
1612
 
        try:
1613
 
            return file_kind(self._tree.abspath(path))
1614
 
        except errors.NoSuchFile:
1615
 
            return None
1616
 
 
1617
 
    def _set_mode(self, trans_id, mode_id, typefunc):
1618
 
        """Set the mode of new file contents.
1619
 
        The mode_id is the existing file to get the mode from (often the same
1620
 
        as trans_id).  The operation is only performed if there's a mode match
1621
 
        according to typefunc.
1622
 
        """
1623
 
        if mode_id is None:
1624
 
            mode_id = trans_id
1625
 
        try:
1626
 
            old_path = self._tree_id_paths[mode_id]
1627
 
        except KeyError:
1628
 
            return
1629
 
        try:
1630
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
1631
 
        except OSError, e:
1632
 
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
1633
 
                # Either old_path doesn't exist, or the parent of the
1634
 
                # target is not a directory (but will be one eventually)
1635
 
                # Either way, we know it doesn't exist *right now*
1636
 
                # See also bug #248448
1637
 
                return
1638
 
            else:
1639
 
                raise
1640
 
        if typefunc(mode):
1641
 
            os.chmod(self._limbo_name(trans_id), mode)
1642
 
 
1643
 
    def iter_tree_children(self, parent_id):
1644
 
        """Iterate through the entry's tree children, if any"""
1645
 
        try:
1646
 
            path = self._tree_id_paths[parent_id]
1647
 
        except KeyError:
1648
 
            return
1649
 
        try:
1650
 
            children = os.listdir(self._tree.abspath(path))
1651
 
        except OSError, e:
1652
 
            if not (osutils._is_error_enotdir(e)
1653
 
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
1654
 
                raise
1655
 
            return
1656
 
 
1657
 
        for child in children:
1658
 
            childpath = joinpath(path, child)
1659
 
            if self._tree.is_control_filename(childpath):
1660
 
                continue
1661
 
            yield self.trans_id_tree_path(childpath)
1662
 
 
1663
 
    def _generate_limbo_path(self, trans_id):
1664
 
        """Generate a limbo path using the final path if possible.
1665
 
 
1666
 
        This optimizes the performance of applying the tree transform by
1667
 
        avoiding renames.  These renames can be avoided only when the parent
1668
 
        directory is already scheduled for creation.
1669
 
 
1670
 
        If the final path cannot be used, falls back to using the trans_id as
1671
 
        the relpath.
1672
 
        """
1673
 
        parent = self._new_parent.get(trans_id)
1674
 
        # if the parent directory is already in limbo (e.g. when building a
1675
 
        # tree), choose a limbo name inside the parent, to reduce further
1676
 
        # renames.
1677
 
        use_direct_path = False
1678
 
        if self._new_contents.get(parent) == 'directory':
1679
 
            filename = self._new_name.get(trans_id)
1680
 
            if filename is not None:
1681
 
                if parent not in self._limbo_children:
1682
 
                    self._limbo_children[parent] = set()
1683
 
                    self._limbo_children_names[parent] = {}
1684
 
                    use_direct_path = True
1685
 
                # the direct path can only be used if no other file has
1686
 
                # already taken this pathname, i.e. if the name is unused, or
1687
 
                # if it is already associated with this trans_id.
1688
 
                elif self._case_sensitive_target:
1689
 
                    if (self._limbo_children_names[parent].get(filename)
1690
 
                        in (trans_id, None)):
1691
 
                        use_direct_path = True
1692
 
                else:
1693
 
                    for l_filename, l_trans_id in\
1694
 
                        self._limbo_children_names[parent].iteritems():
1695
 
                        if l_trans_id == trans_id:
1696
 
                            continue
1697
 
                        if l_filename.lower() == filename.lower():
1698
 
                            break
1699
 
                    else:
1700
 
                        use_direct_path = True
1701
 
 
1702
 
        if not use_direct_path:
1703
 
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
1704
 
 
1705
 
        limbo_name = pathjoin(self._limbo_files[parent], filename)
1706
 
        self._limbo_children[parent].add(trans_id)
1707
 
        self._limbo_children_names[parent][filename] = trans_id
1708
 
        return limbo_name
1709
 
 
1710
 
 
1711
 
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1173
    def apply(self, no_conflicts=False, _mover=None):
1712
1174
        """Apply all changes to the inventory and filesystem.
1713
1175
 
1714
1176
        If filesystem or inventory conflicts are present, MalformedTransform
1718
1180
 
1719
1181
        :param no_conflicts: if True, the caller guarantees there are no
1720
1182
            conflicts, so no check is made.
1721
 
        :param precomputed_delta: An inventory delta to use instead of
1722
 
            calculating one.
1723
1183
        :param _mover: Supply an alternate FileMover, for testing
1724
1184
        """
1725
1185
        if not no_conflicts:
1726
 
            self._check_malformed()
1727
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1186
            conflicts = self.find_conflicts()
 
1187
            if len(conflicts) != 0:
 
1188
                raise MalformedTransform(conflicts=conflicts)
 
1189
        inventory_delta = []
 
1190
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1728
1191
        try:
1729
 
            if precomputed_delta is None:
1730
 
                child_pb.update(gettext('Apply phase'), 0, 2)
1731
 
                inventory_delta = self._generate_inventory_delta()
1732
 
                offset = 1
1733
 
            else:
1734
 
                inventory_delta = precomputed_delta
1735
 
                offset = 0
1736
1192
            if _mover is None:
1737
1193
                mover = _FileMover()
1738
1194
            else:
1739
1195
                mover = _mover
1740
1196
            try:
1741
 
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1742
 
                self._apply_removals(mover)
1743
 
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1744
 
                modified_paths = self._apply_insertions(mover)
 
1197
                child_pb.update('Apply phase', 0, 2)
 
1198
                self._apply_removals(inventory_delta, mover)
 
1199
                child_pb.update('Apply phase', 1, 2)
 
1200
                modified_paths = self._apply_insertions(inventory_delta, mover)
1745
1201
            except:
1746
1202
                mover.rollback()
1747
1203
                raise
1749
1205
                mover.apply_deletions()
1750
1206
        finally:
1751
1207
            child_pb.finished()
1752
 
        if self.final_file_id(self.root) is None:
1753
 
            inventory_delta = [e for e in inventory_delta if e[0] != '']
1754
1208
        self._tree.apply_inventory_delta(inventory_delta)
1755
 
        self._apply_observed_sha1s()
1756
1209
        self._done = True
1757
1210
        self.finalize()
1758
1211
        return _TransformResults(modified_paths, self.rename_count)
1759
1212
 
1760
 
    def _generate_inventory_delta(self):
1761
 
        """Generate an inventory delta for the current transform."""
1762
 
        inventory_delta = []
1763
 
        child_pb = ui.ui_factory.nested_progress_bar()
1764
 
        new_paths = self._inventory_altered()
1765
 
        total_entries = len(new_paths) + len(self._removed_id)
1766
 
        try:
1767
 
            for num, trans_id in enumerate(self._removed_id):
1768
 
                if (num % 10) == 0:
1769
 
                    child_pb.update(gettext('removing file'), num, total_entries)
1770
 
                if trans_id == self._new_root:
1771
 
                    file_id = self._tree.get_root_id()
1772
 
                else:
1773
 
                    file_id = self.tree_file_id(trans_id)
1774
 
                # File-id isn't really being deleted, just moved
1775
 
                if file_id in self._r_new_id:
1776
 
                    continue
1777
 
                path = self._tree_id_paths[trans_id]
1778
 
                inventory_delta.append((path, None, file_id, None))
1779
 
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1780
 
                                     new_paths)
1781
 
            entries = self._tree.iter_entries_by_dir(
1782
 
                new_path_file_ids.values())
1783
 
            old_paths = dict((e.file_id, p) for p, e in entries)
1784
 
            final_kinds = {}
1785
 
            for num, (path, trans_id) in enumerate(new_paths):
1786
 
                if (num % 10) == 0:
1787
 
                    child_pb.update(gettext('adding file'),
1788
 
                                    num + len(self._removed_id), total_entries)
1789
 
                file_id = new_path_file_ids[trans_id]
1790
 
                if file_id is None:
1791
 
                    continue
1792
 
                needs_entry = False
1793
 
                kind = self.final_kind(trans_id)
1794
 
                if kind is None:
1795
 
                    kind = self._tree.stored_kind(file_id)
1796
 
                parent_trans_id = self.final_parent(trans_id)
1797
 
                parent_file_id = new_path_file_ids.get(parent_trans_id)
1798
 
                if parent_file_id is None:
1799
 
                    parent_file_id = self.final_file_id(parent_trans_id)
1800
 
                if trans_id in self._new_reference_revision:
1801
 
                    new_entry = inventory.TreeReference(
1802
 
                        file_id,
1803
 
                        self._new_name[trans_id],
1804
 
                        self.final_file_id(self._new_parent[trans_id]),
1805
 
                        None, self._new_reference_revision[trans_id])
1806
 
                else:
1807
 
                    new_entry = inventory.make_entry(kind,
1808
 
                        self.final_name(trans_id),
1809
 
                        parent_file_id, file_id)
1810
 
                old_path = old_paths.get(new_entry.file_id)
1811
 
                new_executability = self._new_executability.get(trans_id)
1812
 
                if new_executability is not None:
1813
 
                    new_entry.executable = new_executability
1814
 
                inventory_delta.append(
1815
 
                    (old_path, path, new_entry.file_id, new_entry))
1816
 
        finally:
1817
 
            child_pb.finished()
1818
 
        return inventory_delta
1819
 
 
1820
 
    def _apply_removals(self, mover):
 
1213
    def _apply_removals(self, inventory_delta, mover):
1821
1214
        """Perform tree operations that remove directory/inventory names.
1822
1215
 
1823
1216
        That is, delete files that are to be deleted, and put any files that
1824
1217
        need renaming into limbo.  This must be done in strict child-to-parent
1825
1218
        order.
1826
 
 
1827
 
        If inventory_delta is None, no inventory delta generation is performed.
1828
1219
        """
1829
1220
        tree_paths = list(self._tree_path_ids.iteritems())
1830
1221
        tree_paths.sort(reverse=True)
1831
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1222
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1832
1223
        try:
1833
 
            for num, (path, trans_id) in enumerate(tree_paths):
1834
 
                # do not attempt to move root into a subdirectory of itself.
1835
 
                if path == '':
1836
 
                    continue
1837
 
                child_pb.update(gettext('removing file'), num, len(tree_paths))
 
1224
            for num, data in enumerate(tree_paths):
 
1225
                path, trans_id = data
 
1226
                child_pb.update('removing file', num, len(tree_paths))
1838
1227
                full_path = self._tree.abspath(path)
1839
1228
                if trans_id in self._removed_contents:
1840
 
                    delete_path = os.path.join(self._deletiondir, trans_id)
1841
 
                    mover.pre_delete(full_path, delete_path)
1842
 
                elif (trans_id in self._new_name
1843
 
                      or trans_id in self._new_parent):
 
1229
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
 
1230
                                     trans_id))
 
1231
                elif trans_id in self._new_name or trans_id in \
 
1232
                    self._new_parent:
1844
1233
                    try:
1845
1234
                        mover.rename(full_path, self._limbo_name(trans_id))
1846
 
                    except errors.TransformRenameFailed, e:
 
1235
                    except OSError, e:
1847
1236
                        if e.errno != errno.ENOENT:
1848
1237
                            raise
1849
1238
                    else:
1850
1239
                        self.rename_count += 1
 
1240
                if trans_id in self._removed_id:
 
1241
                    if trans_id == self._new_root:
 
1242
                        file_id = self._tree.get_root_id()
 
1243
                    else:
 
1244
                        file_id = self.tree_file_id(trans_id)
 
1245
                    assert file_id is not None
 
1246
                    # File-id isn't really being deleted, just moved
 
1247
                    if file_id in self._r_new_id:
 
1248
                        continue
 
1249
                    inventory_delta.append((path, None, file_id, None))
1851
1250
        finally:
1852
1251
            child_pb.finished()
1853
1252
 
1854
 
    def _apply_insertions(self, mover):
 
1253
    def _apply_insertions(self, inventory_delta, mover):
1855
1254
        """Perform tree operations that insert directory/inventory names.
1856
1255
 
1857
1256
        That is, create any files that need to be created, and restore from
1858
1257
        limbo any files that needed renaming.  This must be done in strict
1859
1258
        parent-to-child order.
1860
 
 
1861
 
        If inventory_delta is None, no inventory delta is calculated, and
1862
 
        no list of modified paths is returned.
1863
1259
        """
1864
 
        new_paths = self.new_paths(filesystem_only=True)
 
1260
        new_paths = self.new_paths()
1865
1261
        modified_paths = []
1866
 
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1867
 
                                 new_paths)
1868
 
        child_pb = ui.ui_factory.nested_progress_bar()
 
1262
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1263
        completed_new = []
1869
1264
        try:
1870
1265
            for num, (path, trans_id) in enumerate(new_paths):
1871
 
                if (num % 10) == 0:
1872
 
                    child_pb.update(gettext('adding file'), num, len(new_paths))
1873
 
                full_path = self._tree.abspath(path)
1874
 
                if trans_id in self._needs_rename:
1875
 
                    try:
1876
 
                        mover.rename(self._limbo_name(trans_id), full_path)
1877
 
                    except errors.TransformRenameFailed, e:
1878
 
                        # We may be renaming a dangling inventory id
1879
 
                        if e.errno != errno.ENOENT:
1880
 
                            raise
1881
 
                    else:
1882
 
                        self.rename_count += 1
1883
 
                    # TODO: if trans_id in self._observed_sha1s, we should
1884
 
                    #       re-stat the final target, since ctime will be
1885
 
                    #       updated by the change.
1886
 
                if (trans_id in self._new_contents or
1887
 
                    self.path_changed(trans_id)):
 
1266
                new_entry = None
 
1267
                child_pb.update('adding file', num, len(new_paths))
 
1268
                if trans_id in self._new_contents or \
 
1269
                    self.path_changed(trans_id):
 
1270
                    full_path = self._tree.abspath(path)
 
1271
                    if trans_id in self._needs_rename:
 
1272
                        try:
 
1273
                            mover.rename(self._limbo_name(trans_id), full_path)
 
1274
                        except OSError, e:
 
1275
                            # We may be renaming a dangling inventory id
 
1276
                            if e.errno != errno.ENOENT:
 
1277
                                raise
 
1278
                        else:
 
1279
                            self.rename_count += 1
1888
1280
                    if trans_id in self._new_contents:
1889
1281
                        modified_paths.append(full_path)
 
1282
                        completed_new.append(trans_id)
 
1283
                file_id = self.final_file_id(trans_id)
 
1284
                if file_id is not None and (trans_id in self._new_id or
 
1285
                    trans_id in self._new_name or trans_id in self._new_parent
 
1286
                    or trans_id in self._new_executability):
 
1287
                    try:
 
1288
                        kind = self.final_kind(trans_id)
 
1289
                    except NoSuchFile:
 
1290
                        kind = self._tree.stored_kind(file_id)
 
1291
                    if trans_id in self._new_reference_revision:
 
1292
                        new_entry = inventory.TreeReference(
 
1293
                            self.final_file_id(trans_id),
 
1294
                            self._new_name[trans_id],
 
1295
                            self.final_file_id(self._new_parent[trans_id]),
 
1296
                            None, self._new_reference_revision[trans_id])
 
1297
                    else:
 
1298
                        new_entry = inventory.make_entry(kind,
 
1299
                            self.final_name(trans_id),
 
1300
                            self.final_file_id(self.final_parent(trans_id)),
 
1301
                            self.final_file_id(trans_id))
 
1302
                    try:
 
1303
                        old_path = self._tree.id2path(new_entry.file_id)
 
1304
                    except errors.NoSuchId:
 
1305
                        old_path = None
 
1306
                    inventory_delta.append((old_path, path, new_entry.file_id,
 
1307
                                            new_entry))
 
1308
 
1890
1309
                if trans_id in self._new_executability:
1891
 
                    self._set_executability(path, trans_id)
1892
 
                if trans_id in self._observed_sha1s:
1893
 
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
1894
 
                    st = osutils.lstat(full_path)
1895
 
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1310
                    self._set_executability(path, new_entry, trans_id)
1896
1311
        finally:
1897
1312
            child_pb.finished()
1898
 
        for path, trans_id in new_paths:
1899
 
            # new_paths includes stuff like workingtree conflicts. Only the
1900
 
            # stuff in new_contents actually comes from limbo.
1901
 
            if trans_id in self._limbo_files:
1902
 
                del self._limbo_files[trans_id]
1903
 
        self._new_contents.clear()
 
1313
        for trans_id in completed_new:
 
1314
            del self._new_contents[trans_id]
1904
1315
        return modified_paths
1905
1316
 
1906
 
    def _apply_observed_sha1s(self):
1907
 
        """After we have finished renaming everything, update observed sha1s
1908
 
 
1909
 
        This has to be done after self._tree.apply_inventory_delta, otherwise
1910
 
        it doesn't know anything about the files we are updating. Also, we want
1911
 
        to do this as late as possible, so that most entries end up cached.
1912
 
        """
1913
 
        # TODO: this doesn't update the stat information for directories. So
1914
 
        #       the first 'bzr status' will still need to rewrite
1915
 
        #       .bzr/checkout/dirstate. However, we at least don't need to
1916
 
        #       re-read all of the files.
1917
 
        # TODO: If the operation took a while, we could do a time.sleep(3) here
1918
 
        #       to allow the clock to tick over and ensure we won't have any
1919
 
        #       problems. (we could observe start time, and finish time, and if
1920
 
        #       it is less than eg 10% overhead, add a sleep call.)
1921
 
        paths = FinalPaths(self)
1922
 
        for trans_id, observed in self._observed_sha1s.iteritems():
1923
 
            path = paths.get_path(trans_id)
1924
 
            # We could get the file_id, but dirstate prefers to use the path
1925
 
            # anyway, and it is 'cheaper' to determine.
1926
 
            # file_id = self._new_id[trans_id]
1927
 
            self._tree._observed_sha1(None, path, observed)
1928
 
 
1929
 
 
1930
 
class TransformPreview(DiskTreeTransform):
 
1317
 
 
1318
class TransformPreview(TreeTransformBase):
1931
1319
    """A TreeTransform for generating preview trees.
1932
1320
 
1933
1321
    Unlike TreeTransform, this version works when the input tree is a
1935
1323
    unversioned files in the input tree.
1936
1324
    """
1937
1325
 
1938
 
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1326
    def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1939
1327
        tree.lock_read()
1940
 
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1941
 
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1328
        limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
 
1329
        TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1942
1330
 
1943
1331
    def canonical_path(self, path):
1944
1332
        return path
1946
1334
    def tree_kind(self, trans_id):
1947
1335
        path = self._tree_id_paths.get(trans_id)
1948
1336
        if path is None:
1949
 
            return None
1950
 
        kind = self._tree.path_content_summary(path)[0]
1951
 
        if kind == 'missing':
1952
 
            kind = None
1953
 
        return kind
 
1337
            raise NoSuchFile(None)
 
1338
        file_id = self._tree.path2id(path)
 
1339
        return self._tree.kind(file_id)
1954
1340
 
1955
1341
    def _set_mode(self, trans_id, mode_id, typefunc):
1956
1342
        """Set the mode of new file contents.
1968
1354
        except KeyError:
1969
1355
            return
1970
1356
        file_id = self.tree_file_id(parent_id)
1971
 
        if file_id is None:
1972
 
            return
1973
 
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1974
 
        children = getattr(entry, 'children', {})
1975
 
        for child in children:
 
1357
        for child in self._tree.inventory[file_id].children.iterkeys():
1976
1358
            childpath = joinpath(path, child)
1977
1359
            yield self.trans_id_tree_path(childpath)
1978
1360
 
1979
 
    def new_orphan(self, trans_id, parent_id):
1980
 
        raise NotImplementedError(self.new_orphan)
1981
 
 
1982
 
 
1983
 
class _PreviewTree(tree.InventoryTree):
 
1361
 
 
1362
class _PreviewTree(object):
1984
1363
    """Partial implementation of Tree to support show_diff_trees"""
1985
1364
 
1986
1365
    def __init__(self, transform):
1987
1366
        self._transform = transform
1988
 
        self._final_paths = FinalPaths(transform)
1989
 
        self.__by_parent = None
1990
 
        self._parent_ids = []
1991
 
        self._all_children_cache = {}
1992
 
        self._path2trans_id_cache = {}
1993
 
        self._final_name_cache = {}
1994
 
        self._iter_changes_cache = dict((c[0], c) for c in
1995
 
                                        self._transform.iter_changes())
1996
 
 
1997
 
    def _content_change(self, file_id):
1998
 
        """Return True if the content of this file changed"""
1999
 
        changes = self._iter_changes_cache.get(file_id)
2000
 
        # changes[2] is true if the file content changed.  See
2001
 
        # InterTree.iter_changes.
2002
 
        return (changes is not None and changes[2])
2003
 
 
2004
 
    def _get_repository(self):
2005
 
        repo = getattr(self._transform._tree, '_repository', None)
2006
 
        if repo is None:
2007
 
            repo = self._transform._tree.branch.repository
2008
 
        return repo
2009
 
 
2010
 
    def _iter_parent_trees(self):
2011
 
        for revision_id in self.get_parent_ids():
2012
 
            try:
2013
 
                yield self.revision_tree(revision_id)
2014
 
            except errors.NoSuchRevisionInTree:
2015
 
                yield self._get_repository().revision_tree(revision_id)
2016
 
 
2017
 
    def _get_file_revision(self, file_id, vf, tree_revision):
2018
 
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2019
 
                       self._iter_parent_trees()]
2020
 
        vf.add_lines((file_id, tree_revision), parent_keys,
2021
 
                     self.get_file_lines(file_id))
2022
 
        repo = self._get_repository()
2023
 
        base_vf = repo.texts
2024
 
        if base_vf not in vf.fallback_versionedfiles:
2025
 
            vf.fallback_versionedfiles.append(base_vf)
2026
 
        return tree_revision
2027
 
 
2028
 
    def _stat_limbo_file(self, file_id=None, trans_id=None):
2029
 
        if trans_id is None:
2030
 
            trans_id = self._transform.trans_id_file_id(file_id)
2031
 
        name = self._transform._limbo_name(trans_id)
2032
 
        return os.lstat(name)
2033
 
 
2034
 
    @property
2035
 
    def _by_parent(self):
2036
 
        if self.__by_parent is None:
2037
 
            self.__by_parent = self._transform.by_parent()
2038
 
        return self.__by_parent
2039
 
 
2040
 
    def _comparison_data(self, entry, path):
2041
 
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2042
 
        if kind == 'missing':
2043
 
            kind = None
2044
 
            executable = False
2045
 
        else:
2046
 
            file_id = self._transform.final_file_id(self._path2trans_id(path))
2047
 
            executable = self.is_executable(file_id, path)
2048
 
        return kind, executable, None
2049
 
 
2050
 
    def is_locked(self):
2051
 
        return False
2052
1367
 
2053
1368
    def lock_read(self):
2054
1369
        # Perhaps in theory, this should lock the TreeTransform?
2055
 
        return self
 
1370
        pass
2056
1371
 
2057
1372
    def unlock(self):
2058
1373
        pass
2059
1374
 
2060
 
    @property
2061
 
    def inventory(self):
2062
 
        """This Tree does not use inventory as its backing data."""
2063
 
        raise NotImplementedError(_PreviewTree.inventory)
2064
 
 
2065
 
    def get_root_id(self):
2066
 
        return self._transform.final_file_id(self._transform.root)
2067
 
 
2068
 
    def all_file_ids(self):
2069
 
        tree_ids = set(self._transform._tree.all_file_ids())
2070
 
        tree_ids.difference_update(self._transform.tree_file_id(t)
2071
 
                                   for t in self._transform._removed_id)
2072
 
        tree_ids.update(self._transform._new_id.values())
2073
 
        return tree_ids
2074
 
 
2075
 
    def __iter__(self):
2076
 
        return iter(self.all_file_ids())
2077
 
 
2078
 
    def _has_id(self, file_id, fallback_check):
2079
 
        if file_id in self._transform._r_new_id:
2080
 
            return True
2081
 
        elif file_id in set([self._transform.tree_file_id(trans_id) for
2082
 
            trans_id in self._transform._removed_id]):
2083
 
            return False
2084
 
        else:
2085
 
            return fallback_check(file_id)
2086
 
 
2087
 
    def has_id(self, file_id):
2088
 
        return self._has_id(file_id, self._transform._tree.has_id)
2089
 
 
2090
 
    def has_or_had_id(self, file_id):
2091
 
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
2092
 
 
2093
 
    def _path2trans_id(self, path):
2094
 
        # We must not use None here, because that is a valid value to store.
2095
 
        trans_id = self._path2trans_id_cache.get(path, object)
2096
 
        if trans_id is not object:
2097
 
            return trans_id
2098
 
        segments = splitpath(path)
2099
 
        cur_parent = self._transform.root
2100
 
        for cur_segment in segments:
2101
 
            for child in self._all_children(cur_parent):
2102
 
                final_name = self._final_name_cache.get(child)
2103
 
                if final_name is None:
2104
 
                    final_name = self._transform.final_name(child)
2105
 
                    self._final_name_cache[child] = final_name
2106
 
                if final_name == cur_segment:
2107
 
                    cur_parent = child
2108
 
                    break
2109
 
            else:
2110
 
                self._path2trans_id_cache[path] = None
2111
 
                return None
2112
 
        self._path2trans_id_cache[path] = cur_parent
2113
 
        return cur_parent
2114
 
 
2115
 
    def path2id(self, path):
2116
 
        return self._transform.final_file_id(self._path2trans_id(path))
2117
 
 
2118
 
    def id2path(self, file_id):
2119
 
        trans_id = self._transform.trans_id_file_id(file_id)
2120
 
        try:
2121
 
            return self._final_paths._determine_path(trans_id)
2122
 
        except NoFinalPath:
2123
 
            raise errors.NoSuchId(self, file_id)
2124
 
 
2125
 
    def _all_children(self, trans_id):
2126
 
        children = self._all_children_cache.get(trans_id)
2127
 
        if children is not None:
2128
 
            return children
2129
 
        children = set(self._transform.iter_tree_children(trans_id))
2130
 
        # children in the _new_parent set are provided by _by_parent.
2131
 
        children.difference_update(self._transform._new_parent.keys())
2132
 
        children.update(self._by_parent.get(trans_id, []))
2133
 
        self._all_children_cache[trans_id] = children
2134
 
        return children
2135
 
 
2136
 
    def iter_children(self, file_id):
2137
 
        trans_id = self._transform.trans_id_file_id(file_id)
2138
 
        for child_trans_id in self._all_children(trans_id):
2139
 
            yield self._transform.final_file_id(child_trans_id)
2140
 
 
2141
 
    def extras(self):
2142
 
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
2143
 
                              in self._transform._tree.extras())
2144
 
        possible_extras.update(self._transform._new_contents)
2145
 
        possible_extras.update(self._transform._removed_id)
2146
 
        for trans_id in possible_extras:
2147
 
            if self._transform.final_file_id(trans_id) is None:
2148
 
                yield self._final_paths._determine_path(trans_id)
2149
 
 
2150
 
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2151
 
        yield_parents=False):
2152
 
        for trans_id, parent_file_id in ordered_entries:
2153
 
            file_id = self._transform.final_file_id(trans_id)
2154
 
            if file_id is None:
2155
 
                continue
2156
 
            if (specific_file_ids is not None
2157
 
                and file_id not in specific_file_ids):
2158
 
                continue
2159
 
            kind = self._transform.final_kind(trans_id)
2160
 
            if kind is None:
2161
 
                kind = self._transform._tree.stored_kind(file_id)
2162
 
            new_entry = inventory.make_entry(
2163
 
                kind,
2164
 
                self._transform.final_name(trans_id),
2165
 
                parent_file_id, file_id)
2166
 
            yield new_entry, trans_id
2167
 
 
2168
 
    def _list_files_by_dir(self):
2169
 
        todo = [ROOT_PARENT]
2170
 
        ordered_ids = []
2171
 
        while len(todo) > 0:
2172
 
            parent = todo.pop()
2173
 
            parent_file_id = self._transform.final_file_id(parent)
2174
 
            children = list(self._all_children(parent))
2175
 
            paths = dict(zip(children, self._final_paths.get_paths(children)))
2176
 
            children.sort(key=paths.get)
2177
 
            todo.extend(reversed(children))
2178
 
            for trans_id in children:
2179
 
                ordered_ids.append((trans_id, parent_file_id))
2180
 
        return ordered_ids
2181
 
 
2182
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2183
 
        # This may not be a maximally efficient implementation, but it is
2184
 
        # reasonably straightforward.  An implementation that grafts the
2185
 
        # TreeTransform changes onto the tree's iter_entries_by_dir results
2186
 
        # might be more efficient, but requires tricky inferences about stack
2187
 
        # position.
2188
 
        ordered_ids = self._list_files_by_dir()
2189
 
        for entry, trans_id in self._make_inv_entries(ordered_ids,
2190
 
            specific_file_ids, yield_parents=yield_parents):
2191
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2192
 
 
2193
 
    def _iter_entries_for_dir(self, dir_path):
2194
 
        """Return path, entry for items in a directory without recursing down."""
2195
 
        dir_file_id = self.path2id(dir_path)
2196
 
        ordered_ids = []
2197
 
        for file_id in self.iter_children(dir_file_id):
2198
 
            trans_id = self._transform.trans_id_file_id(file_id)
2199
 
            ordered_ids.append((trans_id, file_id))
2200
 
        for entry, trans_id in self._make_inv_entries(ordered_ids):
2201
 
            yield unicode(self._final_paths.get_path(trans_id)), entry
2202
 
 
2203
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
2204
 
        """See WorkingTree.list_files."""
2205
 
        # XXX This should behave like WorkingTree.list_files, but is really
2206
 
        # more like RevisionTree.list_files.
2207
 
        if recursive:
2208
 
            prefix = None
2209
 
            if from_dir:
2210
 
                prefix = from_dir + '/'
2211
 
            entries = self.iter_entries_by_dir()
2212
 
            for path, entry in entries:
2213
 
                if entry.name == '' and not include_root:
2214
 
                    continue
2215
 
                if prefix:
2216
 
                    if not path.startswith(prefix):
2217
 
                        continue
2218
 
                    path = path[len(prefix):]
2219
 
                yield path, 'V', entry.kind, entry.file_id, entry
2220
 
        else:
2221
 
            if from_dir is None and include_root is True:
2222
 
                root_entry = inventory.make_entry('directory', '',
2223
 
                    ROOT_PARENT, self.get_root_id())
2224
 
                yield '', 'V', 'directory', root_entry.file_id, root_entry
2225
 
            entries = self._iter_entries_for_dir(from_dir or '')
2226
 
            for path, entry in entries:
2227
 
                yield path, 'V', entry.kind, entry.file_id, entry
2228
 
 
2229
 
    def kind(self, file_id):
2230
 
        trans_id = self._transform.trans_id_file_id(file_id)
2231
 
        return self._transform.final_kind(trans_id)
2232
 
 
2233
 
    def stored_kind(self, file_id):
2234
 
        trans_id = self._transform.trans_id_file_id(file_id)
2235
 
        try:
2236
 
            return self._transform._new_contents[trans_id]
2237
 
        except KeyError:
2238
 
            return self._transform._tree.stored_kind(file_id)
2239
 
 
2240
 
    def get_file_mtime(self, file_id, path=None):
2241
 
        """See Tree.get_file_mtime"""
2242
 
        if not self._content_change(file_id):
2243
 
            return self._transform._tree.get_file_mtime(file_id)
2244
 
        return self._stat_limbo_file(file_id).st_mtime
2245
 
 
2246
 
    def _file_size(self, entry, stat_value):
2247
 
        return self.get_file_size(entry.file_id)
2248
 
 
2249
 
    def get_file_size(self, file_id):
2250
 
        """See Tree.get_file_size"""
2251
 
        trans_id = self._transform.trans_id_file_id(file_id)
2252
 
        kind = self._transform.final_kind(trans_id)
2253
 
        if kind != 'file':
2254
 
            return None
2255
 
        if trans_id in self._transform._new_contents:
2256
 
            return self._stat_limbo_file(trans_id=trans_id).st_size
2257
 
        if self.kind(file_id) == 'file':
2258
 
            return self._transform._tree.get_file_size(file_id)
2259
 
        else:
2260
 
            return None
2261
 
 
2262
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
2263
 
        trans_id = self._transform.trans_id_file_id(file_id)
2264
 
        kind = self._transform._new_contents.get(trans_id)
2265
 
        if kind is None:
2266
 
            return self._transform._tree.get_file_verifier(file_id)
2267
 
        if kind == 'file':
2268
 
            fileobj = self.get_file(file_id)
2269
 
            try:
2270
 
                return ("SHA1", sha_file(fileobj))
2271
 
            finally:
2272
 
                fileobj.close()
2273
 
 
2274
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
2275
 
        trans_id = self._transform.trans_id_file_id(file_id)
2276
 
        kind = self._transform._new_contents.get(trans_id)
2277
 
        if kind is None:
2278
 
            return self._transform._tree.get_file_sha1(file_id)
2279
 
        if kind == 'file':
2280
 
            fileobj = self.get_file(file_id)
2281
 
            try:
2282
 
                return sha_file(fileobj)
2283
 
            finally:
2284
 
                fileobj.close()
2285
 
 
2286
 
    def is_executable(self, file_id, path=None):
2287
 
        if file_id is None:
2288
 
            return False
2289
 
        trans_id = self._transform.trans_id_file_id(file_id)
2290
 
        try:
2291
 
            return self._transform._new_executability[trans_id]
2292
 
        except KeyError:
2293
 
            try:
2294
 
                return self._transform._tree.is_executable(file_id, path)
2295
 
            except OSError, e:
2296
 
                if e.errno == errno.ENOENT:
2297
 
                    return False
2298
 
                raise
2299
 
            except errors.NoSuchId:
2300
 
                return False
2301
 
 
2302
 
    def has_filename(self, path):
2303
 
        trans_id = self._path2trans_id(path)
2304
 
        if trans_id in self._transform._new_contents:
2305
 
            return True
2306
 
        elif trans_id in self._transform._removed_contents:
2307
 
            return False
2308
 
        else:
2309
 
            return self._transform._tree.has_filename(path)
2310
 
 
2311
 
    def path_content_summary(self, path):
2312
 
        trans_id = self._path2trans_id(path)
2313
 
        tt = self._transform
2314
 
        tree_path = tt._tree_id_paths.get(trans_id)
2315
 
        kind = tt._new_contents.get(trans_id)
2316
 
        if kind is None:
2317
 
            if tree_path is None or trans_id in tt._removed_contents:
2318
 
                return 'missing', None, None, None
2319
 
            summary = tt._tree.path_content_summary(tree_path)
2320
 
            kind, size, executable, link_or_sha1 = summary
2321
 
        else:
2322
 
            link_or_sha1 = None
2323
 
            limbo_name = tt._limbo_name(trans_id)
2324
 
            if trans_id in tt._new_reference_revision:
2325
 
                kind = 'tree-reference'
2326
 
            if kind == 'file':
2327
 
                statval = os.lstat(limbo_name)
2328
 
                size = statval.st_size
2329
 
                if not supports_executable():
2330
 
                    executable = False
2331
 
                else:
2332
 
                    executable = statval.st_mode & S_IEXEC
2333
 
            else:
2334
 
                size = None
2335
 
                executable = None
2336
 
            if kind == 'symlink':
2337
 
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2338
 
        executable = tt._new_executability.get(trans_id, executable)
2339
 
        return kind, size, executable, link_or_sha1
2340
 
 
2341
1375
    def iter_changes(self, from_tree, include_unchanged=False,
2342
1376
                      specific_files=None, pb=None, extra_trees=None,
2343
1377
                      require_versioned=True, want_unversioned=False):
2344
1378
        """See InterTree.iter_changes.
2345
1379
 
2346
 
        This has a fast path that is only used when the from_tree matches
2347
 
        the transform tree, and no fancy options are supplied.
 
1380
        This implementation does not support include_unchanged, specific_files,
 
1381
        or want_unversioned.  extra_trees, require_versioned, and pb are
 
1382
        ignored.
2348
1383
        """
2349
 
        if (from_tree is not self._transform._tree or include_unchanged or
2350
 
            specific_files or want_unversioned):
2351
 
            return tree.InterTree(from_tree, self).iter_changes(
2352
 
                include_unchanged=include_unchanged,
2353
 
                specific_files=specific_files,
2354
 
                pb=pb,
2355
 
                extra_trees=extra_trees,
2356
 
                require_versioned=require_versioned,
2357
 
                want_unversioned=want_unversioned)
 
1384
        if from_tree is not self._transform._tree:
 
1385
            raise ValueError('from_tree must be transform source tree.')
 
1386
        if include_unchanged:
 
1387
            raise ValueError('include_unchanged is not supported')
 
1388
        if specific_files is not None:
 
1389
            raise ValueError('specific_files is not supported')
2358
1390
        if want_unversioned:
2359
1391
            raise ValueError('want_unversioned is not supported')
2360
1392
        return self._transform.iter_changes()
2361
1393
 
2362
 
    def get_file(self, file_id, path=None):
 
1394
    def kind(self, file_id):
 
1395
        trans_id = self._transform.trans_id_file_id(file_id)
 
1396
        return self._transform.final_kind(trans_id)
 
1397
 
 
1398
    def get_file_mtime(self, file_id, path=None):
 
1399
        """See Tree.get_file_mtime"""
 
1400
        trans_id = self._transform.trans_id_file_id(file_id)
 
1401
        name = self._transform._limbo_name(trans_id)
 
1402
        return os.stat(name).st_mtime
 
1403
 
 
1404
    def get_file(self, file_id):
2363
1405
        """See Tree.get_file"""
2364
 
        if not self._content_change(file_id):
2365
 
            return self._transform._tree.get_file(file_id, path)
2366
1406
        trans_id = self._transform.trans_id_file_id(file_id)
2367
1407
        name = self._transform._limbo_name(trans_id)
2368
1408
        return open(name, 'rb')
2369
1409
 
2370
 
    def get_file_with_stat(self, file_id, path=None):
2371
 
        return self.get_file(file_id, path), None
2372
 
 
2373
 
    def annotate_iter(self, file_id,
2374
 
                      default_revision=_mod_revision.CURRENT_REVISION):
2375
 
        changes = self._iter_changes_cache.get(file_id)
2376
 
        if changes is None:
2377
 
            get_old = True
2378
 
        else:
2379
 
            changed_content, versioned, kind = (changes[2], changes[3],
2380
 
                                                changes[6])
2381
 
            if kind[1] is None:
2382
 
                return None
2383
 
            get_old = (kind[0] == 'file' and versioned[0])
2384
 
        if get_old:
2385
 
            old_annotation = self._transform._tree.annotate_iter(file_id,
2386
 
                default_revision=default_revision)
2387
 
        else:
2388
 
            old_annotation = []
2389
 
        if changes is None:
2390
 
            return old_annotation
2391
 
        if not changed_content:
2392
 
            return old_annotation
2393
 
        # TODO: This is doing something similar to what WT.annotate_iter is
2394
 
        #       doing, however it fails slightly because it doesn't know what
2395
 
        #       the *other* revision_id is, so it doesn't know how to give the
2396
 
        #       other as the origin for some lines, they all get
2397
 
        #       'default_revision'
2398
 
        #       It would be nice to be able to use the new Annotator based
2399
 
        #       approach, as well.
2400
 
        return annotate.reannotate([old_annotation],
2401
 
                                   self.get_file(file_id).readlines(),
2402
 
                                   default_revision)
2403
 
 
2404
 
    def get_symlink_target(self, file_id, path=None):
 
1410
    def get_symlink_target(self, file_id):
2405
1411
        """See Tree.get_symlink_target"""
2406
 
        if not self._content_change(file_id):
2407
 
            return self._transform._tree.get_symlink_target(file_id)
2408
1412
        trans_id = self._transform.trans_id_file_id(file_id)
2409
1413
        name = self._transform._limbo_name(trans_id)
2410
 
        return osutils.readlink(name)
2411
 
 
2412
 
    def walkdirs(self, prefix=''):
2413
 
        pending = [self._transform.root]
2414
 
        while len(pending) > 0:
2415
 
            parent_id = pending.pop()
2416
 
            children = []
2417
 
            subdirs = []
2418
 
            prefix = prefix.rstrip('/')
2419
 
            parent_path = self._final_paths.get_path(parent_id)
2420
 
            parent_file_id = self._transform.final_file_id(parent_id)
2421
 
            for child_id in self._all_children(parent_id):
2422
 
                path_from_root = self._final_paths.get_path(child_id)
2423
 
                basename = self._transform.final_name(child_id)
2424
 
                file_id = self._transform.final_file_id(child_id)
2425
 
                kind  = self._transform.final_kind(child_id)
2426
 
                if kind is not None:
2427
 
                    versioned_kind = kind
2428
 
                else:
2429
 
                    kind = 'unknown'
2430
 
                    versioned_kind = self._transform._tree.stored_kind(file_id)
2431
 
                if versioned_kind == 'directory':
2432
 
                    subdirs.append(child_id)
2433
 
                children.append((path_from_root, basename, kind, None,
2434
 
                                 file_id, versioned_kind))
2435
 
            children.sort()
2436
 
            if parent_path.startswith(prefix):
2437
 
                yield (parent_path, parent_file_id), children
2438
 
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2439
 
                                  reverse=True))
2440
 
 
2441
 
    def get_parent_ids(self):
2442
 
        return self._parent_ids
2443
 
 
2444
 
    def set_parent_ids(self, parent_ids):
2445
 
        self._parent_ids = parent_ids
2446
 
 
2447
 
    def get_revision_tree(self, revision_id):
2448
 
        return self._transform._tree.get_revision_tree(revision_id)
 
1414
        return os.readlink(name)
 
1415
 
 
1416
    def paths2ids(self, specific_files, trees=None, require_versioned=False):
 
1417
        """See Tree.paths2ids"""
 
1418
        return 'not_empty'
2449
1419
 
2450
1420
 
2451
1421
def joinpath(parent, child):
2468
1438
        self.transform = transform
2469
1439
 
2470
1440
    def _determine_path(self, trans_id):
2471
 
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
 
1441
        if trans_id == self.transform.root:
2472
1442
            return ""
2473
1443
        name = self.transform.final_name(trans_id)
2474
1444
        parent_id = self.transform.final_parent(trans_id)
2483
1453
            self._known_paths[trans_id] = self._determine_path(trans_id)
2484
1454
        return self._known_paths[trans_id]
2485
1455
 
2486
 
    def get_paths(self, trans_ids):
2487
 
        return [(self.get_path(t), t) for t in trans_ids]
2488
 
 
2489
 
 
2490
1456
 
2491
1457
def topology_sorted_ids(tree):
2492
1458
    """Determine the topological order of the ids in a tree"""
2495
1461
    return file_ids
2496
1462
 
2497
1463
 
2498
 
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2499
 
               delta_from_tree=False):
 
1464
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
2500
1465
    """Create working tree for a branch, using a TreeTransform.
2501
 
 
 
1466
    
2502
1467
    This function should be used on empty trees, having a tree root at most.
2503
1468
    (see merge and revert functionality for working with existing trees)
2504
1469
 
2505
1470
    Existing files are handled like so:
2506
 
 
 
1471
    
2507
1472
    - Existing bzrdirs take precedence over creating new items.  They are
2508
1473
      created as '%s.diverted' % name.
2509
1474
    - Otherwise, if the content on disk matches the content we are building,
2518
1483
    :param hardlink: If true, hard-link files to accelerator_tree, where
2519
1484
        possible.  accelerator_tree must implement abspath, i.e. be a
2520
1485
        working tree.
2521
 
    :param delta_from_tree: If true, build_tree may use the input Tree to
2522
 
        generate the inventory delta.
2523
1486
    """
2524
1487
    wt.lock_tree_write()
2525
1488
    try:
2528
1491
            if accelerator_tree is not None:
2529
1492
                accelerator_tree.lock_read()
2530
1493
            try:
2531
 
                return _build_tree(tree, wt, accelerator_tree, hardlink,
2532
 
                                   delta_from_tree)
 
1494
                return _build_tree(tree, wt, accelerator_tree, hardlink)
2533
1495
            finally:
2534
1496
                if accelerator_tree is not None:
2535
1497
                    accelerator_tree.unlock()
2539
1501
        wt.unlock()
2540
1502
 
2541
1503
 
2542
 
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
 
1504
def _build_tree(tree, wt, accelerator_tree, hardlink):
2543
1505
    """See build_tree."""
2544
1506
    for num, _unused in enumerate(wt.all_file_ids()):
2545
1507
        if num > 0:  # more than just a root
2546
1508
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2547
1509
    file_trans_id = {}
2548
 
    top_pb = ui.ui_factory.nested_progress_bar()
 
1510
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2549
1511
    pp = ProgressPhase("Build phase", 2, top_pb)
2550
1512
    if tree.inventory.root is not None:
2551
1513
        # This is kind of a hack: we should be altering the root
2564
1526
        pp.next_phase()
2565
1527
        file_trans_id[wt.get_root_id()] = \
2566
1528
            tt.trans_id_tree_file_id(wt.get_root_id())
2567
 
        pb = ui.ui_factory.nested_progress_bar()
 
1529
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
2568
1530
        try:
2569
1531
            deferred_contents = []
2570
1532
            num = 0
2571
 
            total = len(tree.inventory)
2572
 
            if delta_from_tree:
2573
 
                precomputed_delta = []
2574
 
            else:
2575
 
                precomputed_delta = None
2576
 
            # Check if tree inventory has content. If so, we populate
2577
 
            # existing_files with the directory content. If there are no
2578
 
            # entries we skip populating existing_files as its not used.
2579
 
            # This improves performance and unncessary work on large
2580
 
            # directory trees. (#501307)
2581
 
            if total > 0:
2582
 
                existing_files = set()
2583
 
                for dir, files in wt.walkdirs():
2584
 
                    existing_files.update(f[0] for f in files)
2585
1533
            for num, (tree_path, entry) in \
2586
1534
                enumerate(tree.inventory.iter_entries_by_dir()):
2587
 
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
 
1535
                pb.update("Building tree", num - len(deferred_contents),
 
1536
                          len(tree.inventory))
2588
1537
                if entry.parent_id is None:
2589
1538
                    continue
2590
1539
                reparent = False
2591
1540
                file_id = entry.file_id
2592
 
                if delta_from_tree:
2593
 
                    precomputed_delta.append((None, tree_path, file_id, entry))
2594
 
                if tree_path in existing_files:
2595
 
                    target_path = wt.abspath(tree_path)
 
1541
                target_path = wt.abspath(tree_path)
 
1542
                try:
2596
1543
                    kind = file_kind(target_path)
 
1544
                except NoSuchFile:
 
1545
                    pass
 
1546
                else:
2597
1547
                    if kind == "directory":
2598
1548
                        try:
2599
 
                            controldir.ControlDir.open(target_path)
 
1549
                            bzrdir.BzrDir.open(target_path)
2600
1550
                        except errors.NotBranchError:
2601
1551
                            pass
2602
1552
                        else:
2607
1557
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
2608
1558
                        if kind == 'directory':
2609
1559
                            reparent = True
 
1560
                if entry.parent_id not in file_trans_id:
 
1561
                    raise AssertionError(
 
1562
                        'entry %s parent id %r is not in file_trans_id %r'
 
1563
                        % (entry, entry.parent_id, file_trans_id))
2610
1564
                parent_id = file_trans_id[entry.parent_id]
2611
1565
                if entry.kind == 'file':
2612
1566
                    # We *almost* replicate new_by_entry, so that we can defer
2613
1567
                    # getting the file text, and get them all at once.
2614
1568
                    trans_id = tt.create_path(entry.name, parent_id)
2615
1569
                    file_trans_id[file_id] = trans_id
2616
 
                    tt.version_file(file_id, trans_id)
2617
 
                    executable = tree.is_executable(file_id, tree_path)
2618
 
                    if executable:
 
1570
                    tt.version_file(entry.file_id, trans_id)
 
1571
                    executable = tree.is_executable(entry.file_id, tree_path)
 
1572
                    if executable is not None:
2619
1573
                        tt.set_executability(executable, trans_id)
2620
 
                    trans_data = (trans_id, tree_path, entry.text_sha1)
2621
 
                    deferred_contents.append((file_id, trans_data))
 
1574
                    deferred_contents.append((entry.file_id, trans_id))
2622
1575
                else:
2623
1576
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2624
1577
                                                          tree)
2635
1588
        divert_trans = set(file_trans_id[f] for f in divert)
2636
1589
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2637
1590
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2638
 
        if len(raw_conflicts) > 0:
2639
 
            precomputed_delta = None
2640
1591
        conflicts = cook_conflicts(raw_conflicts, tt)
2641
1592
        for conflict in conflicts:
2642
 
            trace.warning(unicode(conflict))
 
1593
            warning(conflict)
2643
1594
        try:
2644
1595
            wt.add_conflicts(conflicts)
2645
1596
        except errors.UnsupportedOperation:
2646
1597
            pass
2647
 
        result = tt.apply(no_conflicts=True,
2648
 
                          precomputed_delta=precomputed_delta)
 
1598
        result = tt.apply(no_conflicts=True)
2649
1599
    finally:
2650
1600
        tt.finalize()
2651
1601
        top_pb.finished()
2655
1605
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2656
1606
                  hardlink):
2657
1607
    total = len(desired_files) + offset
2658
 
    wt = tt._tree
2659
1608
    if accelerator_tree is None:
2660
1609
        new_desired_files = desired_files
2661
1610
    else:
2662
1611
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2663
 
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2664
 
                     in iter if not (c or e[0] != e[1])]
2665
 
        if accelerator_tree.supports_content_filtering():
2666
 
            unchanged = [(f, p) for (f, p) in unchanged
2667
 
                         if not accelerator_tree.iter_search_rules([p]).next()]
2668
 
        unchanged = dict(unchanged)
 
1612
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
 
1613
                         in iter if not (c or e[0] != e[1]))
2669
1614
        new_desired_files = []
2670
1615
        count = 0
2671
 
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
 
1616
        for file_id, trans_id in desired_files:
2672
1617
            accelerator_path = unchanged.get(file_id)
2673
1618
            if accelerator_path is None:
2674
 
                new_desired_files.append((file_id,
2675
 
                    (trans_id, tree_path, text_sha1)))
 
1619
                new_desired_files.append((file_id, trans_id))
2676
1620
                continue
2677
 
            pb.update(gettext('Adding file contents'), count + offset, total)
 
1621
            pb.update('Adding file contents', count + offset, total)
2678
1622
            if hardlink:
2679
1623
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2680
1624
                                   trans_id)
2681
1625
            else:
2682
1626
                contents = accelerator_tree.get_file(file_id, accelerator_path)
2683
 
                if wt.supports_content_filtering():
2684
 
                    filters = wt._content_filter_stack(tree_path)
2685
 
                    contents = filtered_output_bytes(contents, filters,
2686
 
                        ContentFilterContext(tree_path, tree))
2687
1627
                try:
2688
 
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
1628
                    tt.create_file(contents, trans_id)
2689
1629
                finally:
2690
 
                    try:
2691
 
                        contents.close()
2692
 
                    except AttributeError:
2693
 
                        # after filtering, contents may no longer be file-like
2694
 
                        pass
 
1630
                    contents.close()
2695
1631
            count += 1
2696
1632
        offset += count
2697
 
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2698
 
            tree.iter_files_bytes(new_desired_files)):
2699
 
        if wt.supports_content_filtering():
2700
 
            filters = wt._content_filter_stack(tree_path)
2701
 
            contents = filtered_output_bytes(contents, filters,
2702
 
                ContentFilterContext(tree_path, tree))
2703
 
        tt.create_file(contents, trans_id, sha1=text_sha1)
2704
 
        pb.update(gettext('Adding file contents'), count + offset, total)
 
1633
    for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
 
1634
                                                 new_desired_files)):
 
1635
        tt.create_file(contents, trans_id)
 
1636
        pb.update('Adding file contents', count + offset, total)
2705
1637
 
2706
1638
 
2707
1639
def _reparent_children(tt, old_parent, new_parent):
2708
1640
    for child in tt.iter_tree_children(old_parent):
2709
1641
        tt.adjust_path(tt.final_name(child), new_parent, child)
2710
1642
 
2711
 
 
2712
1643
def _reparent_transform_children(tt, old_parent, new_parent):
2713
1644
    by_parent = tt.by_parent()
2714
1645
    for child in by_parent[old_parent]:
2715
1646
        tt.adjust_path(tt.final_name(child), new_parent, child)
2716
 
    return by_parent[old_parent]
2717
 
 
2718
1647
 
2719
1648
def _content_match(tree, entry, file_id, kind, target_path):
2720
1649
    if entry.kind != kind:
2722
1651
    if entry.kind == "directory":
2723
1652
        return True
2724
1653
    if entry.kind == "file":
2725
 
        f = file(target_path, 'rb')
2726
 
        try:
2727
 
            if tree.get_file_text(file_id) == f.read():
2728
 
                return True
2729
 
        finally:
2730
 
            f.close()
 
1654
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
 
1655
            return True
2731
1656
    elif entry.kind == "symlink":
2732
1657
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
2733
1658
            return True
2738
1663
    new_conflicts = set()
2739
1664
    for c_type, conflict in ((c[0], c) for c in conflicts):
2740
1665
        # Anything but a 'duplicate' would indicate programmer error
2741
 
        if c_type != 'duplicate':
2742
 
            raise AssertionError(c_type)
 
1666
        assert c_type == 'duplicate', c_type
2743
1667
        # Now figure out which is new and which is old
2744
1668
        if tt.new_contents(conflict[1]):
2745
1669
            new_file = conflict[1]
2771
1695
    if kind == 'file':
2772
1696
        contents = tree.get_file(entry.file_id).readlines()
2773
1697
        executable = tree.is_executable(entry.file_id)
2774
 
        return tt.new_file(name, parent_id, contents, entry.file_id,
 
1698
        return tt.new_file(name, parent_id, contents, entry.file_id, 
2775
1699
                           executable)
2776
1700
    elif kind in ('directory', 'tree-reference'):
2777
1701
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
2778
1702
        if kind == 'tree-reference':
2779
1703
            tt.set_tree_reference(entry.reference_revision, trans_id)
2780
 
        return trans_id
 
1704
        return trans_id 
2781
1705
    elif kind == 'symlink':
2782
1706
        target = tree.get_symlink_target(entry.file_id)
2783
1707
        return tt.new_symlink(name, parent_id, target, entry.file_id)
2785
1709
        raise errors.BadFileKindError(name, kind)
2786
1710
 
2787
1711
 
2788
 
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2789
 
    filter_tree_path=None):
2790
 
    """Create new file contents according to tree contents.
2791
 
    
2792
 
    :param filter_tree_path: the tree path to use to lookup
2793
 
      content filters to apply to the bytes output in the working tree.
2794
 
      This only applies if the working tree supports content filtering.
2795
 
    """
2796
 
    kind = tree.kind(file_id)
2797
 
    if kind == 'directory':
 
1712
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
 
1713
    """Create new file contents according to an inventory entry."""
 
1714
    if entry.kind == "file":
 
1715
        if lines is None:
 
1716
            lines = tree.get_file(entry.file_id).readlines()
 
1717
        tt.create_file(lines, trans_id, mode_id=mode_id)
 
1718
    elif entry.kind == "symlink":
 
1719
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
 
1720
    elif entry.kind == "directory":
2798
1721
        tt.create_directory(trans_id)
2799
 
    elif kind == "file":
2800
 
        if bytes is None:
2801
 
            tree_file = tree.get_file(file_id)
2802
 
            try:
2803
 
                bytes = tree_file.readlines()
2804
 
            finally:
2805
 
                tree_file.close()
2806
 
        wt = tt._tree
2807
 
        if wt.supports_content_filtering() and filter_tree_path is not None:
2808
 
            filters = wt._content_filter_stack(filter_tree_path)
2809
 
            bytes = filtered_output_bytes(bytes, filters,
2810
 
                ContentFilterContext(filter_tree_path, tree))
2811
 
        tt.create_file(bytes, trans_id)
2812
 
    elif kind == "symlink":
2813
 
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2814
 
    else:
2815
 
        raise AssertionError('Unknown kind %r' % kind)
2816
1722
 
2817
1723
 
2818
1724
def create_entry_executability(tt, entry, trans_id):
2821
1727
        tt.set_executability(entry.executable, trans_id)
2822
1728
 
2823
1729
 
2824
 
@deprecated_function(deprecated_in((2, 3, 0)))
 
1730
@deprecated_function(zero_fifteen)
 
1731
def find_interesting(working_tree, target_tree, filenames):
 
1732
    """Find the ids corresponding to specified filenames.
 
1733
    
 
1734
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
 
1735
    """
 
1736
    working_tree.lock_read()
 
1737
    try:
 
1738
        target_tree.lock_read()
 
1739
        try:
 
1740
            return working_tree.paths2ids(filenames, [target_tree])
 
1741
        finally:
 
1742
            target_tree.unlock()
 
1743
    finally:
 
1744
        working_tree.unlock()
 
1745
 
 
1746
 
 
1747
@deprecated_function(zero_ninety)
 
1748
def change_entry(tt, file_id, working_tree, target_tree, 
 
1749
                 trans_id_file_id, backups, trans_id, by_parent):
 
1750
    """Replace a file_id's contents with those from a target tree."""
 
1751
    if file_id is None and target_tree is None:
 
1752
        # skip the logic altogether in the deprecation test
 
1753
        return
 
1754
    e_trans_id = trans_id_file_id(file_id)
 
1755
    entry = target_tree.inventory[file_id]
 
1756
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
 
1757
                                                           working_tree)
 
1758
    if contents_mod:
 
1759
        mode_id = e_trans_id
 
1760
        if has_contents:
 
1761
            if not backups:
 
1762
                tt.delete_contents(e_trans_id)
 
1763
            else:
 
1764
                parent_trans_id = trans_id_file_id(entry.parent_id)
 
1765
                backup_name = get_backup_name(entry, by_parent,
 
1766
                                              parent_trans_id, tt)
 
1767
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
 
1768
                tt.unversion_file(e_trans_id)
 
1769
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
 
1770
                tt.version_file(file_id, e_trans_id)
 
1771
                trans_id[file_id] = e_trans_id
 
1772
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
 
1773
        create_entry_executability(tt, entry, e_trans_id)
 
1774
 
 
1775
    elif meta_mod:
 
1776
        tt.set_executability(entry.executable, e_trans_id)
 
1777
    if tt.final_name(e_trans_id) != entry.name:
 
1778
        adjust_path  = True
 
1779
    else:
 
1780
        parent_id = tt.final_parent(e_trans_id)
 
1781
        parent_file_id = tt.final_file_id(parent_id)
 
1782
        if parent_file_id != entry.parent_id:
 
1783
            adjust_path = True
 
1784
        else:
 
1785
            adjust_path = False
 
1786
    if adjust_path:
 
1787
        parent_trans_id = trans_id_file_id(entry.parent_id)
 
1788
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
 
1789
 
 
1790
 
2825
1791
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2826
1792
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2827
1793
 
2828
1794
 
2829
 
@deprecated_function(deprecated_in((2, 3, 0)))
2830
1795
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2831
1796
    """Produce a backup-style name that appears to be available"""
2832
1797
    def name_gen():
2859
1824
        if entry.kind != working_kind:
2860
1825
            contents_mod, meta_mod = True, False
2861
1826
        else:
2862
 
            cur_entry._read_tree_state(working_tree.id2path(file_id),
 
1827
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
2863
1828
                                       working_tree)
2864
1829
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
2865
1830
            cur_entry._forget_tree_state()
2867
1832
 
2868
1833
 
2869
1834
def revert(working_tree, target_tree, filenames, backups=False,
2870
 
           pb=None, change_reporter=None):
 
1835
           pb=DummyProgress(), change_reporter=None):
2871
1836
    """Revert a working tree's contents to those of a target tree."""
2872
1837
    target_tree.lock_read()
2873
 
    pb = ui.ui_factory.nested_progress_bar()
2874
1838
    tt = TreeTransform(working_tree, pb)
2875
1839
    try:
2876
1840
        pp = ProgressPhase("Revert phase", 3, pb)
2877
 
        conflicts, merge_modified = _prepare_revert_transform(
2878
 
            working_tree, target_tree, tt, filenames, backups, pp)
 
1841
        pp.next_phase()
 
1842
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1843
        try:
 
1844
            merge_modified = _alter_files(working_tree, target_tree, tt,
 
1845
                                          child_pb, filenames, backups)
 
1846
        finally:
 
1847
            child_pb.finished()
 
1848
        pp.next_phase()
 
1849
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1850
        try:
 
1851
            raw_conflicts = resolve_conflicts(tt, child_pb,
 
1852
                lambda t, c: conflict_pass(t, c, target_tree))
 
1853
        finally:
 
1854
            child_pb.finished()
 
1855
        conflicts = cook_conflicts(raw_conflicts, tt)
2879
1856
        if change_reporter:
2880
1857
            change_reporter = delta._ChangeReporter(
2881
1858
                unversioned_filter=working_tree.is_ignored)
2882
1859
            delta.report_changes(tt.iter_changes(), change_reporter)
2883
1860
        for conflict in conflicts:
2884
 
            trace.warning(unicode(conflict))
 
1861
            warning(conflict)
2885
1862
        pp.next_phase()
2886
1863
        tt.apply()
2887
1864
        working_tree.set_merge_modified(merge_modified)
2892
1869
    return conflicts
2893
1870
 
2894
1871
 
2895
 
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2896
 
                              backups, pp, basis_tree=None,
2897
 
                              merge_modified=None):
2898
 
    child_pb = ui.ui_factory.nested_progress_bar()
2899
 
    try:
2900
 
        if merge_modified is None:
2901
 
            merge_modified = working_tree.merge_modified()
2902
 
        merge_modified = _alter_files(working_tree, target_tree, tt,
2903
 
                                      child_pb, filenames, backups,
2904
 
                                      merge_modified, basis_tree)
2905
 
    finally:
2906
 
        child_pb.finished()
2907
 
    child_pb = ui.ui_factory.nested_progress_bar()
2908
 
    try:
2909
 
        raw_conflicts = resolve_conflicts(tt, child_pb,
2910
 
            lambda t, c: conflict_pass(t, c, target_tree))
2911
 
    finally:
2912
 
        child_pb.finished()
2913
 
    conflicts = cook_conflicts(raw_conflicts, tt)
2914
 
    return conflicts, merge_modified
2915
 
 
2916
 
 
2917
1872
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2918
 
                 backups, merge_modified, basis_tree=None):
2919
 
    if basis_tree is not None:
2920
 
        basis_tree.lock_read()
2921
 
    # We ask the working_tree for its changes relative to the target, rather
2922
 
    # than the target changes relative to the working tree. Because WT4 has an
2923
 
    # optimizer to compare itself to a target, but no optimizer for the
2924
 
    # reverse.
2925
 
    change_list = working_tree.iter_changes(target_tree,
 
1873
                 backups):
 
1874
    merge_modified = working_tree.merge_modified()
 
1875
    change_list = target_tree.iter_changes(working_tree,
2926
1876
        specific_files=specific_files, pb=pb)
2927
 
    if target_tree.get_root_id() is None:
 
1877
    if target_tree.inventory.root is None:
2928
1878
        skip_root = True
2929
1879
    else:
2930
1880
        skip_root = False
 
1881
    basis_tree = None
2931
1882
    try:
2932
1883
        deferred_files = []
2933
1884
        for id_num, (file_id, path, changed_content, versioned, parent, name,
2934
1885
                kind, executable) in enumerate(change_list):
2935
 
            target_path, wt_path = path
2936
 
            target_versioned, wt_versioned = versioned
2937
 
            target_parent, wt_parent = parent
2938
 
            target_name, wt_name = name
2939
 
            target_kind, wt_kind = kind
2940
 
            target_executable, wt_executable = executable
2941
 
            if skip_root and wt_parent is None:
 
1886
            if skip_root and file_id[0] is not None and parent[0] is None:
2942
1887
                continue
2943
1888
            trans_id = tt.trans_id_file_id(file_id)
2944
1889
            mode_id = None
2945
1890
            if changed_content:
2946
1891
                keep_content = False
2947
 
                if wt_kind == 'file' and (backups or target_kind is None):
 
1892
                if kind[0] == 'file' and (backups or kind[1] is None):
2948
1893
                    wt_sha1 = working_tree.get_file_sha1(file_id)
2949
1894
                    if merge_modified.get(file_id) != wt_sha1:
2950
1895
                        # acquire the basis tree lazily to prevent the
2953
1898
                        if basis_tree is None:
2954
1899
                            basis_tree = working_tree.basis_tree()
2955
1900
                            basis_tree.lock_read()
2956
 
                        if basis_tree.has_id(file_id):
 
1901
                        if file_id in basis_tree:
2957
1902
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
2958
1903
                                keep_content = True
2959
 
                        elif target_kind is None and not target_versioned:
 
1904
                        elif kind[1] is None and not versioned[1]:
2960
1905
                            keep_content = True
2961
 
                if wt_kind is not None:
 
1906
                if kind[0] is not None:
2962
1907
                    if not keep_content:
2963
1908
                        tt.delete_contents(trans_id)
2964
 
                    elif target_kind is not None:
2965
 
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
2966
 
                        backup_name = tt._available_backup_name(
2967
 
                            wt_name, parent_trans_id)
 
1909
                    elif kind[1] is not None:
 
1910
                        parent_trans_id = tt.trans_id_file_id(parent[0])
 
1911
                        by_parent = tt.by_parent()
 
1912
                        backup_name = _get_backup_name(name[0], by_parent,
 
1913
                                                       parent_trans_id, tt)
2968
1914
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
2969
 
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
2970
 
                        if wt_versioned and target_versioned:
 
1915
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
 
1916
                        if versioned == (True, True):
2971
1917
                            tt.unversion_file(trans_id)
2972
1918
                            tt.version_file(file_id, new_trans_id)
2973
1919
                        # New contents should have the same unix perms as old
2974
1920
                        # contents
2975
1921
                        mode_id = trans_id
2976
1922
                        trans_id = new_trans_id
2977
 
                if target_kind in ('directory', 'tree-reference'):
 
1923
                if kind[1] == 'directory':
2978
1924
                    tt.create_directory(trans_id)
2979
 
                    if target_kind == 'tree-reference':
2980
 
                        revision = target_tree.get_reference_revision(file_id,
2981
 
                                                                      target_path)
2982
 
                        tt.set_tree_reference(revision, trans_id)
2983
 
                elif target_kind == 'symlink':
 
1925
                elif kind[1] == 'symlink':
2984
1926
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
2985
1927
                                      trans_id)
2986
 
                elif target_kind == 'file':
 
1928
                elif kind[1] == 'file':
2987
1929
                    deferred_files.append((file_id, (trans_id, mode_id)))
2988
1930
                    if basis_tree is None:
2989
1931
                        basis_tree = working_tree.basis_tree()
2990
1932
                        basis_tree.lock_read()
2991
1933
                    new_sha1 = target_tree.get_file_sha1(file_id)
2992
 
                    if (basis_tree.has_id(file_id) and
2993
 
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
 
1934
                    if (file_id in basis_tree and new_sha1 ==
 
1935
                        basis_tree.get_file_sha1(file_id)):
2994
1936
                        if file_id in merge_modified:
2995
1937
                            del merge_modified[file_id]
2996
1938
                    else:
2997
1939
                        merge_modified[file_id] = new_sha1
2998
1940
 
2999
1941
                    # preserve the execute bit when backing up
3000
 
                    if keep_content and wt_executable == target_executable:
3001
 
                        tt.set_executability(target_executable, trans_id)
3002
 
                elif target_kind is not None:
3003
 
                    raise AssertionError(target_kind)
3004
 
            if not wt_versioned and target_versioned:
 
1942
                    if keep_content and executable[0] == executable[1]:
 
1943
                        tt.set_executability(executable[1], trans_id)
 
1944
                else:
 
1945
                    assert kind[1] is None
 
1946
            if versioned == (False, True):
3005
1947
                tt.version_file(file_id, trans_id)
3006
 
            if wt_versioned and not target_versioned:
 
1948
            if versioned == (True, False):
3007
1949
                tt.unversion_file(trans_id)
3008
 
            if (target_name is not None and
3009
 
                (wt_name != target_name or wt_parent != target_parent)):
3010
 
                if target_name == '' and target_parent is None:
3011
 
                    parent_trans = ROOT_PARENT
3012
 
                else:
3013
 
                    parent_trans = tt.trans_id_file_id(target_parent)
3014
 
                if wt_parent is None and wt_versioned:
3015
 
                    tt.adjust_root_path(target_name, parent_trans)
3016
 
                else:
3017
 
                    tt.adjust_path(target_name, parent_trans, trans_id)
3018
 
            if wt_executable != target_executable and target_kind == "file":
3019
 
                tt.set_executability(target_executable, trans_id)
3020
 
        if working_tree.supports_content_filtering():
3021
 
            for index, ((trans_id, mode_id), bytes) in enumerate(
3022
 
                target_tree.iter_files_bytes(deferred_files)):
3023
 
                file_id = deferred_files[index][0]
3024
 
                # We're reverting a tree to the target tree so using the
3025
 
                # target tree to find the file path seems the best choice
3026
 
                # here IMO - Ian C 27/Oct/2009
3027
 
                filter_tree_path = target_tree.id2path(file_id)
3028
 
                filters = working_tree._content_filter_stack(filter_tree_path)
3029
 
                bytes = filtered_output_bytes(bytes, filters,
3030
 
                    ContentFilterContext(filter_tree_path, working_tree))
3031
 
                tt.create_file(bytes, trans_id, mode_id)
3032
 
        else:
3033
 
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3034
 
                deferred_files):
3035
 
                tt.create_file(bytes, trans_id, mode_id)
3036
 
        tt.fixup_new_roots()
 
1950
            if (name[1] is not None and 
 
1951
                (name[0] != name[1] or parent[0] != parent[1])):
 
1952
                tt.adjust_path(
 
1953
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
 
1954
            if executable[0] != executable[1] and kind[1] == "file":
 
1955
                tt.set_executability(executable[1], trans_id)
 
1956
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
1957
            deferred_files):
 
1958
            tt.create_file(bytes, trans_id, mode_id)
3037
1959
    finally:
3038
1960
        if basis_tree is not None:
3039
1961
            basis_tree.unlock()
3040
1962
    return merge_modified
3041
1963
 
3042
1964
 
3043
 
def resolve_conflicts(tt, pb=None, pass_func=None):
 
1965
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
3044
1966
    """Make many conflict-resolution attempts, but die if they fail"""
3045
1967
    if pass_func is None:
3046
1968
        pass_func = conflict_pass
3047
1969
    new_conflicts = set()
3048
 
    pb = ui.ui_factory.nested_progress_bar()
3049
1970
    try:
3050
1971
        for n in range(10):
3051
 
            pb.update(gettext('Resolution pass'), n+1, 10)
 
1972
            pb.update('Resolution pass', n+1, 10)
3052
1973
            conflicts = tt.find_conflicts()
3053
1974
            if len(conflicts) == 0:
3054
1975
                return new_conflicts
3055
1976
            new_conflicts.update(pass_func(tt, conflicts))
3056
1977
        raise MalformedTransform(conflicts=conflicts)
3057
1978
    finally:
3058
 
        pb.finished()
 
1979
        pb.clear()
3059
1980
 
3060
1981
 
3061
1982
def conflict_pass(tt, conflicts, path_tree=None):
3080
2001
                existing_file, new_file = conflict[1], conflict[2]
3081
2002
            new_name = tt.final_name(existing_file)+'.moved'
3082
2003
            tt.adjust_path(new_name, final_parent, existing_file)
3083
 
            new_conflicts.add((c_type, 'Moved existing file to',
 
2004
            new_conflicts.add((c_type, 'Moved existing file to', 
3084
2005
                               existing_file, new_file))
3085
2006
        elif c_type == 'parent loop':
3086
2007
            # break the loop by undoing one of the ops that caused the loop
3090
2011
            new_conflicts.add((c_type, 'Cancelled move', cur,
3091
2012
                               tt.final_parent(cur),))
3092
2013
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3093
 
 
 
2014
            
3094
2015
        elif c_type == 'missing parent':
3095
2016
            trans_id = conflict[1]
3096
 
            if trans_id in tt._removed_contents:
3097
 
                cancel_deletion = True
3098
 
                orphans = tt._get_potential_orphans(trans_id)
3099
 
                if orphans:
3100
 
                    cancel_deletion = False
3101
 
                    # All children are orphans
3102
 
                    for o in orphans:
3103
 
                        try:
3104
 
                            tt.new_orphan(o, trans_id)
3105
 
                        except OrphaningError:
3106
 
                            # Something bad happened so we cancel the directory
3107
 
                            # deletion which will leave it in place with a
3108
 
                            # conflict. The user can deal with it from there.
3109
 
                            # Note that this also catch the case where we don't
3110
 
                            # want to create orphans and leave the directory in
3111
 
                            # place.
3112
 
                            cancel_deletion = True
3113
 
                            break
3114
 
                if cancel_deletion:
3115
 
                    # Cancel the directory deletion
3116
 
                    tt.cancel_deletion(trans_id)
3117
 
                    new_conflicts.add(('deleting parent', 'Not deleting',
3118
 
                                       trans_id))
3119
 
            else:
3120
 
                create = True
 
2017
            try:
 
2018
                tt.cancel_deletion(trans_id)
 
2019
                new_conflicts.add(('deleting parent', 'Not deleting', 
 
2020
                                   trans_id))
 
2021
            except KeyError:
 
2022
                tt.create_directory(trans_id)
 
2023
                new_conflicts.add((c_type, 'Created directory', trans_id))
3121
2024
                try:
3122
2025
                    tt.final_name(trans_id)
3123
2026
                except NoFinalPath:
3124
2027
                    if path_tree is not None:
3125
2028
                        file_id = tt.final_file_id(trans_id)
3126
 
                        if file_id is None:
3127
 
                            file_id = tt.inactive_file_id(trans_id)
3128
 
                        _, entry = path_tree.iter_entries_by_dir(
3129
 
                            [file_id]).next()
3130
 
                        # special-case the other tree root (move its
3131
 
                        # children to current root)
3132
 
                        if entry.parent_id is None:
3133
 
                            create = False
3134
 
                            moved = _reparent_transform_children(
3135
 
                                tt, trans_id, tt.root)
3136
 
                            for child in moved:
3137
 
                                new_conflicts.add((c_type, 'Moved to root',
3138
 
                                                   child))
3139
 
                        else:
3140
 
                            parent_trans_id = tt.trans_id_file_id(
3141
 
                                entry.parent_id)
3142
 
                            tt.adjust_path(entry.name, parent_trans_id,
3143
 
                                           trans_id)
3144
 
                if create:
3145
 
                    tt.create_directory(trans_id)
3146
 
                    new_conflicts.add((c_type, 'Created directory', trans_id))
 
2029
                        entry = path_tree.inventory[file_id]
 
2030
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
 
2031
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
3147
2032
        elif c_type == 'unversioned parent':
3148
 
            file_id = tt.inactive_file_id(conflict[1])
3149
 
            # special-case the other tree root (move its children instead)
3150
 
            if path_tree and path_tree.has_id(file_id):
3151
 
                if path_tree.path2id('') == file_id:
3152
 
                    # This is the root entry, skip it
3153
 
                    continue
3154
 
            tt.version_file(file_id, conflict[1])
 
2033
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
3155
2034
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3156
2035
        elif c_type == 'non-directory parent':
3157
2036
            parent_id = conflict[1]
3164
2043
            if parent_file_id is not None:
3165
2044
                tt.unversion_file(parent_id)
3166
2045
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
3167
 
        elif c_type == 'versioning no contents':
3168
 
            tt.cancel_versioning(conflict[1])
3169
2046
    return new_conflicts
3170
2047
 
3171
2048
 
3172
2049
def cook_conflicts(raw_conflicts, tt):
3173
2050
    """Generate a list of cooked conflicts, sorted by file path"""
 
2051
    from bzrlib.conflicts import Conflict
3174
2052
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3175
 
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
 
2053
    return sorted(conflict_iter, key=Conflict.sort_key)
3176
2054
 
3177
2055
 
3178
2056
def iter_cook_conflicts(raw_conflicts, tt):
 
2057
    from bzrlib.conflicts import Conflict
3179
2058
    fp = FinalPaths(tt)
3180
2059
    for conflict in raw_conflicts:
3181
2060
        c_type = conflict[0]
3183
2062
        modified_path = fp.get_path(conflict[2])
3184
2063
        modified_id = tt.final_file_id(conflict[2])
3185
2064
        if len(conflict) == 3:
3186
 
            yield conflicts.Conflict.factory(
3187
 
                c_type, action=action, path=modified_path, file_id=modified_id)
3188
 
 
 
2065
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2066
                                     file_id=modified_id)
 
2067
             
3189
2068
        else:
3190
2069
            conflicting_path = fp.get_path(conflict[3])
3191
2070
            conflicting_id = tt.final_file_id(conflict[3])
3192
 
            yield conflicts.Conflict.factory(
3193
 
                c_type, action=action, path=modified_path,
3194
 
                file_id=modified_id,
3195
 
                conflict_path=conflicting_path,
3196
 
                conflict_file_id=conflicting_id)
 
2071
            yield Conflict.factory(c_type, action=action, path=modified_path,
 
2072
                                   file_id=modified_id, 
 
2073
                                   conflict_path=conflicting_path,
 
2074
                                   conflict_file_id=conflicting_id)
3197
2075
 
3198
2076
 
3199
2077
class _FileMover(object):
3204
2082
        self.pending_deletions = []
3205
2083
 
3206
2084
    def rename(self, from_, to):
3207
 
        """Rename a file from one path to another."""
 
2085
        """Rename a file from one path to another.  Functions like os.rename"""
3208
2086
        try:
3209
2087
            os.rename(from_, to)
3210
2088
        except OSError, e:
3211
2089
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3212
2090
                raise errors.FileExists(to, str(e))
3213
 
            # normal OSError doesn't include filenames so it's hard to see where
3214
 
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3215
 
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
 
2091
            raise
3216
2092
        self.past_renames.append((from_, to))
3217
2093
 
3218
2094
    def pre_delete(self, from_, to):
3228
2104
    def rollback(self):
3229
2105
        """Reverse all renames that have been performed"""
3230
2106
        for from_, to in reversed(self.past_renames):
3231
 
            try:
3232
 
                os.rename(to, from_)
3233
 
            except OSError, e:
3234
 
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
 
2107
            os.rename(to, from_)
3235
2108
        # after rollback, don't reuse _FileMover
3236
2109
        past_renames = None
3237
2110
        pending_deletions = None