/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-08-20 21:41:54 UTC
  • mfrom: (7067.2.2 python3-selftest)
  • Revision ID: breezy.the.bot@gmail.com-20180820214154-ls3f4lfwrdzs2k0t
Fix most selftest tests on Python 3.

Merged from https://code.launchpad.net/~jelmer/brz/python3-selftest/+merge/353202

Show diffs side-by-side

added added

removed removed

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