/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 bzrlib/transform.py

  • Committer: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

Show diffs side-by-side

added added

removed removed

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