1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from stat import S_ISREG, S_IEXEC
25
config as _mod_config,
32
lazy_import.lazy_import(globals(), """
43
revision as _mod_revision,
47
from breezy.bzr import (
51
from breezy.i18n import gettext
53
from .errors import (DuplicateKey, MalformedTransform,
54
ReusingTransform, CantMoveRoot,
55
ImmortalLimbo, NoFinalPath,
57
from .filters import filtered_output_bytes, ContentFilterContext
58
from .mutabletree import MutableTree
59
from .osutils import (
67
from .progress import ProgressPhase
74
ROOT_PARENT = "root-parent"
76
def unique_add(map, key, value):
78
raise DuplicateKey(key=key)
83
class _TransformResults(object):
84
def __init__(self, modified_paths, rename_count):
86
self.modified_paths = modified_paths
87
self.rename_count = rename_count
90
class TreeTransformBase(object):
91
"""The base class for TreeTransform and its kin."""
93
def __init__(self, tree, pb=None,
97
:param tree: The tree that will be transformed, but not necessarily
100
:param case_sensitive: If True, the target of the transform is
101
case sensitive, not just case preserving.
103
object.__init__(self)
106
# mapping of trans_id -> new basename
108
# mapping of trans_id -> new parent trans_id
109
self._new_parent = {}
110
# mapping of trans_id with new contents -> new file_kind
111
self._new_contents = {}
112
# mapping of trans_id => (sha1 of content, stat_value)
113
self._observed_sha1s = {}
114
# Set of trans_ids whose contents will be removed
115
self._removed_contents = set()
116
# Mapping of trans_id -> new execute-bit value
117
self._new_executability = {}
118
# Mapping of trans_id -> new tree-reference value
119
self._new_reference_revision = {}
120
# Mapping of trans_id -> new file_id
122
# Mapping of old file-id -> trans_id
123
self._non_present_ids = {}
124
# Mapping of new file_id -> trans_id
126
# Set of trans_ids that will be removed
127
self._removed_id = set()
128
# Mapping of path in old tree -> trans_id
129
self._tree_path_ids = {}
130
# Mapping trans_id -> path in old tree
131
self._tree_id_paths = {}
132
# The trans_id that will be used as the tree root
133
root_id = tree.get_root_id()
134
if root_id is not None:
135
self._new_root = self.trans_id_tree_file_id(root_id)
137
self._new_root = None
138
# Indicator of whether the transform has been applied
142
# Whether the target is case sensitive
143
self._case_sensitive_target = case_sensitive
144
# A counter of how many files have been renamed
145
self.rename_count = 0
148
"""Support Context Manager API."""
151
def __exit__(self, exc_type, exc_val, exc_tb):
152
"""Support Context Manager API."""
156
"""Release the working tree lock, if held.
158
This is required if apply has not been invoked, but can be invoked
161
if self._tree is None:
163
for hook in MutableTree.hooks['post_transform']:
164
hook(self._tree, self)
168
def __get_root(self):
169
return self._new_root
171
root = property(__get_root)
173
def _assign_id(self):
174
"""Produce a new tranform id"""
175
new_id = "new-%s" % self._id_number
179
def create_path(self, name, parent):
180
"""Assign a transaction id to a new path"""
181
trans_id = self._assign_id()
182
unique_add(self._new_name, trans_id, name)
183
unique_add(self._new_parent, trans_id, parent)
186
def adjust_path(self, name, parent, trans_id):
187
"""Change the path that is assigned to a transaction id."""
189
raise ValueError("Parent trans-id may not be None")
190
if trans_id == self._new_root:
192
self._new_name[trans_id] = name
193
self._new_parent[trans_id] = parent
195
def adjust_root_path(self, name, parent):
196
"""Emulate moving the root by moving all children, instead.
198
We do this by undoing the association of root's transaction id with the
199
current tree. This allows us to create a new directory with that
200
transaction id. We unversion the root directory and version the
201
physically new directory, and hope someone versions the tree root
204
old_root = self._new_root
205
old_root_file_id = self.final_file_id(old_root)
206
# force moving all children of root
207
for child_id in self.iter_tree_children(old_root):
208
if child_id != parent:
209
self.adjust_path(self.final_name(child_id),
210
self.final_parent(child_id), child_id)
211
file_id = self.final_file_id(child_id)
212
if file_id is not None:
213
self.unversion_file(child_id)
214
self.version_file(file_id, child_id)
216
# the physical root needs a new transaction id
217
self._tree_path_ids.pop("")
218
self._tree_id_paths.pop(old_root)
219
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
220
if parent == old_root:
221
parent = self._new_root
222
self.adjust_path(name, parent, old_root)
223
self.create_directory(old_root)
224
self.version_file(old_root_file_id, old_root)
225
self.unversion_file(self._new_root)
227
def fixup_new_roots(self):
228
"""Reinterpret requests to change the root directory
230
Instead of creating a root directory, or moving an existing directory,
231
all the attributes and children of the new root are applied to the
232
existing root directory.
234
This means that the old root trans-id becomes obsolete, so it is
235
recommended only to invoke this after the root trans-id has become
239
new_roots = [k for k, v in viewitems(self._new_parent)
241
if len(new_roots) < 1:
243
if len(new_roots) != 1:
244
raise ValueError('A tree cannot have two roots!')
245
if self._new_root is None:
246
self._new_root = new_roots[0]
248
old_new_root = new_roots[0]
249
# unversion the new root's directory.
250
if self.final_kind(self._new_root) is None:
251
file_id = self.final_file_id(old_new_root)
253
file_id = self.final_file_id(self._new_root)
254
if old_new_root in self._new_id:
255
self.cancel_versioning(old_new_root)
257
self.unversion_file(old_new_root)
258
# if, at this stage, root still has an old file_id, zap it so we can
259
# stick a new one in.
260
if (self.tree_file_id(self._new_root) is not None and
261
self._new_root not in self._removed_id):
262
self.unversion_file(self._new_root)
263
if file_id is not None:
264
self.version_file(file_id, self._new_root)
266
# Now move children of new root into old root directory.
267
# Ensure all children are registered with the transaction, but don't
268
# use directly-- some tree children have new parents
269
list(self.iter_tree_children(old_new_root))
270
# Move all children of new root into old root directory.
271
for child in self.by_parent().get(old_new_root, []):
272
self.adjust_path(self.final_name(child), self._new_root, child)
274
# Ensure old_new_root has no directory.
275
if old_new_root in self._new_contents:
276
self.cancel_creation(old_new_root)
278
self.delete_contents(old_new_root)
280
# prevent deletion of root directory.
281
if self._new_root in self._removed_contents:
282
self.cancel_deletion(self._new_root)
284
# destroy path info for old_new_root.
285
del self._new_parent[old_new_root]
286
del self._new_name[old_new_root]
288
def trans_id_tree_file_id(self, inventory_id):
289
"""Determine the transaction id of a working tree file.
291
This reflects only files that already exist, not ones that will be
292
added by transactions.
294
if inventory_id is None:
295
raise ValueError('None is not a valid file id')
296
path = self._tree.id2path(inventory_id)
297
return self.trans_id_tree_path(path)
299
def trans_id_file_id(self, file_id):
300
"""Determine or set the transaction id associated with a file ID.
301
A new id is only created for file_ids that were never present. If
302
a transaction has been unversioned, it is deliberately still returned.
303
(this will likely lead to an unversioned parent conflict.)
306
raise ValueError('None is not a valid file id')
307
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
308
return self._r_new_id[file_id]
311
next(self._tree.iter_entries_by_dir([file_id]))
312
except StopIteration:
313
if file_id in self._non_present_ids:
314
return self._non_present_ids[file_id]
316
trans_id = self._assign_id()
317
self._non_present_ids[file_id] = trans_id
320
return self.trans_id_tree_file_id(file_id)
322
def trans_id_tree_path(self, path):
323
"""Determine (and maybe set) the transaction ID for a tree path."""
324
path = self.canonical_path(path)
325
if path not in self._tree_path_ids:
326
self._tree_path_ids[path] = self._assign_id()
327
self._tree_id_paths[self._tree_path_ids[path]] = path
328
return self._tree_path_ids[path]
330
def get_tree_parent(self, trans_id):
331
"""Determine id of the parent in the tree."""
332
path = self._tree_id_paths[trans_id]
335
return self.trans_id_tree_path(os.path.dirname(path))
337
def delete_contents(self, trans_id):
338
"""Schedule the contents of a path entry for deletion"""
339
kind = self.tree_kind(trans_id)
341
self._removed_contents.add(trans_id)
343
def cancel_deletion(self, trans_id):
344
"""Cancel a scheduled deletion"""
345
self._removed_contents.remove(trans_id)
347
def unversion_file(self, trans_id):
348
"""Schedule a path entry to become unversioned"""
349
self._removed_id.add(trans_id)
351
def delete_versioned(self, trans_id):
352
"""Delete and unversion a versioned file"""
353
self.delete_contents(trans_id)
354
self.unversion_file(trans_id)
356
def set_executability(self, executability, trans_id):
357
"""Schedule setting of the 'execute' bit
358
To unschedule, set to None
360
if executability is None:
361
del self._new_executability[trans_id]
363
unique_add(self._new_executability, trans_id, executability)
365
def set_tree_reference(self, revision_id, trans_id):
366
"""Set the reference associated with a directory"""
367
unique_add(self._new_reference_revision, trans_id, revision_id)
369
def version_file(self, file_id, trans_id):
370
"""Schedule a file to become versioned."""
373
unique_add(self._new_id, trans_id, file_id)
374
unique_add(self._r_new_id, file_id, trans_id)
376
def cancel_versioning(self, trans_id):
377
"""Undo a previous versioning of a file"""
378
file_id = self._new_id[trans_id]
379
del self._new_id[trans_id]
380
del self._r_new_id[file_id]
382
def new_paths(self, filesystem_only=False):
383
"""Determine the paths of all new and changed files.
385
:param filesystem_only: if True, only calculate values for files
386
that require renames or execute bit changes.
390
stale_ids = self._needs_rename.difference(self._new_name)
391
stale_ids.difference_update(self._new_parent)
392
stale_ids.difference_update(self._new_contents)
393
stale_ids.difference_update(self._new_id)
394
needs_rename = self._needs_rename.difference(stale_ids)
395
id_sets = (needs_rename, self._new_executability)
397
id_sets = (self._new_name, self._new_parent, self._new_contents,
398
self._new_id, self._new_executability)
399
for id_set in id_sets:
400
new_ids.update(id_set)
401
return sorted(FinalPaths(self).get_paths(new_ids))
403
def _inventory_altered(self):
404
"""Determine which trans_ids need new Inventory entries.
406
An new entry is needed when anything that would be reflected by an
407
inventory entry changes, including file name, file_id, parent file_id,
408
file kind, and the execute bit.
410
Some care is taken to return entries with real changes, not cases
411
where the value is deleted and then restored to its original value,
412
but some actually unchanged values may be returned.
414
:returns: A list of (path, trans_id) for all items requiring an
415
inventory change. Ordered by path.
418
# Find entries whose file_ids are new (or changed).
419
new_file_id = set(t for t in self._new_id
420
if self._new_id[t] != self.tree_file_id(t))
421
for id_set in [self._new_name, self._new_parent, new_file_id,
422
self._new_executability]:
423
changed_ids.update(id_set)
424
# removing implies a kind change
425
changed_kind = set(self._removed_contents)
427
changed_kind.intersection_update(self._new_contents)
428
# Ignore entries that are already known to have changed.
429
changed_kind.difference_update(changed_ids)
430
# to keep only the truly changed ones
431
changed_kind = (t for t in changed_kind
432
if self.tree_kind(t) != self.final_kind(t))
433
# all kind changes will alter the inventory
434
changed_ids.update(changed_kind)
435
# To find entries with changed parent_ids, find parents which existed,
436
# but changed file_id.
437
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
438
# Now add all their children to the set.
439
for parent_trans_id in new_file_id:
440
changed_ids.update(self.iter_tree_children(parent_trans_id))
441
return sorted(FinalPaths(self).get_paths(changed_ids))
443
def final_kind(self, trans_id):
444
"""Determine the final file kind, after any changes applied.
446
:return: None if the file does not exist/has no contents. (It is
447
conceivable that a path would be created without the corresponding
448
contents insertion command)
450
if trans_id in self._new_contents:
451
return self._new_contents[trans_id]
452
elif trans_id in self._removed_contents:
455
return self.tree_kind(trans_id)
457
def tree_file_id(self, trans_id):
458
"""Determine the file id associated with the trans_id in the tree"""
460
path = self._tree_id_paths[trans_id]
462
# the file is a new, unversioned file, or invalid trans_id
464
# the file is old; the old id is still valid
465
if self._new_root == trans_id:
466
return self._tree.get_root_id()
467
return self._tree.path2id(path)
469
def final_file_id(self, trans_id):
470
"""Determine the file id after any changes are applied, or None.
472
None indicates that the file will not be versioned after changes are
476
return self._new_id[trans_id]
478
if trans_id in self._removed_id:
480
return self.tree_file_id(trans_id)
482
def inactive_file_id(self, trans_id):
483
"""Return the inactive file_id associated with a transaction id.
484
That is, the one in the tree or in non_present_ids.
485
The file_id may actually be active, too.
487
file_id = self.tree_file_id(trans_id)
488
if file_id is not None:
490
for key, value in viewitems(self._non_present_ids):
491
if value == trans_id:
494
def final_parent(self, trans_id):
495
"""Determine the parent file_id, after any changes are applied.
497
ROOT_PARENT is returned for the tree root.
500
return self._new_parent[trans_id]
502
return self.get_tree_parent(trans_id)
504
def final_name(self, trans_id):
505
"""Determine the final filename, after all changes are applied."""
507
return self._new_name[trans_id]
510
return os.path.basename(self._tree_id_paths[trans_id])
512
raise NoFinalPath(trans_id, self)
515
"""Return a map of parent: children for known parents.
517
Only new paths and parents of tree files with assigned ids are used.
520
items = list(viewitems(self._new_parent))
521
items.extend((t, self.final_parent(t))
522
for t in list(self._tree_id_paths))
523
for trans_id, parent_id in items:
524
if parent_id not in by_parent:
525
by_parent[parent_id] = set()
526
by_parent[parent_id].add(trans_id)
529
def path_changed(self, trans_id):
530
"""Return True if a trans_id's path has changed."""
531
return (trans_id in self._new_name) or (trans_id in self._new_parent)
533
def new_contents(self, trans_id):
534
return (trans_id in self._new_contents)
536
def find_conflicts(self):
537
"""Find any violations of inventory or filesystem invariants"""
538
if self._done is True:
539
raise ReusingTransform()
541
# ensure all children of all existent parents are known
542
# all children of non-existent parents are known, by definition.
543
self._add_tree_children()
544
by_parent = self.by_parent()
545
conflicts.extend(self._unversioned_parents(by_parent))
546
conflicts.extend(self._parent_loops())
547
conflicts.extend(self._duplicate_entries(by_parent))
548
conflicts.extend(self._duplicate_ids())
549
conflicts.extend(self._parent_type_conflicts(by_parent))
550
conflicts.extend(self._improper_versioning())
551
conflicts.extend(self._executability_conflicts())
552
conflicts.extend(self._overwrite_conflicts())
555
def _check_malformed(self):
556
conflicts = self.find_conflicts()
557
if len(conflicts) != 0:
558
raise MalformedTransform(conflicts=conflicts)
560
def _add_tree_children(self):
561
"""Add all the children of all active parents to the known paths.
563
Active parents are those which gain children, and those which are
564
removed. This is a necessary first step in detecting conflicts.
566
parents = list(self.by_parent())
567
parents.extend([t for t in self._removed_contents if
568
self.tree_kind(t) == 'directory'])
569
for trans_id in self._removed_id:
570
file_id = self.tree_file_id(trans_id)
571
if file_id is not None:
572
if self._tree.stored_kind(file_id) == 'directory':
573
parents.append(trans_id)
574
elif self.tree_kind(trans_id) == 'directory':
575
parents.append(trans_id)
577
for parent_id in parents:
578
# ensure that all children are registered with the transaction
579
list(self.iter_tree_children(parent_id))
581
def _has_named_child(self, name, parent_id, known_children):
582
"""Does a parent already have a name child.
584
:param name: The searched for name.
586
:param parent_id: The parent for which the check is made.
588
:param known_children: The already known children. This should have
589
been recently obtained from `self.by_parent.get(parent_id)`
590
(or will be if None is passed).
592
if known_children is None:
593
known_children = self.by_parent().get(parent_id, [])
594
for child in known_children:
595
if self.final_name(child) == name:
597
parent_path = self._tree_id_paths.get(parent_id, None)
598
if parent_path is None:
599
# No parent... no children
601
child_path = joinpath(parent_path, name)
602
child_id = self._tree_path_ids.get(child_path, None)
604
# Not known by the tree transform yet, check the filesystem
605
return osutils.lexists(self._tree.abspath(child_path))
607
raise AssertionError('child_id is missing: %s, %s, %s'
608
% (name, parent_id, child_id))
610
def _available_backup_name(self, name, target_id):
611
"""Find an available backup name.
613
:param name: The basename of the file.
615
:param target_id: The directory trans_id where the backup should
618
known_children = self.by_parent().get(target_id, [])
619
return osutils.available_backup_name(
621
lambda base: self._has_named_child(
622
base, target_id, known_children))
624
def _parent_loops(self):
625
"""No entry should be its own ancestor"""
627
for trans_id in self._new_parent:
630
while parent_id != ROOT_PARENT:
633
parent_id = self.final_parent(parent_id)
636
if parent_id == trans_id:
637
conflicts.append(('parent loop', trans_id))
638
if parent_id in seen:
642
def _unversioned_parents(self, by_parent):
643
"""If parent directories are versioned, children must be versioned."""
645
for parent_id, children in viewitems(by_parent):
646
if parent_id == ROOT_PARENT:
648
if self.final_file_id(parent_id) is not None:
650
for child_id in children:
651
if self.final_file_id(child_id) is not None:
652
conflicts.append(('unversioned parent', parent_id))
656
def _improper_versioning(self):
657
"""Cannot version a file with no contents, or a bad type.
659
However, existing entries with no contents are okay.
662
for trans_id in self._new_id:
663
kind = self.final_kind(trans_id)
665
conflicts.append(('versioning no contents', trans_id))
667
if not inventory.InventoryEntry.versionable_kind(kind):
668
conflicts.append(('versioning bad kind', trans_id, kind))
671
def _executability_conflicts(self):
672
"""Check for bad executability changes.
674
Only versioned files may have their executability set, because
675
1. only versioned entries can have executability under windows
676
2. only files can be executable. (The execute bit on a directory
677
does not indicate searchability)
680
for trans_id in self._new_executability:
681
if self.final_file_id(trans_id) is None:
682
conflicts.append(('unversioned executability', trans_id))
684
if self.final_kind(trans_id) != "file":
685
conflicts.append(('non-file executability', trans_id))
688
def _overwrite_conflicts(self):
689
"""Check for overwrites (not permitted on Win32)"""
691
for trans_id in self._new_contents:
692
if self.tree_kind(trans_id) is None:
694
if trans_id not in self._removed_contents:
695
conflicts.append(('overwrite', trans_id,
696
self.final_name(trans_id)))
699
def _duplicate_entries(self, by_parent):
700
"""No directory may have two entries with the same name."""
702
if (self._new_name, self._new_parent) == ({}, {}):
704
for children in viewvalues(by_parent):
706
for child_tid in children:
707
name = self.final_name(child_tid)
709
# Keep children only if they still exist in the end
710
if not self._case_sensitive_target:
712
name_ids.append((name, child_tid))
716
for name, trans_id in name_ids:
717
kind = self.final_kind(trans_id)
718
file_id = self.final_file_id(trans_id)
719
if kind is None and file_id is None:
721
if name == last_name:
722
conflicts.append(('duplicate', last_trans_id, trans_id,
725
last_trans_id = trans_id
728
def _duplicate_ids(self):
729
"""Each inventory id may only be used once"""
731
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
733
all_ids = self._tree.all_file_ids()
734
active_tree_ids = all_ids.difference(removed_tree_ids)
735
for trans_id, file_id in viewitems(self._new_id):
736
if file_id in active_tree_ids:
737
old_trans_id = self.trans_id_tree_file_id(file_id)
738
conflicts.append(('duplicate id', old_trans_id, trans_id))
741
def _parent_type_conflicts(self, by_parent):
742
"""Children must have a directory parent"""
744
for parent_id, children in viewitems(by_parent):
745
if parent_id == ROOT_PARENT:
748
for child_id in children:
749
if self.final_kind(child_id) is not None:
754
# There is at least a child, so we need an existing directory to
756
kind = self.final_kind(parent_id)
758
# The directory will be deleted
759
conflicts.append(('missing parent', parent_id))
760
elif kind != "directory":
761
# Meh, we need a *directory* to put something in it
762
conflicts.append(('non-directory parent', parent_id))
765
def _set_executability(self, path, trans_id):
766
"""Set the executability of versioned files """
767
if self._tree._supports_executable():
768
new_executability = self._new_executability[trans_id]
769
abspath = self._tree.abspath(path)
770
current_mode = os.stat(abspath).st_mode
771
if new_executability:
774
to_mode = current_mode | (0o100 & ~umask)
775
# Enable x-bit for others only if they can read it.
776
if current_mode & 0o004:
777
to_mode |= 0o001 & ~umask
778
if current_mode & 0o040:
779
to_mode |= 0o010 & ~umask
781
to_mode = current_mode & ~0o111
782
osutils.chmod_if_possible(abspath, to_mode)
784
def _new_entry(self, name, parent_id, file_id):
785
"""Helper function to create a new filesystem entry."""
786
trans_id = self.create_path(name, parent_id)
787
if file_id is not None:
788
self.version_file(file_id, trans_id)
791
def new_file(self, name, parent_id, contents, file_id=None,
792
executable=None, sha1=None):
793
"""Convenience method to create files.
795
name is the name of the file to create.
796
parent_id is the transaction id of the parent directory of the file.
797
contents is an iterator of bytestrings, which will be used to produce
799
:param file_id: The inventory ID of the file, if it is to be versioned.
800
:param executable: Only valid when a file_id has been supplied.
802
trans_id = self._new_entry(name, parent_id, file_id)
803
# TODO: rather than scheduling a set_executable call,
804
# have create_file create the file with the right mode.
805
self.create_file(contents, trans_id, sha1=sha1)
806
if executable is not None:
807
self.set_executability(executable, trans_id)
810
def new_directory(self, name, parent_id, file_id=None):
811
"""Convenience method to create directories.
813
name is the name of the directory to create.
814
parent_id is the transaction id of the parent directory of the
816
file_id is the inventory ID of the directory, if it is to be versioned.
818
trans_id = self._new_entry(name, parent_id, file_id)
819
self.create_directory(trans_id)
822
def new_symlink(self, name, parent_id, target, file_id=None):
823
"""Convenience method to create symbolic link.
825
name is the name of the symlink to create.
826
parent_id is the transaction id of the parent directory of the symlink.
827
target is a bytestring of the target of the symlink.
828
file_id is the inventory ID of the file, if it is to be versioned.
830
trans_id = self._new_entry(name, parent_id, file_id)
831
self.create_symlink(target, trans_id)
834
def new_orphan(self, trans_id, parent_id):
835
"""Schedule an item to be orphaned.
837
When a directory is about to be removed, its children, if they are not
838
versioned are moved out of the way: they don't have a parent anymore.
840
:param trans_id: The trans_id of the existing item.
841
:param parent_id: The parent trans_id of the item.
843
raise NotImplementedError(self.new_orphan)
845
def _get_potential_orphans(self, dir_id):
846
"""Find the potential orphans in a directory.
848
A directory can't be safely deleted if there are versioned files in it.
849
If all the contained files are unversioned then they can be orphaned.
851
The 'None' return value means that the directory contains at least one
852
versioned file and should not be deleted.
854
:param dir_id: The directory trans id.
856
:return: A list of the orphan trans ids or None if at least one
857
versioned file is present.
860
# Find the potential orphans, stop if one item should be kept
861
for child_tid in self.by_parent()[dir_id]:
862
if child_tid in self._removed_contents:
863
# The child is removed as part of the transform. Since it was
864
# versioned before, it's not an orphan
866
elif self.final_file_id(child_tid) is None:
867
# The child is not versioned
868
orphans.append(child_tid)
870
# We have a versioned file here, searching for orphans is
876
def _affected_ids(self):
877
"""Return the set of transform ids affected by the transform"""
878
trans_ids = set(self._removed_id)
879
trans_ids.update(self._new_id)
880
trans_ids.update(self._removed_contents)
881
trans_ids.update(self._new_contents)
882
trans_ids.update(self._new_executability)
883
trans_ids.update(self._new_name)
884
trans_ids.update(self._new_parent)
887
def _get_file_id_maps(self):
888
"""Return mapping of file_ids to trans_ids in the to and from states"""
889
trans_ids = self._affected_ids()
892
# Build up two dicts: trans_ids associated with file ids in the
893
# FROM state, vs the TO state.
894
for trans_id in trans_ids:
895
from_file_id = self.tree_file_id(trans_id)
896
if from_file_id is not None:
897
from_trans_ids[from_file_id] = trans_id
898
to_file_id = self.final_file_id(trans_id)
899
if to_file_id is not None:
900
to_trans_ids[to_file_id] = trans_id
901
return from_trans_ids, to_trans_ids
903
def _from_file_data(self, from_trans_id, from_versioned, file_id):
904
"""Get data about a file in the from (tree) state
906
Return a (name, parent, kind, executable) tuple
908
from_path = self._tree_id_paths.get(from_trans_id)
910
# get data from working tree if versioned
911
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
912
from_name = from_entry.name
913
from_parent = from_entry.parent_id
916
if from_path is None:
917
# File does not exist in FROM state
921
# File exists, but is not versioned. Have to use path-
923
from_name = os.path.basename(from_path)
924
tree_parent = self.get_tree_parent(from_trans_id)
925
from_parent = self.tree_file_id(tree_parent)
926
if from_path is not None:
927
from_kind, from_executable, from_stats = \
928
self._tree._comparison_data(from_entry, from_path)
931
from_executable = False
932
return from_name, from_parent, from_kind, from_executable
934
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
935
"""Get data about a file in the to (target) state
937
Return a (name, parent, kind, executable) tuple
939
to_name = self.final_name(to_trans_id)
940
to_kind = self.final_kind(to_trans_id)
941
to_parent = self.final_file_id(self.final_parent(to_trans_id))
942
if to_trans_id in self._new_executability:
943
to_executable = self._new_executability[to_trans_id]
944
elif to_trans_id == from_trans_id:
945
to_executable = from_executable
947
to_executable = False
948
return to_name, to_parent, to_kind, to_executable
950
def iter_changes(self):
951
"""Produce output in the same format as Tree.iter_changes.
953
Will produce nonsensical results if invoked while inventory/filesystem
954
conflicts (as reported by TreeTransform.find_conflicts()) are present.
956
This reads the Transform, but only reproduces changes involving a
957
file_id. Files that are not versioned in either of the FROM or TO
958
states are not reflected.
960
final_paths = FinalPaths(self)
961
from_trans_ids, to_trans_ids = self._get_file_id_maps()
963
# Now iterate through all active file_ids
964
for file_id in set(from_trans_ids).union(to_trans_ids):
966
from_trans_id = from_trans_ids.get(file_id)
967
# find file ids, and determine versioning state
968
if from_trans_id is None:
969
from_versioned = False
970
from_trans_id = to_trans_ids[file_id]
972
from_versioned = True
973
to_trans_id = to_trans_ids.get(file_id)
974
if to_trans_id is None:
976
to_trans_id = from_trans_id
980
from_name, from_parent, from_kind, from_executable = \
981
self._from_file_data(from_trans_id, from_versioned, file_id)
983
to_name, to_parent, to_kind, to_executable = \
984
self._to_file_data(to_trans_id, from_trans_id, from_executable)
986
if not from_versioned:
989
from_path = self._tree_id_paths.get(from_trans_id)
993
to_path = final_paths.get_path(to_trans_id)
994
if from_kind != to_kind:
996
elif to_kind in ('file', 'symlink') and (
997
to_trans_id != from_trans_id or
998
to_trans_id in self._new_contents):
1000
if (not modified and from_versioned == to_versioned and
1001
from_parent==to_parent and from_name == to_name and
1002
from_executable == to_executable):
1004
results.append((file_id, (from_path, to_path), modified,
1005
(from_versioned, to_versioned),
1006
(from_parent, to_parent),
1007
(from_name, to_name),
1008
(from_kind, to_kind),
1009
(from_executable, to_executable)))
1010
return iter(sorted(results, key=lambda x:x[1]))
1012
def get_preview_tree(self):
1013
"""Return a tree representing the result of the transform.
1015
The tree is a snapshot, and altering the TreeTransform will invalidate
1018
return _PreviewTree(self)
1020
def commit(self, branch, message, merge_parents=None, strict=False,
1021
timestamp=None, timezone=None, committer=None, authors=None,
1022
revprops=None, revision_id=None):
1023
"""Commit the result of this TreeTransform to a branch.
1025
:param branch: The branch to commit to.
1026
:param message: The message to attach to the commit.
1027
:param merge_parents: Additional parent revision-ids specified by
1029
:param strict: If True, abort the commit if there are unversioned
1031
:param timestamp: if not None, seconds-since-epoch for the time and
1032
date. (May be a float.)
1033
:param timezone: Optional timezone for timestamp, as an offset in
1035
:param committer: Optional committer in email-id format.
1036
(e.g. "J Random Hacker <jrandom@example.com>")
1037
:param authors: Optional list of authors in email-id format.
1038
:param revprops: Optional dictionary of revision properties.
1039
:param revision_id: Optional revision id. (Specifying a revision-id
1040
may reduce performance for some non-native formats.)
1041
:return: The revision_id of the revision committed.
1043
self._check_malformed()
1045
unversioned = set(self._new_contents).difference(set(self._new_id))
1046
for trans_id in unversioned:
1047
if self.final_file_id(trans_id) is None:
1048
raise errors.StrictCommitFailed()
1050
revno, last_rev_id = branch.last_revision_info()
1051
if last_rev_id == _mod_revision.NULL_REVISION:
1052
if merge_parents is not None:
1053
raise ValueError('Cannot supply merge parents for first'
1057
parent_ids = [last_rev_id]
1058
if merge_parents is not None:
1059
parent_ids.extend(merge_parents)
1060
if self._tree.get_revision_id() != last_rev_id:
1061
raise ValueError('TreeTransform not based on branch basis: %s' %
1062
self._tree.get_revision_id())
1063
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1064
builder = branch.get_commit_builder(parent_ids,
1065
timestamp=timestamp,
1067
committer=committer,
1069
revision_id=revision_id)
1070
preview = self.get_preview_tree()
1071
list(builder.record_iter_changes(preview, last_rev_id,
1072
self.iter_changes()))
1073
builder.finish_inventory()
1074
revision_id = builder.commit(message)
1075
branch.set_last_revision_info(revno + 1, revision_id)
1078
def _text_parent(self, trans_id):
1079
file_id = self.tree_file_id(trans_id)
1081
if file_id is None or self._tree.kind(file_id) != 'file':
1083
except errors.NoSuchFile:
1087
def _get_parents_texts(self, trans_id):
1088
"""Get texts for compression parents of this file."""
1089
file_id = self._text_parent(trans_id)
1092
return (self._tree.get_file_text(file_id),)
1094
def _get_parents_lines(self, trans_id):
1095
"""Get lines for compression parents of this file."""
1096
file_id = self._text_parent(trans_id)
1099
return (self._tree.get_file_lines(file_id),)
1101
def serialize(self, serializer):
1102
"""Serialize this TreeTransform.
1104
:param serializer: A Serialiser like pack.ContainerSerializer.
1106
new_name = dict((k, v.encode('utf-8')) for k, v in
1107
viewitems(self._new_name))
1108
new_executability = dict((k, int(v)) for k, v in
1109
viewitems(self._new_executability))
1110
tree_path_ids = dict((k.encode('utf-8'), v)
1111
for k, v in viewitems(self._tree_path_ids))
1113
'_id_number': self._id_number,
1114
'_new_name': new_name,
1115
'_new_parent': self._new_parent,
1116
'_new_executability': new_executability,
1117
'_new_id': self._new_id,
1118
'_tree_path_ids': tree_path_ids,
1119
'_removed_id': list(self._removed_id),
1120
'_removed_contents': list(self._removed_contents),
1121
'_non_present_ids': self._non_present_ids,
1123
yield serializer.bytes_record(bencode.bencode(attribs),
1125
for trans_id, kind in viewitems(self._new_contents):
1127
lines = osutils.chunks_to_lines(
1128
self._read_file_chunks(trans_id))
1129
parents = self._get_parents_lines(trans_id)
1130
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1131
content = ''.join(mpdiff.to_patch())
1132
if kind == 'directory':
1134
if kind == 'symlink':
1135
content = self._read_symlink_target(trans_id)
1136
yield serializer.bytes_record(content, ((trans_id, kind),))
1138
def deserialize(self, records):
1139
"""Deserialize a stored TreeTransform.
1141
:param records: An iterable of (names, content) tuples, as per
1142
pack.ContainerPushParser.
1144
names, content = next(records)
1145
attribs = bencode.bdecode(content)
1146
self._id_number = attribs['_id_number']
1147
self._new_name = dict((k, v.decode('utf-8'))
1148
for k, v in viewitems(attribs['_new_name']))
1149
self._new_parent = attribs['_new_parent']
1150
self._new_executability = dict((k, bool(v))
1151
for k, v in viewitems(attribs['_new_executability']))
1152
self._new_id = attribs['_new_id']
1153
self._r_new_id = dict((v, k) for k, v in viewitems(self._new_id))
1154
self._tree_path_ids = {}
1155
self._tree_id_paths = {}
1156
for bytepath, trans_id in viewitems(attribs['_tree_path_ids']):
1157
path = bytepath.decode('utf-8')
1158
self._tree_path_ids[path] = trans_id
1159
self._tree_id_paths[trans_id] = path
1160
self._removed_id = set(attribs['_removed_id'])
1161
self._removed_contents = set(attribs['_removed_contents'])
1162
self._non_present_ids = attribs['_non_present_ids']
1163
for ((trans_id, kind),), content in records:
1165
mpdiff = multiparent.MultiParent.from_patch(content)
1166
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1167
self.create_file(lines, trans_id)
1168
if kind == 'directory':
1169
self.create_directory(trans_id)
1170
if kind == 'symlink':
1171
self.create_symlink(content.decode('utf-8'), trans_id)
1174
class DiskTreeTransform(TreeTransformBase):
1175
"""Tree transform storing its contents on disk."""
1177
def __init__(self, tree, limbodir, pb=None,
1178
case_sensitive=True):
1180
:param tree: The tree that will be transformed, but not necessarily
1182
:param limbodir: A directory where new files can be stored until
1183
they are installed in their proper places
1185
:param case_sensitive: If True, the target of the transform is
1186
case sensitive, not just case preserving.
1188
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1189
self._limbodir = limbodir
1190
self._deletiondir = None
1191
# A mapping of transform ids to their limbo filename
1192
self._limbo_files = {}
1193
self._possibly_stale_limbo_files = set()
1194
# A mapping of transform ids to a set of the transform ids of children
1195
# that their limbo directory has
1196
self._limbo_children = {}
1197
# Map transform ids to maps of child filename to child transform id
1198
self._limbo_children_names = {}
1199
# List of transform ids that need to be renamed from limbo into place
1200
self._needs_rename = set()
1201
self._creation_mtime = None
1204
"""Release the working tree lock, if held, clean up limbo dir.
1206
This is required if apply has not been invoked, but can be invoked
1209
if self._tree is None:
1212
limbo_paths = list(viewvalues(self._limbo_files))
1213
limbo_paths.extend(self._possibly_stale_limbo_files)
1214
limbo_paths.sort(reverse=True)
1215
for path in limbo_paths:
1218
except OSError as e:
1219
if e.errno != errno.ENOENT:
1221
# XXX: warn? perhaps we just got interrupted at an
1222
# inconvenient moment, but perhaps files are disappearing
1225
delete_any(self._limbodir)
1227
# We don't especially care *why* the dir is immortal.
1228
raise ImmortalLimbo(self._limbodir)
1230
if self._deletiondir is not None:
1231
delete_any(self._deletiondir)
1233
raise errors.ImmortalPendingDeletion(self._deletiondir)
1235
TreeTransformBase.finalize(self)
1237
def _limbo_supports_executable(self):
1238
"""Check if the limbo path supports the executable bit."""
1239
# FIXME: Check actual file system capabilities of limbodir
1240
return osutils.supports_executable()
1242
def _limbo_name(self, trans_id):
1243
"""Generate the limbo name of a file"""
1244
limbo_name = self._limbo_files.get(trans_id)
1245
if limbo_name is None:
1246
limbo_name = self._generate_limbo_path(trans_id)
1247
self._limbo_files[trans_id] = limbo_name
1250
def _generate_limbo_path(self, trans_id):
1251
"""Generate a limbo path using the trans_id as the relative path.
1253
This is suitable as a fallback, and when the transform should not be
1254
sensitive to the path encoding of the limbo directory.
1256
self._needs_rename.add(trans_id)
1257
return pathjoin(self._limbodir, trans_id)
1259
def adjust_path(self, name, parent, trans_id):
1260
previous_parent = self._new_parent.get(trans_id)
1261
previous_name = self._new_name.get(trans_id)
1262
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1263
if (trans_id in self._limbo_files and
1264
trans_id not in self._needs_rename):
1265
self._rename_in_limbo([trans_id])
1266
if previous_parent != parent:
1267
self._limbo_children[previous_parent].remove(trans_id)
1268
if previous_parent != parent or previous_name != name:
1269
del self._limbo_children_names[previous_parent][previous_name]
1271
def _rename_in_limbo(self, trans_ids):
1272
"""Fix limbo names so that the right final path is produced.
1274
This means we outsmarted ourselves-- we tried to avoid renaming
1275
these files later by creating them with their final names in their
1276
final parents. But now the previous name or parent is no longer
1277
suitable, so we have to rename them.
1279
Even for trans_ids that have no new contents, we must remove their
1280
entries from _limbo_files, because they are now stale.
1282
for trans_id in trans_ids:
1283
old_path = self._limbo_files[trans_id]
1284
self._possibly_stale_limbo_files.add(old_path)
1285
del self._limbo_files[trans_id]
1286
if trans_id not in self._new_contents:
1288
new_path = self._limbo_name(trans_id)
1289
os.rename(old_path, new_path)
1290
self._possibly_stale_limbo_files.remove(old_path)
1291
for descendant in self._limbo_descendants(trans_id):
1292
desc_path = self._limbo_files[descendant]
1293
desc_path = new_path + desc_path[len(old_path):]
1294
self._limbo_files[descendant] = desc_path
1296
def _limbo_descendants(self, trans_id):
1297
"""Return the set of trans_ids whose limbo paths descend from this."""
1298
descendants = set(self._limbo_children.get(trans_id, []))
1299
for descendant in list(descendants):
1300
descendants.update(self._limbo_descendants(descendant))
1303
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1304
"""Schedule creation of a new file.
1308
:param contents: an iterator of strings, all of which will be written
1309
to the target destination.
1310
:param trans_id: TreeTransform handle
1311
:param mode_id: If not None, force the mode of the target file to match
1312
the mode of the object referenced by mode_id.
1313
Otherwise, we will try to preserve mode bits of an existing file.
1314
:param sha1: If the sha1 of this content is already known, pass it in.
1315
We can use it to prevent future sha1 computations.
1317
name = self._limbo_name(trans_id)
1318
f = open(name, 'wb')
1320
unique_add(self._new_contents, trans_id, 'file')
1321
f.writelines(contents)
1324
self._set_mtime(name)
1325
self._set_mode(trans_id, mode_id, S_ISREG)
1326
# It is unfortunate we have to use lstat instead of fstat, but we just
1327
# used utime and chmod on the file, so we need the accurate final
1329
if sha1 is not None:
1330
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1332
def _read_file_chunks(self, trans_id):
1333
cur_file = open(self._limbo_name(trans_id), 'rb')
1335
return cur_file.readlines()
1339
def _read_symlink_target(self, trans_id):
1340
return os.readlink(self._limbo_name(trans_id))
1342
def _set_mtime(self, path):
1343
"""All files that are created get the same mtime.
1345
This time is set by the first object to be created.
1347
if self._creation_mtime is None:
1348
self._creation_mtime = time.time()
1349
os.utime(path, (self._creation_mtime, self._creation_mtime))
1351
def create_hardlink(self, path, trans_id):
1352
"""Schedule creation of a hard link"""
1353
name = self._limbo_name(trans_id)
1356
except OSError as e:
1357
if e.errno != errno.EPERM:
1359
raise errors.HardLinkNotSupported(path)
1361
unique_add(self._new_contents, trans_id, 'file')
1363
# Clean up the file, it never got registered so
1364
# TreeTransform.finalize() won't clean it up.
1368
def create_directory(self, trans_id):
1369
"""Schedule creation of a new directory.
1371
See also new_directory.
1373
os.mkdir(self._limbo_name(trans_id))
1374
unique_add(self._new_contents, trans_id, 'directory')
1376
def create_symlink(self, target, trans_id):
1377
"""Schedule creation of a new symbolic link.
1379
target is a bytestring.
1380
See also new_symlink.
1383
os.symlink(target, self._limbo_name(trans_id))
1384
unique_add(self._new_contents, trans_id, 'symlink')
1387
path = FinalPaths(self).get_path(trans_id)
1390
raise UnableCreateSymlink(path=path)
1392
def cancel_creation(self, trans_id):
1393
"""Cancel the creation of new file contents."""
1394
del self._new_contents[trans_id]
1395
if trans_id in self._observed_sha1s:
1396
del self._observed_sha1s[trans_id]
1397
children = self._limbo_children.get(trans_id)
1398
# if this is a limbo directory with children, move them before removing
1400
if children is not None:
1401
self._rename_in_limbo(children)
1402
del self._limbo_children[trans_id]
1403
del self._limbo_children_names[trans_id]
1404
delete_any(self._limbo_name(trans_id))
1406
def new_orphan(self, trans_id, parent_id):
1407
conf = self._tree.get_config_stack()
1408
handle_orphan = conf.get('bzr.transform.orphan_policy')
1409
handle_orphan(self, trans_id, parent_id)
1412
class OrphaningError(errors.BzrError):
1414
# Only bugs could lead to such exception being seen by the user
1415
internal_error = True
1416
_fmt = "Error while orphaning %s in %s directory"
1418
def __init__(self, orphan, parent):
1419
errors.BzrError.__init__(self)
1420
self.orphan = orphan
1421
self.parent = parent
1424
class OrphaningForbidden(OrphaningError):
1426
_fmt = "Policy: %s doesn't allow creating orphans."
1428
def __init__(self, policy):
1429
errors.BzrError.__init__(self)
1430
self.policy = policy
1433
def move_orphan(tt, orphan_id, parent_id):
1434
"""See TreeTransformBase.new_orphan.
1436
This creates a new orphan in the `brz-orphans` dir at the root of the
1439
:param tt: The TreeTransform orphaning `trans_id`.
1441
:param orphan_id: The trans id that should be orphaned.
1443
:param parent_id: The orphan parent trans id.
1445
# Add the orphan dir if it doesn't exist
1446
orphan_dir_basename = 'brz-orphans'
1447
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1448
if tt.final_kind(od_id) is None:
1449
tt.create_directory(od_id)
1450
parent_path = tt._tree_id_paths[parent_id]
1451
# Find a name that doesn't exist yet in the orphan dir
1452
actual_name = tt.final_name(orphan_id)
1453
new_name = tt._available_backup_name(actual_name, od_id)
1454
tt.adjust_path(new_name, od_id, orphan_id)
1455
trace.warning('%s has been orphaned in %s'
1456
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1459
def refuse_orphan(tt, orphan_id, parent_id):
1460
"""See TreeTransformBase.new_orphan.
1462
This refuses to create orphan, letting the caller handle the conflict.
1464
raise OrphaningForbidden('never')
1467
orphaning_registry = registry.Registry()
1468
orphaning_registry.register(
1469
'conflict', refuse_orphan,
1470
'Leave orphans in place and create a conflict on the directory.')
1471
orphaning_registry.register(
1472
'move', move_orphan,
1473
'Move orphans into the brz-orphans directory.')
1474
orphaning_registry._set_default_key('conflict')
1477
opt_transform_orphan = _mod_config.RegistryOption(
1478
'bzr.transform.orphan_policy', orphaning_registry,
1479
help='Policy for orphaned files during transform operations.',
1483
class TreeTransform(DiskTreeTransform):
1484
"""Represent a tree transformation.
1486
This object is designed to support incremental generation of the transform,
1489
However, it gives optimum performance when parent directories are created
1490
before their contents. The transform is then able to put child files
1491
directly in their parent directory, avoiding later renames.
1493
It is easy to produce malformed transforms, but they are generally
1494
harmless. Attempting to apply a malformed transform will cause an
1495
exception to be raised before any modifications are made to the tree.
1497
Many kinds of malformed transforms can be corrected with the
1498
resolve_conflicts function. The remaining ones indicate programming error,
1499
such as trying to create a file with no path.
1501
Two sets of file creation methods are supplied. Convenience methods are:
1506
These are composed of the low-level methods:
1508
* create_file or create_directory or create_symlink
1512
Transform/Transaction ids
1513
-------------------------
1514
trans_ids are temporary ids assigned to all files involved in a transform.
1515
It's possible, even common, that not all files in the Tree have trans_ids.
1517
trans_ids are used because filenames and file_ids are not good enough
1518
identifiers; filenames change, and not all files have file_ids. File-ids
1519
are also associated with trans-ids, so that moving a file moves its
1522
trans_ids are only valid for the TreeTransform that generated them.
1526
Limbo is a temporary directory use to hold new versions of files.
1527
Files are added to limbo by create_file, create_directory, create_symlink,
1528
and their convenience variants (new_*). Files may be removed from limbo
1529
using cancel_creation. Files are renamed from limbo into their final
1530
location as part of TreeTransform.apply
1532
Limbo must be cleaned up, by either calling TreeTransform.apply or
1533
calling TreeTransform.finalize.
1535
Files are placed into limbo inside their parent directories, where
1536
possible. This reduces subsequent renames, and makes operations involving
1537
lots of files faster. This optimization is only possible if the parent
1538
directory is created *before* creating any of its children, so avoid
1539
creating children before parents, where possible.
1543
This temporary directory is used by _FileMover for storing files that are
1544
about to be deleted. In case of rollback, the files will be restored.
1545
FileMover does not delete files until it is sure that a rollback will not
1548
def __init__(self, tree, pb=None):
1549
"""Note: a tree_write lock is taken on the tree.
1551
Use TreeTransform.finalize() to release the lock (can be omitted if
1552
TreeTransform.apply() called).
1554
tree.lock_tree_write()
1556
limbodir = urlutils.local_path_from_url(
1557
tree._transport.abspath('limbo'))
1558
osutils.ensure_empty_directory_exists(
1560
errors.ExistingLimbo)
1561
deletiondir = urlutils.local_path_from_url(
1562
tree._transport.abspath('pending-deletion'))
1563
osutils.ensure_empty_directory_exists(
1565
errors.ExistingPendingDeletion)
1570
# Cache of realpath results, to speed up canonical_path
1571
self._realpaths = {}
1572
# Cache of relpath results, to speed up canonical_path
1574
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1575
tree.case_sensitive)
1576
self._deletiondir = deletiondir
1578
def canonical_path(self, path):
1579
"""Get the canonical tree-relative path"""
1580
# don't follow final symlinks
1581
abs = self._tree.abspath(path)
1582
if abs in self._relpaths:
1583
return self._relpaths[abs]
1584
dirname, basename = os.path.split(abs)
1585
if dirname not in self._realpaths:
1586
self._realpaths[dirname] = os.path.realpath(dirname)
1587
dirname = self._realpaths[dirname]
1588
abs = pathjoin(dirname, basename)
1589
if dirname in self._relpaths:
1590
relpath = pathjoin(self._relpaths[dirname], basename)
1591
relpath = relpath.rstrip('/\\')
1593
relpath = self._tree.relpath(abs)
1594
self._relpaths[abs] = relpath
1597
def tree_kind(self, trans_id):
1598
"""Determine the file kind in the working tree.
1600
:returns: The file kind or None if the file does not exist
1602
path = self._tree_id_paths.get(trans_id)
1606
return file_kind(self._tree.abspath(path))
1607
except errors.NoSuchFile:
1610
def _set_mode(self, trans_id, mode_id, typefunc):
1611
"""Set the mode of new file contents.
1612
The mode_id is the existing file to get the mode from (often the same
1613
as trans_id). The operation is only performed if there's a mode match
1614
according to typefunc.
1619
old_path = self._tree_id_paths[mode_id]
1623
mode = os.stat(self._tree.abspath(old_path)).st_mode
1624
except OSError as e:
1625
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1626
# Either old_path doesn't exist, or the parent of the
1627
# target is not a directory (but will be one eventually)
1628
# Either way, we know it doesn't exist *right now*
1629
# See also bug #248448
1634
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1636
def iter_tree_children(self, parent_id):
1637
"""Iterate through the entry's tree children, if any"""
1639
path = self._tree_id_paths[parent_id]
1643
children = os.listdir(self._tree.abspath(path))
1644
except OSError as e:
1645
if not (osutils._is_error_enotdir(e)
1646
or e.errno in (errno.ENOENT, errno.ESRCH)):
1650
for child in children:
1651
childpath = joinpath(path, child)
1652
if self._tree.is_control_filename(childpath):
1654
yield self.trans_id_tree_path(childpath)
1656
def _generate_limbo_path(self, trans_id):
1657
"""Generate a limbo path using the final path if possible.
1659
This optimizes the performance of applying the tree transform by
1660
avoiding renames. These renames can be avoided only when the parent
1661
directory is already scheduled for creation.
1663
If the final path cannot be used, falls back to using the trans_id as
1666
parent = self._new_parent.get(trans_id)
1667
# if the parent directory is already in limbo (e.g. when building a
1668
# tree), choose a limbo name inside the parent, to reduce further
1670
use_direct_path = False
1671
if self._new_contents.get(parent) == 'directory':
1672
filename = self._new_name.get(trans_id)
1673
if filename is not None:
1674
if parent not in self._limbo_children:
1675
self._limbo_children[parent] = set()
1676
self._limbo_children_names[parent] = {}
1677
use_direct_path = True
1678
# the direct path can only be used if no other file has
1679
# already taken this pathname, i.e. if the name is unused, or
1680
# if it is already associated with this trans_id.
1681
elif self._case_sensitive_target:
1682
if (self._limbo_children_names[parent].get(filename)
1683
in (trans_id, None)):
1684
use_direct_path = True
1686
for l_filename, l_trans_id in viewitems(
1687
self._limbo_children_names[parent]):
1688
if l_trans_id == trans_id:
1690
if l_filename.lower() == filename.lower():
1693
use_direct_path = True
1695
if not use_direct_path:
1696
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1698
limbo_name = pathjoin(self._limbo_files[parent], filename)
1699
self._limbo_children[parent].add(trans_id)
1700
self._limbo_children_names[parent][filename] = trans_id
1704
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1705
"""Apply all changes to the inventory and filesystem.
1707
If filesystem or inventory conflicts are present, MalformedTransform
1710
If apply succeeds, finalize is not necessary.
1712
:param no_conflicts: if True, the caller guarantees there are no
1713
conflicts, so no check is made.
1714
:param precomputed_delta: An inventory delta to use instead of
1716
:param _mover: Supply an alternate FileMover, for testing
1718
for hook in MutableTree.hooks['pre_transform']:
1719
hook(self._tree, self)
1720
if not no_conflicts:
1721
self._check_malformed()
1722
child_pb = ui.ui_factory.nested_progress_bar()
1724
if precomputed_delta is None:
1725
child_pb.update(gettext('Apply phase'), 0, 2)
1726
inventory_delta = self._generate_inventory_delta()
1729
inventory_delta = precomputed_delta
1732
mover = _FileMover()
1736
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1737
self._apply_removals(mover)
1738
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1739
modified_paths = self._apply_insertions(mover)
1744
mover.apply_deletions()
1747
if self.final_file_id(self.root) is None:
1748
inventory_delta = [e for e in inventory_delta if e[0] != '']
1749
self._tree.apply_inventory_delta(inventory_delta)
1750
self._apply_observed_sha1s()
1753
return _TransformResults(modified_paths, self.rename_count)
1755
def _generate_inventory_delta(self):
1756
"""Generate an inventory delta for the current transform."""
1757
inventory_delta = []
1758
child_pb = ui.ui_factory.nested_progress_bar()
1759
new_paths = self._inventory_altered()
1760
total_entries = len(new_paths) + len(self._removed_id)
1762
for num, trans_id in enumerate(self._removed_id):
1764
child_pb.update(gettext('removing file'), num, total_entries)
1765
if trans_id == self._new_root:
1766
file_id = self._tree.get_root_id()
1768
file_id = self.tree_file_id(trans_id)
1769
# File-id isn't really being deleted, just moved
1770
if file_id in self._r_new_id:
1772
path = self._tree_id_paths[trans_id]
1773
inventory_delta.append((path, None, file_id, None))
1774
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1776
entries = self._tree.iter_entries_by_dir(
1777
viewvalues(new_path_file_ids))
1778
old_paths = dict((e.file_id, p) for p, e in entries)
1780
for num, (path, trans_id) in enumerate(new_paths):
1782
child_pb.update(gettext('adding file'),
1783
num + len(self._removed_id), total_entries)
1784
file_id = new_path_file_ids[trans_id]
1788
kind = self.final_kind(trans_id)
1790
kind = self._tree.stored_kind(file_id)
1791
parent_trans_id = self.final_parent(trans_id)
1792
parent_file_id = new_path_file_ids.get(parent_trans_id)
1793
if parent_file_id is None:
1794
parent_file_id = self.final_file_id(parent_trans_id)
1795
if trans_id in self._new_reference_revision:
1796
new_entry = inventory.TreeReference(
1798
self._new_name[trans_id],
1799
self.final_file_id(self._new_parent[trans_id]),
1800
None, self._new_reference_revision[trans_id])
1802
new_entry = inventory.make_entry(kind,
1803
self.final_name(trans_id),
1804
parent_file_id, file_id)
1805
old_path = old_paths.get(new_entry.file_id)
1806
new_executability = self._new_executability.get(trans_id)
1807
if new_executability is not None:
1808
new_entry.executable = new_executability
1809
inventory_delta.append(
1810
(old_path, path, new_entry.file_id, new_entry))
1813
return inventory_delta
1815
def _apply_removals(self, mover):
1816
"""Perform tree operations that remove directory/inventory names.
1818
That is, delete files that are to be deleted, and put any files that
1819
need renaming into limbo. This must be done in strict child-to-parent
1822
If inventory_delta is None, no inventory delta generation is performed.
1824
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1825
child_pb = ui.ui_factory.nested_progress_bar()
1827
for num, (path, trans_id) in enumerate(tree_paths):
1828
# do not attempt to move root into a subdirectory of itself.
1831
child_pb.update(gettext('removing file'), num, len(tree_paths))
1832
full_path = self._tree.abspath(path)
1833
if trans_id in self._removed_contents:
1834
delete_path = os.path.join(self._deletiondir, trans_id)
1835
mover.pre_delete(full_path, delete_path)
1836
elif (trans_id in self._new_name
1837
or trans_id in self._new_parent):
1839
mover.rename(full_path, self._limbo_name(trans_id))
1840
except errors.TransformRenameFailed as e:
1841
if e.errno != errno.ENOENT:
1844
self.rename_count += 1
1848
def _apply_insertions(self, mover):
1849
"""Perform tree operations that insert directory/inventory names.
1851
That is, create any files that need to be created, and restore from
1852
limbo any files that needed renaming. This must be done in strict
1853
parent-to-child order.
1855
If inventory_delta is None, no inventory delta is calculated, and
1856
no list of modified paths is returned.
1858
new_paths = self.new_paths(filesystem_only=True)
1860
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1862
child_pb = ui.ui_factory.nested_progress_bar()
1864
for num, (path, trans_id) in enumerate(new_paths):
1866
child_pb.update(gettext('adding file'), num, len(new_paths))
1867
full_path = self._tree.abspath(path)
1868
if trans_id in self._needs_rename:
1870
mover.rename(self._limbo_name(trans_id), full_path)
1871
except errors.TransformRenameFailed as e:
1872
# We may be renaming a dangling inventory id
1873
if e.errno != errno.ENOENT:
1876
self.rename_count += 1
1877
# TODO: if trans_id in self._observed_sha1s, we should
1878
# re-stat the final target, since ctime will be
1879
# updated by the change.
1880
if (trans_id in self._new_contents or
1881
self.path_changed(trans_id)):
1882
if trans_id in self._new_contents:
1883
modified_paths.append(full_path)
1884
if trans_id in self._new_executability:
1885
self._set_executability(path, trans_id)
1886
if trans_id in self._observed_sha1s:
1887
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1888
st = osutils.lstat(full_path)
1889
self._observed_sha1s[trans_id] = (o_sha1, st)
1892
for path, trans_id in new_paths:
1893
# new_paths includes stuff like workingtree conflicts. Only the
1894
# stuff in new_contents actually comes from limbo.
1895
if trans_id in self._limbo_files:
1896
del self._limbo_files[trans_id]
1897
self._new_contents.clear()
1898
return modified_paths
1900
def _apply_observed_sha1s(self):
1901
"""After we have finished renaming everything, update observed sha1s
1903
This has to be done after self._tree.apply_inventory_delta, otherwise
1904
it doesn't know anything about the files we are updating. Also, we want
1905
to do this as late as possible, so that most entries end up cached.
1907
# TODO: this doesn't update the stat information for directories. So
1908
# the first 'bzr status' will still need to rewrite
1909
# .bzr/checkout/dirstate. However, we at least don't need to
1910
# re-read all of the files.
1911
# TODO: If the operation took a while, we could do a time.sleep(3) here
1912
# to allow the clock to tick over and ensure we won't have any
1913
# problems. (we could observe start time, and finish time, and if
1914
# it is less than eg 10% overhead, add a sleep call.)
1915
paths = FinalPaths(self)
1916
for trans_id, observed in viewitems(self._observed_sha1s):
1917
path = paths.get_path(trans_id)
1918
# We could get the file_id, but dirstate prefers to use the path
1919
# anyway, and it is 'cheaper' to determine.
1920
# file_id = self._new_id[trans_id]
1921
self._tree._observed_sha1(None, path, observed)
1924
class TransformPreview(DiskTreeTransform):
1925
"""A TreeTransform for generating preview trees.
1927
Unlike TreeTransform, this version works when the input tree is a
1928
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1929
unversioned files in the input tree.
1932
def __init__(self, tree, pb=None, case_sensitive=True):
1934
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1935
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1937
def canonical_path(self, path):
1940
def tree_kind(self, trans_id):
1941
path = self._tree_id_paths.get(trans_id)
1944
kind = self._tree.path_content_summary(path)[0]
1945
if kind == 'missing':
1949
def _set_mode(self, trans_id, mode_id, typefunc):
1950
"""Set the mode of new file contents.
1951
The mode_id is the existing file to get the mode from (often the same
1952
as trans_id). The operation is only performed if there's a mode match
1953
according to typefunc.
1955
# is it ok to ignore this? probably
1958
def iter_tree_children(self, parent_id):
1959
"""Iterate through the entry's tree children, if any"""
1961
path = self._tree_id_paths[parent_id]
1964
file_id = self.tree_file_id(parent_id)
1967
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1968
children = getattr(entry, 'children', {})
1969
for child in children:
1970
childpath = joinpath(path, child)
1971
yield self.trans_id_tree_path(childpath)
1973
def new_orphan(self, trans_id, parent_id):
1974
raise NotImplementedError(self.new_orphan)
1977
class _PreviewTree(inventorytree.InventoryTree):
1978
"""Partial implementation of Tree to support show_diff_trees"""
1980
def __init__(self, transform):
1981
self._transform = transform
1982
self._final_paths = FinalPaths(transform)
1983
self.__by_parent = None
1984
self._parent_ids = []
1985
self._all_children_cache = {}
1986
self._path2trans_id_cache = {}
1987
self._final_name_cache = {}
1988
self._iter_changes_cache = dict((c[0], c) for c in
1989
self._transform.iter_changes())
1991
def _content_change(self, file_id):
1992
"""Return True if the content of this file changed"""
1993
changes = self._iter_changes_cache.get(file_id)
1994
# changes[2] is true if the file content changed. See
1995
# InterTree.iter_changes.
1996
return (changes is not None and changes[2])
1998
def _get_repository(self):
1999
repo = getattr(self._transform._tree, '_repository', None)
2001
repo = self._transform._tree.branch.repository
2004
def _iter_parent_trees(self):
2005
for revision_id in self.get_parent_ids():
2007
yield self.revision_tree(revision_id)
2008
except errors.NoSuchRevisionInTree:
2009
yield self._get_repository().revision_tree(revision_id)
2011
def _get_file_revision(self, file_id, vf, tree_revision):
2012
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2013
self._iter_parent_trees()]
2014
vf.add_lines((file_id, tree_revision), parent_keys,
2015
self.get_file_lines(file_id))
2016
repo = self._get_repository()
2017
base_vf = repo.texts
2018
if base_vf not in vf.fallback_versionedfiles:
2019
vf.fallback_versionedfiles.append(base_vf)
2020
return tree_revision
2022
def _stat_limbo_file(self, file_id=None, trans_id=None):
2023
if trans_id is None:
2024
trans_id = self._transform.trans_id_file_id(file_id)
2025
name = self._transform._limbo_name(trans_id)
2026
return os.lstat(name)
2029
def _by_parent(self):
2030
if self.__by_parent is None:
2031
self.__by_parent = self._transform.by_parent()
2032
return self.__by_parent
2034
def _comparison_data(self, entry, path):
2035
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2036
if kind == 'missing':
2040
file_id = self._transform.final_file_id(self._path2trans_id(path))
2041
executable = self.is_executable(file_id, path)
2042
return kind, executable, None
2044
def is_locked(self):
2047
def lock_read(self):
2048
# Perhaps in theory, this should lock the TreeTransform?
2049
return lock.LogicalLockResult(self.unlock)
2055
def root_inventory(self):
2056
"""This Tree does not use inventory as its backing data."""
2057
raise NotImplementedError(_PreviewTree.root_inventory)
2059
def get_root_id(self):
2060
return self._transform.final_file_id(self._transform.root)
2062
def all_file_ids(self):
2063
tree_ids = set(self._transform._tree.all_file_ids())
2064
tree_ids.difference_update(self._transform.tree_file_id(t)
2065
for t in self._transform._removed_id)
2066
tree_ids.update(viewvalues(self._transform._new_id))
2070
return iter(self.all_file_ids())
2072
def _has_id(self, file_id, fallback_check):
2073
if file_id in self._transform._r_new_id:
2075
elif file_id in {self._transform.tree_file_id(trans_id) for
2076
trans_id in self._transform._removed_id}:
2079
return fallback_check(file_id)
2081
def has_id(self, file_id):
2082
return self._has_id(file_id, self._transform._tree.has_id)
2084
def has_or_had_id(self, file_id):
2085
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2087
def _path2trans_id(self, path):
2088
# We must not use None here, because that is a valid value to store.
2089
trans_id = self._path2trans_id_cache.get(path, object)
2090
if trans_id is not object:
2092
segments = splitpath(path)
2093
cur_parent = self._transform.root
2094
for cur_segment in segments:
2095
for child in self._all_children(cur_parent):
2096
final_name = self._final_name_cache.get(child)
2097
if final_name is None:
2098
final_name = self._transform.final_name(child)
2099
self._final_name_cache[child] = final_name
2100
if final_name == cur_segment:
2104
self._path2trans_id_cache[path] = None
2106
self._path2trans_id_cache[path] = cur_parent
2109
def path2id(self, path):
2110
if isinstance(path, list):
2113
path = osutils.pathjoin(*path)
2114
return self._transform.final_file_id(self._path2trans_id(path))
2116
def id2path(self, file_id):
2117
trans_id = self._transform.trans_id_file_id(file_id)
2119
return self._final_paths._determine_path(trans_id)
2121
raise errors.NoSuchId(self, file_id)
2123
def _all_children(self, trans_id):
2124
children = self._all_children_cache.get(trans_id)
2125
if children is not None:
2127
children = set(self._transform.iter_tree_children(trans_id))
2128
# children in the _new_parent set are provided by _by_parent.
2129
children.difference_update(self._transform._new_parent)
2130
children.update(self._by_parent.get(trans_id, []))
2131
self._all_children_cache[trans_id] = children
2134
def iter_children(self, file_id):
2135
trans_id = self._transform.trans_id_file_id(file_id)
2136
for child_trans_id in self._all_children(trans_id):
2137
yield self._transform.final_file_id(child_trans_id)
2140
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2141
in self._transform._tree.extras())
2142
possible_extras.update(self._transform._new_contents)
2143
possible_extras.update(self._transform._removed_id)
2144
for trans_id in possible_extras:
2145
if self._transform.final_file_id(trans_id) is None:
2146
yield self._final_paths._determine_path(trans_id)
2148
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2149
yield_parents=False):
2150
for trans_id, parent_file_id in ordered_entries:
2151
file_id = self._transform.final_file_id(trans_id)
2154
if (specific_file_ids is not None
2155
and file_id not in specific_file_ids):
2157
kind = self._transform.final_kind(trans_id)
2159
kind = self._transform._tree.stored_kind(file_id)
2160
new_entry = inventory.make_entry(
2162
self._transform.final_name(trans_id),
2163
parent_file_id, file_id)
2164
yield new_entry, trans_id
2166
def _list_files_by_dir(self):
2167
todo = [ROOT_PARENT]
2169
while len(todo) > 0:
2171
parent_file_id = self._transform.final_file_id(parent)
2172
children = list(self._all_children(parent))
2173
paths = dict(zip(children, self._final_paths.get_paths(children)))
2174
children.sort(key=paths.get)
2175
todo.extend(reversed(children))
2176
for trans_id in children:
2177
ordered_ids.append((trans_id, parent_file_id))
2180
def iter_child_entries(self, file_id, path=None):
2181
self.id2path(file_id)
2182
trans_id = self._transform.trans_id_file_id(file_id)
2183
todo = [(child_trans_id, trans_id) for child_trans_id in
2184
self._all_children(trans_id)]
2185
for entry, trans_id in self._make_inv_entries(todo):
2188
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2189
# This may not be a maximally efficient implementation, but it is
2190
# reasonably straightforward. An implementation that grafts the
2191
# TreeTransform changes onto the tree's iter_entries_by_dir results
2192
# might be more efficient, but requires tricky inferences about stack
2194
ordered_ids = self._list_files_by_dir()
2195
for entry, trans_id in self._make_inv_entries(ordered_ids,
2196
specific_file_ids, yield_parents=yield_parents):
2197
yield unicode(self._final_paths.get_path(trans_id)), entry
2199
def _iter_entries_for_dir(self, dir_path):
2200
"""Return path, entry for items in a directory without recursing down."""
2201
dir_file_id = self.path2id(dir_path)
2203
for file_id in self.iter_children(dir_file_id):
2204
trans_id = self._transform.trans_id_file_id(file_id)
2205
ordered_ids.append((trans_id, file_id))
2206
for entry, trans_id in self._make_inv_entries(ordered_ids):
2207
yield unicode(self._final_paths.get_path(trans_id)), entry
2209
def list_files(self, include_root=False, from_dir=None, recursive=True):
2210
"""See WorkingTree.list_files."""
2211
# XXX This should behave like WorkingTree.list_files, but is really
2212
# more like RevisionTree.list_files.
2216
prefix = from_dir + '/'
2217
entries = self.iter_entries_by_dir()
2218
for path, entry in entries:
2219
if entry.name == '' and not include_root:
2222
if not path.startswith(prefix):
2224
path = path[len(prefix):]
2225
yield path, 'V', entry.kind, entry.file_id, entry
2227
if from_dir is None and include_root is True:
2228
root_entry = inventory.make_entry('directory', '',
2229
ROOT_PARENT, self.get_root_id())
2230
yield '', 'V', 'directory', root_entry.file_id, root_entry
2231
entries = self._iter_entries_for_dir(from_dir or '')
2232
for path, entry in entries:
2233
yield path, 'V', entry.kind, entry.file_id, entry
2235
def kind(self, file_id):
2236
trans_id = self._transform.trans_id_file_id(file_id)
2237
return self._transform.final_kind(trans_id)
2239
def stored_kind(self, file_id):
2240
trans_id = self._transform.trans_id_file_id(file_id)
2242
return self._transform._new_contents[trans_id]
2244
return self._transform._tree.stored_kind(file_id)
2246
def get_file_mtime(self, file_id, path=None):
2247
"""See Tree.get_file_mtime"""
2248
if not self._content_change(file_id):
2249
return self._transform._tree.get_file_mtime(file_id)
2250
return self._stat_limbo_file(file_id).st_mtime
2252
def _file_size(self, entry, stat_value):
2253
return self.get_file_size(entry.file_id)
2255
def get_file_size(self, file_id):
2256
"""See Tree.get_file_size"""
2257
trans_id = self._transform.trans_id_file_id(file_id)
2258
kind = self._transform.final_kind(trans_id)
2261
if trans_id in self._transform._new_contents:
2262
return self._stat_limbo_file(trans_id=trans_id).st_size
2263
if self.kind(file_id) == 'file':
2264
return self._transform._tree.get_file_size(file_id)
2268
def get_file_verifier(self, file_id, path=None, stat_value=None):
2269
trans_id = self._transform.trans_id_file_id(file_id)
2270
kind = self._transform._new_contents.get(trans_id)
2272
return self._transform._tree.get_file_verifier(file_id)
2274
fileobj = self.get_file(file_id)
2276
return ("SHA1", sha_file(fileobj))
2280
def get_file_sha1(self, file_id, path=None, stat_value=None):
2281
trans_id = self._transform.trans_id_file_id(file_id)
2282
kind = self._transform._new_contents.get(trans_id)
2284
return self._transform._tree.get_file_sha1(file_id)
2286
fileobj = self.get_file(file_id)
2288
return sha_file(fileobj)
2292
def is_executable(self, file_id, path=None):
2295
trans_id = self._transform.trans_id_file_id(file_id)
2297
return self._transform._new_executability[trans_id]
2300
return self._transform._tree.is_executable(file_id, path)
2301
except OSError as e:
2302
if e.errno == errno.ENOENT:
2305
except errors.NoSuchId:
2308
def has_filename(self, path):
2309
trans_id = self._path2trans_id(path)
2310
if trans_id in self._transform._new_contents:
2312
elif trans_id in self._transform._removed_contents:
2315
return self._transform._tree.has_filename(path)
2317
def path_content_summary(self, path):
2318
trans_id = self._path2trans_id(path)
2319
tt = self._transform
2320
tree_path = tt._tree_id_paths.get(trans_id)
2321
kind = tt._new_contents.get(trans_id)
2323
if tree_path is None or trans_id in tt._removed_contents:
2324
return 'missing', None, None, None
2325
summary = tt._tree.path_content_summary(tree_path)
2326
kind, size, executable, link_or_sha1 = summary
2329
limbo_name = tt._limbo_name(trans_id)
2330
if trans_id in tt._new_reference_revision:
2331
kind = 'tree-reference'
2333
statval = os.lstat(limbo_name)
2334
size = statval.st_size
2335
if not tt._limbo_supports_executable():
2338
executable = statval.st_mode & S_IEXEC
2342
if kind == 'symlink':
2343
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2344
executable = tt._new_executability.get(trans_id, executable)
2345
return kind, size, executable, link_or_sha1
2347
def iter_changes(self, from_tree, include_unchanged=False,
2348
specific_files=None, pb=None, extra_trees=None,
2349
require_versioned=True, want_unversioned=False):
2350
"""See InterTree.iter_changes.
2352
This has a fast path that is only used when the from_tree matches
2353
the transform tree, and no fancy options are supplied.
2355
if (from_tree is not self._transform._tree or include_unchanged or
2356
specific_files or want_unversioned):
2357
return tree.InterTree(from_tree, self).iter_changes(
2358
include_unchanged=include_unchanged,
2359
specific_files=specific_files,
2361
extra_trees=extra_trees,
2362
require_versioned=require_versioned,
2363
want_unversioned=want_unversioned)
2364
if want_unversioned:
2365
raise ValueError('want_unversioned is not supported')
2366
return self._transform.iter_changes()
2368
def get_file(self, file_id, path=None):
2369
"""See Tree.get_file"""
2370
if not self._content_change(file_id):
2371
return self._transform._tree.get_file(file_id, path)
2372
trans_id = self._transform.trans_id_file_id(file_id)
2373
name = self._transform._limbo_name(trans_id)
2374
return open(name, 'rb')
2376
def get_file_with_stat(self, file_id, path=None):
2377
return self.get_file(file_id, path), None
2379
def annotate_iter(self, file_id,
2380
default_revision=_mod_revision.CURRENT_REVISION):
2381
changes = self._iter_changes_cache.get(file_id)
2385
changed_content, versioned, kind = (changes[2], changes[3],
2389
get_old = (kind[0] == 'file' and versioned[0])
2391
old_annotation = self._transform._tree.annotate_iter(file_id,
2392
default_revision=default_revision)
2396
return old_annotation
2397
if not changed_content:
2398
return old_annotation
2399
# TODO: This is doing something similar to what WT.annotate_iter is
2400
# doing, however it fails slightly because it doesn't know what
2401
# the *other* revision_id is, so it doesn't know how to give the
2402
# other as the origin for some lines, they all get
2403
# 'default_revision'
2404
# It would be nice to be able to use the new Annotator based
2405
# approach, as well.
2406
return annotate.reannotate([old_annotation],
2407
self.get_file(file_id).readlines(),
2410
def get_symlink_target(self, file_id, path=None):
2411
"""See Tree.get_symlink_target"""
2412
if not self._content_change(file_id):
2413
return self._transform._tree.get_symlink_target(file_id)
2414
trans_id = self._transform.trans_id_file_id(file_id)
2415
name = self._transform._limbo_name(trans_id)
2416
return osutils.readlink(name)
2418
def walkdirs(self, prefix=''):
2419
pending = [self._transform.root]
2420
while len(pending) > 0:
2421
parent_id = pending.pop()
2424
prefix = prefix.rstrip('/')
2425
parent_path = self._final_paths.get_path(parent_id)
2426
parent_file_id = self._transform.final_file_id(parent_id)
2427
for child_id in self._all_children(parent_id):
2428
path_from_root = self._final_paths.get_path(child_id)
2429
basename = self._transform.final_name(child_id)
2430
file_id = self._transform.final_file_id(child_id)
2431
kind = self._transform.final_kind(child_id)
2432
if kind is not None:
2433
versioned_kind = kind
2436
versioned_kind = self._transform._tree.stored_kind(file_id)
2437
if versioned_kind == 'directory':
2438
subdirs.append(child_id)
2439
children.append((path_from_root, basename, kind, None,
2440
file_id, versioned_kind))
2442
if parent_path.startswith(prefix):
2443
yield (parent_path, parent_file_id), children
2444
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2447
def get_parent_ids(self):
2448
return self._parent_ids
2450
def set_parent_ids(self, parent_ids):
2451
self._parent_ids = parent_ids
2453
def get_revision_tree(self, revision_id):
2454
return self._transform._tree.get_revision_tree(revision_id)
2457
def joinpath(parent, child):
2458
"""Join tree-relative paths, handling the tree root specially"""
2459
if parent is None or parent == "":
2462
return pathjoin(parent, child)
2465
class FinalPaths(object):
2466
"""Make path calculation cheap by memoizing paths.
2468
The underlying tree must not be manipulated between calls, or else
2469
the results will likely be incorrect.
2471
def __init__(self, transform):
2472
object.__init__(self)
2473
self._known_paths = {}
2474
self.transform = transform
2476
def _determine_path(self, trans_id):
2477
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2479
name = self.transform.final_name(trans_id)
2480
parent_id = self.transform.final_parent(trans_id)
2481
if parent_id == self.transform.root:
2484
return pathjoin(self.get_path(parent_id), name)
2486
def get_path(self, trans_id):
2487
"""Find the final path associated with a trans_id"""
2488
if trans_id not in self._known_paths:
2489
self._known_paths[trans_id] = self._determine_path(trans_id)
2490
return self._known_paths[trans_id]
2492
def get_paths(self, trans_ids):
2493
return [(self.get_path(t), t) for t in trans_ids]
2497
def topology_sorted_ids(tree):
2498
"""Determine the topological order of the ids in a tree"""
2499
file_ids = list(tree)
2500
file_ids.sort(key=tree.id2path)
2504
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2505
delta_from_tree=False):
2506
"""Create working tree for a branch, using a TreeTransform.
2508
This function should be used on empty trees, having a tree root at most.
2509
(see merge and revert functionality for working with existing trees)
2511
Existing files are handled like so:
2513
- Existing bzrdirs take precedence over creating new items. They are
2514
created as '%s.diverted' % name.
2515
- Otherwise, if the content on disk matches the content we are building,
2516
it is silently replaced.
2517
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2519
:param tree: The tree to convert wt into a copy of
2520
:param wt: The working tree that files will be placed into
2521
:param accelerator_tree: A tree which can be used for retrieving file
2522
contents more quickly than tree itself, i.e. a workingtree. tree
2523
will be used for cases where accelerator_tree's content is different.
2524
:param hardlink: If true, hard-link files to accelerator_tree, where
2525
possible. accelerator_tree must implement abspath, i.e. be a
2527
:param delta_from_tree: If true, build_tree may use the input Tree to
2528
generate the inventory delta.
2530
with wt.lock_tree_write(), tree.lock_read():
2531
if accelerator_tree is not None:
2532
accelerator_tree.lock_read()
2534
return _build_tree(tree, wt, accelerator_tree, hardlink,
2537
if accelerator_tree is not None:
2538
accelerator_tree.unlock()
2541
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2542
"""See build_tree."""
2543
for num, _unused in enumerate(wt.all_file_ids()):
2544
if num > 0: # more than just a root
2545
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2547
top_pb = ui.ui_factory.nested_progress_bar()
2548
pp = ProgressPhase("Build phase", 2, top_pb)
2549
if tree.get_root_id() is not None:
2550
# This is kind of a hack: we should be altering the root
2551
# as part of the regular tree shape diff logic.
2552
# The conditional test here is to avoid doing an
2553
# expensive operation (flush) every time the root id
2554
# is set within the tree, nor setting the root and thus
2555
# marking the tree as dirty, because we use two different
2556
# idioms here: tree interfaces and inventory interfaces.
2557
if wt.get_root_id() != tree.get_root_id():
2558
wt.set_root_id(tree.get_root_id())
2560
tt = TreeTransform(wt)
2564
file_trans_id[wt.get_root_id()] = \
2565
tt.trans_id_tree_file_id(wt.get_root_id())
2566
pb = ui.ui_factory.nested_progress_bar()
2568
deferred_contents = []
2570
total = len(tree.all_file_ids())
2572
precomputed_delta = []
2574
precomputed_delta = None
2575
# Check if tree inventory has content. If so, we populate
2576
# existing_files with the directory content. If there are no
2577
# entries we skip populating existing_files as its not used.
2578
# This improves performance and unncessary work on large
2579
# directory trees. (#501307)
2581
existing_files = set()
2582
for dir, files in wt.walkdirs():
2583
existing_files.update(f[0] for f in files)
2584
for num, (tree_path, entry) in \
2585
enumerate(tree.iter_entries_by_dir()):
2586
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2587
if entry.parent_id is None:
2590
file_id = entry.file_id
2592
precomputed_delta.append((None, tree_path, file_id, entry))
2593
if tree_path in existing_files:
2594
target_path = wt.abspath(tree_path)
2595
kind = file_kind(target_path)
2596
if kind == "directory":
2598
controldir.ControlDir.open(target_path)
2599
except errors.NotBranchError:
2603
if (file_id not in divert and
2604
_content_match(tree, entry, file_id, kind,
2606
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2607
if kind == 'directory':
2609
parent_id = file_trans_id[entry.parent_id]
2610
if entry.kind == 'file':
2611
# We *almost* replicate new_by_entry, so that we can defer
2612
# getting the file text, and get them all at once.
2613
trans_id = tt.create_path(entry.name, parent_id)
2614
file_trans_id[file_id] = trans_id
2615
tt.version_file(file_id, trans_id)
2616
executable = tree.is_executable(file_id, tree_path)
2618
tt.set_executability(executable, trans_id)
2619
trans_data = (trans_id, tree_path, entry.text_sha1)
2620
deferred_contents.append((file_id, trans_data))
2622
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2625
new_trans_id = file_trans_id[file_id]
2626
old_parent = tt.trans_id_tree_path(tree_path)
2627
_reparent_children(tt, old_parent, new_trans_id)
2628
offset = num + 1 - len(deferred_contents)
2629
_create_files(tt, tree, deferred_contents, pb, offset,
2630
accelerator_tree, hardlink)
2634
divert_trans = set(file_trans_id[f] for f in divert)
2635
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2636
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2637
if len(raw_conflicts) > 0:
2638
precomputed_delta = None
2639
conflicts = cook_conflicts(raw_conflicts, tt)
2640
for conflict in conflicts:
2641
trace.warning(unicode(conflict))
2643
wt.add_conflicts(conflicts)
2644
except errors.UnsupportedOperation:
2646
result = tt.apply(no_conflicts=True,
2647
precomputed_delta=precomputed_delta)
2654
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2656
total = len(desired_files) + offset
2658
if accelerator_tree is None:
2659
new_desired_files = desired_files
2661
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2662
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2663
in iter if not (c or e[0] != e[1])]
2664
if accelerator_tree.supports_content_filtering():
2665
unchanged = [(f, p) for (f, p) in unchanged
2666
if not next(accelerator_tree.iter_search_rules([p]))]
2667
unchanged = dict(unchanged)
2668
new_desired_files = []
2670
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2671
accelerator_path = unchanged.get(file_id)
2672
if accelerator_path is None:
2673
new_desired_files.append((file_id,
2674
(trans_id, tree_path, text_sha1)))
2676
pb.update(gettext('Adding file contents'), count + offset, total)
2678
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2681
contents = accelerator_tree.get_file(file_id, accelerator_path)
2682
if wt.supports_content_filtering():
2683
filters = wt._content_filter_stack(tree_path)
2684
contents = filtered_output_bytes(contents, filters,
2685
ContentFilterContext(tree_path, tree))
2687
tt.create_file(contents, trans_id, sha1=text_sha1)
2691
except AttributeError:
2692
# after filtering, contents may no longer be file-like
2696
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2697
tree.iter_files_bytes(new_desired_files)):
2698
if wt.supports_content_filtering():
2699
filters = wt._content_filter_stack(tree_path)
2700
contents = filtered_output_bytes(contents, filters,
2701
ContentFilterContext(tree_path, tree))
2702
tt.create_file(contents, trans_id, sha1=text_sha1)
2703
pb.update(gettext('Adding file contents'), count + offset, total)
2706
def _reparent_children(tt, old_parent, new_parent):
2707
for child in tt.iter_tree_children(old_parent):
2708
tt.adjust_path(tt.final_name(child), new_parent, child)
2711
def _reparent_transform_children(tt, old_parent, new_parent):
2712
by_parent = tt.by_parent()
2713
for child in by_parent[old_parent]:
2714
tt.adjust_path(tt.final_name(child), new_parent, child)
2715
return by_parent[old_parent]
2718
def _content_match(tree, entry, file_id, kind, target_path):
2719
if entry.kind != kind:
2721
if entry.kind == "directory":
2723
if entry.kind == "file":
2724
f = file(target_path, 'rb')
2726
if tree.get_file_text(file_id) == f.read():
2730
elif entry.kind == "symlink":
2731
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2736
def resolve_checkout(tt, conflicts, divert):
2737
new_conflicts = set()
2738
for c_type, conflict in ((c[0], c) for c in conflicts):
2739
# Anything but a 'duplicate' would indicate programmer error
2740
if c_type != 'duplicate':
2741
raise AssertionError(c_type)
2742
# Now figure out which is new and which is old
2743
if tt.new_contents(conflict[1]):
2744
new_file = conflict[1]
2745
old_file = conflict[2]
2747
new_file = conflict[2]
2748
old_file = conflict[1]
2750
# We should only get here if the conflict wasn't completely
2752
final_parent = tt.final_parent(old_file)
2753
if new_file in divert:
2754
new_name = tt.final_name(old_file)+'.diverted'
2755
tt.adjust_path(new_name, final_parent, new_file)
2756
new_conflicts.add((c_type, 'Diverted to',
2757
new_file, old_file))
2759
new_name = tt.final_name(old_file)+'.moved'
2760
tt.adjust_path(new_name, final_parent, old_file)
2761
new_conflicts.add((c_type, 'Moved existing file to',
2762
old_file, new_file))
2763
return new_conflicts
2766
def new_by_entry(tt, entry, parent_id, tree):
2767
"""Create a new file according to its inventory entry"""
2771
contents = tree.get_file(entry.file_id).readlines()
2772
executable = tree.is_executable(entry.file_id)
2773
return tt.new_file(name, parent_id, contents, entry.file_id,
2775
elif kind in ('directory', 'tree-reference'):
2776
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2777
if kind == 'tree-reference':
2778
tt.set_tree_reference(entry.reference_revision, trans_id)
2780
elif kind == 'symlink':
2781
target = tree.get_symlink_target(entry.file_id)
2782
return tt.new_symlink(name, parent_id, target, entry.file_id)
2784
raise errors.BadFileKindError(name, kind)
2787
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2788
filter_tree_path=None):
2789
"""Create new file contents according to tree contents.
2791
:param filter_tree_path: the tree path to use to lookup
2792
content filters to apply to the bytes output in the working tree.
2793
This only applies if the working tree supports content filtering.
2795
kind = tree.kind(file_id)
2796
if kind == 'directory':
2797
tt.create_directory(trans_id)
2798
elif kind == "file":
2800
tree_file = tree.get_file(file_id)
2802
bytes = tree_file.readlines()
2806
if wt.supports_content_filtering() and filter_tree_path is not None:
2807
filters = wt._content_filter_stack(filter_tree_path)
2808
bytes = filtered_output_bytes(bytes, filters,
2809
ContentFilterContext(filter_tree_path, tree))
2810
tt.create_file(bytes, trans_id)
2811
elif kind == "symlink":
2812
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2814
raise AssertionError('Unknown kind %r' % kind)
2817
def create_entry_executability(tt, entry, trans_id):
2818
"""Set the executability of a trans_id according to an inventory entry"""
2819
if entry.kind == "file":
2820
tt.set_executability(entry.executable, trans_id)
2823
def revert(working_tree, target_tree, filenames, backups=False,
2824
pb=None, change_reporter=None):
2825
"""Revert a working tree's contents to those of a target tree."""
2826
target_tree.lock_read()
2827
pb = ui.ui_factory.nested_progress_bar()
2828
tt = TreeTransform(working_tree, pb)
2830
pp = ProgressPhase("Revert phase", 3, pb)
2831
conflicts, merge_modified = _prepare_revert_transform(
2832
working_tree, target_tree, tt, filenames, backups, pp)
2834
change_reporter = delta._ChangeReporter(
2835
unversioned_filter=working_tree.is_ignored)
2836
delta.report_changes(tt.iter_changes(), change_reporter)
2837
for conflict in conflicts:
2838
trace.warning(unicode(conflict))
2841
working_tree.set_merge_modified(merge_modified)
2843
target_tree.unlock()
2849
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2850
backups, pp, basis_tree=None,
2851
merge_modified=None):
2852
child_pb = ui.ui_factory.nested_progress_bar()
2854
if merge_modified is None:
2855
merge_modified = working_tree.merge_modified()
2856
merge_modified = _alter_files(working_tree, target_tree, tt,
2857
child_pb, filenames, backups,
2858
merge_modified, basis_tree)
2861
child_pb = ui.ui_factory.nested_progress_bar()
2863
raw_conflicts = resolve_conflicts(tt, child_pb,
2864
lambda t, c: conflict_pass(t, c, target_tree))
2867
conflicts = cook_conflicts(raw_conflicts, tt)
2868
return conflicts, merge_modified
2871
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2872
backups, merge_modified, basis_tree=None):
2873
if basis_tree is not None:
2874
basis_tree.lock_read()
2875
# We ask the working_tree for its changes relative to the target, rather
2876
# than the target changes relative to the working tree. Because WT4 has an
2877
# optimizer to compare itself to a target, but no optimizer for the
2879
change_list = working_tree.iter_changes(target_tree,
2880
specific_files=specific_files, pb=pb)
2881
if target_tree.get_root_id() is None:
2887
for id_num, (file_id, path, changed_content, versioned, parent, name,
2888
kind, executable) in enumerate(change_list):
2889
target_path, wt_path = path
2890
target_versioned, wt_versioned = versioned
2891
target_parent, wt_parent = parent
2892
target_name, wt_name = name
2893
target_kind, wt_kind = kind
2894
target_executable, wt_executable = executable
2895
if skip_root and wt_parent is None:
2897
trans_id = tt.trans_id_file_id(file_id)
2900
keep_content = False
2901
if wt_kind == 'file' and (backups or target_kind is None):
2902
wt_sha1 = working_tree.get_file_sha1(file_id)
2903
if merge_modified.get(file_id) != wt_sha1:
2904
# acquire the basis tree lazily to prevent the
2905
# expense of accessing it when it's not needed ?
2906
# (Guessing, RBC, 200702)
2907
if basis_tree is None:
2908
basis_tree = working_tree.basis_tree()
2909
basis_tree.lock_read()
2910
if basis_tree.has_id(file_id):
2911
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2913
elif target_kind is None and not target_versioned:
2915
if wt_kind is not None:
2916
if not keep_content:
2917
tt.delete_contents(trans_id)
2918
elif target_kind is not None:
2919
parent_trans_id = tt.trans_id_file_id(wt_parent)
2920
backup_name = tt._available_backup_name(
2921
wt_name, parent_trans_id)
2922
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2923
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2924
if wt_versioned and target_versioned:
2925
tt.unversion_file(trans_id)
2926
tt.version_file(file_id, new_trans_id)
2927
# New contents should have the same unix perms as old
2930
trans_id = new_trans_id
2931
if target_kind in ('directory', 'tree-reference'):
2932
tt.create_directory(trans_id)
2933
if target_kind == 'tree-reference':
2934
revision = target_tree.get_reference_revision(file_id,
2936
tt.set_tree_reference(revision, trans_id)
2937
elif target_kind == 'symlink':
2938
tt.create_symlink(target_tree.get_symlink_target(file_id),
2940
elif target_kind == 'file':
2941
deferred_files.append((file_id, (trans_id, mode_id)))
2942
if basis_tree is None:
2943
basis_tree = working_tree.basis_tree()
2944
basis_tree.lock_read()
2945
new_sha1 = target_tree.get_file_sha1(file_id)
2946
if (basis_tree.has_id(file_id) and
2947
new_sha1 == basis_tree.get_file_sha1(file_id)):
2948
if file_id in merge_modified:
2949
del merge_modified[file_id]
2951
merge_modified[file_id] = new_sha1
2953
# preserve the execute bit when backing up
2954
if keep_content and wt_executable == target_executable:
2955
tt.set_executability(target_executable, trans_id)
2956
elif target_kind is not None:
2957
raise AssertionError(target_kind)
2958
if not wt_versioned and target_versioned:
2959
tt.version_file(file_id, trans_id)
2960
if wt_versioned and not target_versioned:
2961
tt.unversion_file(trans_id)
2962
if (target_name is not None and
2963
(wt_name != target_name or wt_parent != target_parent)):
2964
if target_name == '' and target_parent is None:
2965
parent_trans = ROOT_PARENT
2967
parent_trans = tt.trans_id_file_id(target_parent)
2968
if wt_parent is None and wt_versioned:
2969
tt.adjust_root_path(target_name, parent_trans)
2971
tt.adjust_path(target_name, parent_trans, trans_id)
2972
if wt_executable != target_executable and target_kind == "file":
2973
tt.set_executability(target_executable, trans_id)
2974
if working_tree.supports_content_filtering():
2975
for index, ((trans_id, mode_id), bytes) in enumerate(
2976
target_tree.iter_files_bytes(deferred_files)):
2977
file_id = deferred_files[index][0]
2978
# We're reverting a tree to the target tree so using the
2979
# target tree to find the file path seems the best choice
2980
# here IMO - Ian C 27/Oct/2009
2981
filter_tree_path = target_tree.id2path(file_id)
2982
filters = working_tree._content_filter_stack(filter_tree_path)
2983
bytes = filtered_output_bytes(bytes, filters,
2984
ContentFilterContext(filter_tree_path, working_tree))
2985
tt.create_file(bytes, trans_id, mode_id)
2987
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2989
tt.create_file(bytes, trans_id, mode_id)
2990
tt.fixup_new_roots()
2992
if basis_tree is not None:
2994
return merge_modified
2997
def resolve_conflicts(tt, pb=None, pass_func=None):
2998
"""Make many conflict-resolution attempts, but die if they fail"""
2999
if pass_func is None:
3000
pass_func = conflict_pass
3001
new_conflicts = set()
3002
pb = ui.ui_factory.nested_progress_bar()
3005
pb.update(gettext('Resolution pass'), n+1, 10)
3006
conflicts = tt.find_conflicts()
3007
if len(conflicts) == 0:
3008
return new_conflicts
3009
new_conflicts.update(pass_func(tt, conflicts))
3010
raise MalformedTransform(conflicts=conflicts)
3015
def conflict_pass(tt, conflicts, path_tree=None):
3016
"""Resolve some classes of conflicts.
3018
:param tt: The transform to resolve conflicts in
3019
:param conflicts: The conflicts to resolve
3020
:param path_tree: A Tree to get supplemental paths from
3022
new_conflicts = set()
3023
for c_type, conflict in ((c[0], c) for c in conflicts):
3024
if c_type == 'duplicate id':
3025
tt.unversion_file(conflict[1])
3026
new_conflicts.add((c_type, 'Unversioned existing file',
3027
conflict[1], conflict[2], ))
3028
elif c_type == 'duplicate':
3029
# files that were renamed take precedence
3030
final_parent = tt.final_parent(conflict[1])
3031
if tt.path_changed(conflict[1]):
3032
existing_file, new_file = conflict[2], conflict[1]
3034
existing_file, new_file = conflict[1], conflict[2]
3035
new_name = tt.final_name(existing_file) + '.moved'
3036
tt.adjust_path(new_name, final_parent, existing_file)
3037
new_conflicts.add((c_type, 'Moved existing file to',
3038
existing_file, new_file))
3039
elif c_type == 'parent loop':
3040
# break the loop by undoing one of the ops that caused the loop
3042
while not tt.path_changed(cur):
3043
cur = tt.final_parent(cur)
3044
new_conflicts.add((c_type, 'Cancelled move', cur,
3045
tt.final_parent(cur),))
3046
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3048
elif c_type == 'missing parent':
3049
trans_id = conflict[1]
3050
if trans_id in tt._removed_contents:
3051
cancel_deletion = True
3052
orphans = tt._get_potential_orphans(trans_id)
3054
cancel_deletion = False
3055
# All children are orphans
3058
tt.new_orphan(o, trans_id)
3059
except OrphaningError:
3060
# Something bad happened so we cancel the directory
3061
# deletion which will leave it in place with a
3062
# conflict. The user can deal with it from there.
3063
# Note that this also catch the case where we don't
3064
# want to create orphans and leave the directory in
3066
cancel_deletion = True
3069
# Cancel the directory deletion
3070
tt.cancel_deletion(trans_id)
3071
new_conflicts.add(('deleting parent', 'Not deleting',
3076
tt.final_name(trans_id)
3078
if path_tree is not None:
3079
file_id = tt.final_file_id(trans_id)
3081
file_id = tt.inactive_file_id(trans_id)
3082
_, entry = next(path_tree.iter_entries_by_dir(
3084
# special-case the other tree root (move its
3085
# children to current root)
3086
if entry.parent_id is None:
3088
moved = _reparent_transform_children(
3089
tt, trans_id, tt.root)
3091
new_conflicts.add((c_type, 'Moved to root',
3094
parent_trans_id = tt.trans_id_file_id(
3096
tt.adjust_path(entry.name, parent_trans_id,
3099
tt.create_directory(trans_id)
3100
new_conflicts.add((c_type, 'Created directory', trans_id))
3101
elif c_type == 'unversioned parent':
3102
file_id = tt.inactive_file_id(conflict[1])
3103
# special-case the other tree root (move its children instead)
3104
if path_tree and path_tree.has_id(file_id):
3105
if path_tree.path2id('') == file_id:
3106
# This is the root entry, skip it
3108
tt.version_file(file_id, conflict[1])
3109
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3110
elif c_type == 'non-directory parent':
3111
parent_id = conflict[1]
3112
parent_parent = tt.final_parent(parent_id)
3113
parent_name = tt.final_name(parent_id)
3114
parent_file_id = tt.final_file_id(parent_id)
3115
new_parent_id = tt.new_directory(parent_name + '.new',
3116
parent_parent, parent_file_id)
3117
_reparent_transform_children(tt, parent_id, new_parent_id)
3118
if parent_file_id is not None:
3119
tt.unversion_file(parent_id)
3120
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3121
elif c_type == 'versioning no contents':
3122
tt.cancel_versioning(conflict[1])
3123
return new_conflicts
3126
def cook_conflicts(raw_conflicts, tt):
3127
"""Generate a list of cooked conflicts, sorted by file path"""
3128
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3129
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3132
def iter_cook_conflicts(raw_conflicts, tt):
3134
for conflict in raw_conflicts:
3135
c_type = conflict[0]
3136
action = conflict[1]
3137
modified_path = fp.get_path(conflict[2])
3138
modified_id = tt.final_file_id(conflict[2])
3139
if len(conflict) == 3:
3140
yield conflicts.Conflict.factory(
3141
c_type, action=action, path=modified_path, file_id=modified_id)
3144
conflicting_path = fp.get_path(conflict[3])
3145
conflicting_id = tt.final_file_id(conflict[3])
3146
yield conflicts.Conflict.factory(
3147
c_type, action=action, path=modified_path,
3148
file_id=modified_id,
3149
conflict_path=conflicting_path,
3150
conflict_file_id=conflicting_id)
3153
class _FileMover(object):
3154
"""Moves and deletes files for TreeTransform, tracking operations"""
3157
self.past_renames = []
3158
self.pending_deletions = []
3160
def rename(self, from_, to):
3161
"""Rename a file from one path to another."""
3163
os.rename(from_, to)
3164
except OSError as e:
3165
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3166
raise errors.FileExists(to, str(e))
3167
# normal OSError doesn't include filenames so it's hard to see where
3168
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3169
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3170
self.past_renames.append((from_, to))
3172
def pre_delete(self, from_, to):
3173
"""Rename a file out of the way and mark it for deletion.
3175
Unlike os.unlink, this works equally well for files and directories.
3176
:param from_: The current file path
3177
:param to: A temporary path for the file
3179
self.rename(from_, to)
3180
self.pending_deletions.append(to)
3183
"""Reverse all renames that have been performed"""
3184
for from_, to in reversed(self.past_renames):
3186
os.rename(to, from_)
3187
except OSError as e:
3188
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3189
# after rollback, don't reuse _FileMover
3191
pending_deletions = None
3193
def apply_deletions(self):
3194
"""Apply all marked deletions"""
3195
for path in self.pending_deletions:
3197
# after apply_deletions, don't reuse _FileMover
3199
pending_deletions = None
3202
def link_tree(target_tree, source_tree):
3203
"""Where possible, hard-link files in a tree to those in another tree.
3205
:param target_tree: Tree to change
3206
:param source_tree: Tree to hard-link from
3208
tt = TreeTransform(target_tree)
3210
for (file_id, paths, changed_content, versioned, parent, name, kind,
3211
executable) in target_tree.iter_changes(source_tree,
3212
include_unchanged=True):
3215
if kind != ('file', 'file'):
3217
if executable[0] != executable[1]:
3219
trans_id = tt.trans_id_tree_file_id(file_id)
3220
tt.delete_contents(trans_id)
3221
tt.create_hardlink(source_tree.id2abspath(file_id), trans_id)
added
removed
breezy/transform.py
