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
19
from stat import S_ISREG, S_IEXEC
29
lazy_import.lazy_import(globals(), """
40
revision as _mod_revision,
44
from bzrlib.i18n import gettext
46
from bzrlib.errors import (DuplicateKey, MalformedTransform,
47
ReusingTransform, CantMoveRoot,
48
ExistingLimbo, ImmortalLimbo, NoFinalPath,
50
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
51
from bzrlib.osutils import (
60
from bzrlib.progress import ProgressPhase
61
from bzrlib.symbol_versioning import (
68
ROOT_PARENT = "root-parent"
70
def unique_add(map, key, value):
72
raise DuplicateKey(key=key)
77
class _TransformResults(object):
78
def __init__(self, modified_paths, rename_count):
80
self.modified_paths = modified_paths
81
self.rename_count = rename_count
84
class TreeTransformBase(object):
85
"""The base class for TreeTransform and its kin."""
87
def __init__(self, tree, pb=None,
91
:param tree: The tree that will be transformed, but not necessarily
94
:param case_sensitive: If True, the target of the transform is
95
case sensitive, not just case preserving.
100
# mapping of trans_id -> new basename
102
# mapping of trans_id -> new parent trans_id
103
self._new_parent = {}
104
# mapping of trans_id with new contents -> new file_kind
105
self._new_contents = {}
106
# mapping of trans_id => (sha1 of content, stat_value)
107
self._observed_sha1s = {}
108
# Set of trans_ids whose contents will be removed
109
self._removed_contents = set()
110
# Mapping of trans_id -> new execute-bit value
111
self._new_executability = {}
112
# Mapping of trans_id -> new tree-reference value
113
self._new_reference_revision = {}
114
# Mapping of trans_id -> new file_id
116
# Mapping of old file-id -> trans_id
117
self._non_present_ids = {}
118
# Mapping of new file_id -> trans_id
120
# Set of trans_ids that will be removed
121
self._removed_id = set()
122
# Mapping of path in old tree -> trans_id
123
self._tree_path_ids = {}
124
# Mapping trans_id -> path in old tree
125
self._tree_id_paths = {}
126
# The trans_id that will be used as the tree root
127
root_id = tree.get_root_id()
128
if root_id is not None:
129
self._new_root = self.trans_id_tree_file_id(root_id)
131
self._new_root = None
132
# Indicator of whether the transform has been applied
136
# Whether the target is case sensitive
137
self._case_sensitive_target = case_sensitive
138
# A counter of how many files have been renamed
139
self.rename_count = 0
142
"""Support Context Manager API."""
145
def __exit__(self, exc_type, exc_val, exc_tb):
146
"""Support Context Manager API."""
150
"""Release the working tree lock, if held.
152
This is required if apply has not been invoked, but can be invoked
155
if self._tree is None:
160
def __get_root(self):
161
return self._new_root
163
root = property(__get_root)
165
def _assign_id(self):
166
"""Produce a new tranform id"""
167
new_id = "new-%s" % self._id_number
171
def create_path(self, name, parent):
172
"""Assign a transaction id to a new path"""
173
trans_id = self._assign_id()
174
unique_add(self._new_name, trans_id, name)
175
unique_add(self._new_parent, trans_id, parent)
178
def adjust_path(self, name, parent, trans_id):
179
"""Change the path that is assigned to a transaction id."""
181
raise ValueError("Parent trans-id may not be None")
182
if trans_id == self._new_root:
184
self._new_name[trans_id] = name
185
self._new_parent[trans_id] = parent
187
def adjust_root_path(self, name, parent):
188
"""Emulate moving the root by moving all children, instead.
190
We do this by undoing the association of root's transaction id with the
191
current tree. This allows us to create a new directory with that
192
transaction id. We unversion the root directory and version the
193
physically new directory, and hope someone versions the tree root
196
old_root = self._new_root
197
old_root_file_id = self.final_file_id(old_root)
198
# force moving all children of root
199
for child_id in self.iter_tree_children(old_root):
200
if child_id != parent:
201
self.adjust_path(self.final_name(child_id),
202
self.final_parent(child_id), child_id)
203
file_id = self.final_file_id(child_id)
204
if file_id is not None:
205
self.unversion_file(child_id)
206
self.version_file(file_id, child_id)
208
# the physical root needs a new transaction id
209
self._tree_path_ids.pop("")
210
self._tree_id_paths.pop(old_root)
211
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
212
if parent == old_root:
213
parent = self._new_root
214
self.adjust_path(name, parent, old_root)
215
self.create_directory(old_root)
216
self.version_file(old_root_file_id, old_root)
217
self.unversion_file(self._new_root)
219
def fixup_new_roots(self):
220
"""Reinterpret requests to change the root directory
222
Instead of creating a root directory, or moving an existing directory,
223
all the attributes and children of the new root are applied to the
224
existing root directory.
226
This means that the old root trans-id becomes obsolete, so it is
227
recommended only to invoke this after the root trans-id has become
231
new_roots = [k for k, v in self._new_parent.iteritems() if v is
233
if len(new_roots) < 1:
235
if len(new_roots) != 1:
236
raise ValueError('A tree cannot have two roots!')
237
if self._new_root is None:
238
self._new_root = new_roots[0]
240
old_new_root = new_roots[0]
241
# unversion the new root's directory.
242
if self.final_kind(self._new_root) is None:
243
file_id = self.final_file_id(old_new_root)
245
file_id = self.final_file_id(self._new_root)
246
if old_new_root in self._new_id:
247
self.cancel_versioning(old_new_root)
249
self.unversion_file(old_new_root)
250
# if, at this stage, root still has an old file_id, zap it so we can
251
# stick a new one in.
252
if (self.tree_file_id(self._new_root) is not None and
253
self._new_root not in self._removed_id):
254
self.unversion_file(self._new_root)
255
if file_id is not None:
256
self.version_file(file_id, self._new_root)
258
# Now move children of new root into old root directory.
259
# Ensure all children are registered with the transaction, but don't
260
# use directly-- some tree children have new parents
261
list(self.iter_tree_children(old_new_root))
262
# Move all children of new root into old root directory.
263
for child in self.by_parent().get(old_new_root, []):
264
self.adjust_path(self.final_name(child), self._new_root, child)
266
# Ensure old_new_root has no directory.
267
if old_new_root in self._new_contents:
268
self.cancel_creation(old_new_root)
270
self.delete_contents(old_new_root)
272
# prevent deletion of root directory.
273
if self._new_root in self._removed_contents:
274
self.cancel_deletion(self._new_root)
276
# destroy path info for old_new_root.
277
del self._new_parent[old_new_root]
278
del self._new_name[old_new_root]
280
def trans_id_tree_file_id(self, inventory_id):
281
"""Determine the transaction id of a working tree file.
283
This reflects only files that already exist, not ones that will be
284
added by transactions.
286
if inventory_id is None:
287
raise ValueError('None is not a valid file id')
288
path = self._tree.id2path(inventory_id)
289
return self.trans_id_tree_path(path)
291
def trans_id_file_id(self, file_id):
292
"""Determine or set the transaction id associated with a file ID.
293
A new id is only created for file_ids that were never present. If
294
a transaction has been unversioned, it is deliberately still returned.
295
(this will likely lead to an unversioned parent conflict.)
298
raise ValueError('None is not a valid file id')
299
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
300
return self._r_new_id[file_id]
303
self._tree.iter_entries_by_dir([file_id]).next()
304
except StopIteration:
305
if file_id in self._non_present_ids:
306
return self._non_present_ids[file_id]
308
trans_id = self._assign_id()
309
self._non_present_ids[file_id] = trans_id
312
return self.trans_id_tree_file_id(file_id)
314
def trans_id_tree_path(self, path):
315
"""Determine (and maybe set) the transaction ID for a tree path."""
316
path = self.canonical_path(path)
317
if path not in self._tree_path_ids:
318
self._tree_path_ids[path] = self._assign_id()
319
self._tree_id_paths[self._tree_path_ids[path]] = path
320
return self._tree_path_ids[path]
322
def get_tree_parent(self, trans_id):
323
"""Determine id of the parent in the tree."""
324
path = self._tree_id_paths[trans_id]
327
return self.trans_id_tree_path(os.path.dirname(path))
329
def delete_contents(self, trans_id):
330
"""Schedule the contents of a path entry for deletion"""
331
kind = self.tree_kind(trans_id)
333
self._removed_contents.add(trans_id)
335
def cancel_deletion(self, trans_id):
336
"""Cancel a scheduled deletion"""
337
self._removed_contents.remove(trans_id)
339
def unversion_file(self, trans_id):
340
"""Schedule a path entry to become unversioned"""
341
self._removed_id.add(trans_id)
343
def delete_versioned(self, trans_id):
344
"""Delete and unversion a versioned file"""
345
self.delete_contents(trans_id)
346
self.unversion_file(trans_id)
348
def set_executability(self, executability, trans_id):
349
"""Schedule setting of the 'execute' bit
350
To unschedule, set to None
352
if executability is None:
353
del self._new_executability[trans_id]
355
unique_add(self._new_executability, trans_id, executability)
357
def set_tree_reference(self, revision_id, trans_id):
358
"""Set the reference associated with a directory"""
359
unique_add(self._new_reference_revision, trans_id, revision_id)
361
def version_file(self, file_id, trans_id):
362
"""Schedule a file to become versioned."""
365
unique_add(self._new_id, trans_id, file_id)
366
unique_add(self._r_new_id, file_id, trans_id)
368
def cancel_versioning(self, trans_id):
369
"""Undo a previous versioning of a file"""
370
file_id = self._new_id[trans_id]
371
del self._new_id[trans_id]
372
del self._r_new_id[file_id]
374
def new_paths(self, filesystem_only=False):
375
"""Determine the paths of all new and changed files.
377
:param filesystem_only: if True, only calculate values for files
378
that require renames or execute bit changes.
382
stale_ids = self._needs_rename.difference(self._new_name)
383
stale_ids.difference_update(self._new_parent)
384
stale_ids.difference_update(self._new_contents)
385
stale_ids.difference_update(self._new_id)
386
needs_rename = self._needs_rename.difference(stale_ids)
387
id_sets = (needs_rename, self._new_executability)
389
id_sets = (self._new_name, self._new_parent, self._new_contents,
390
self._new_id, self._new_executability)
391
for id_set in id_sets:
392
new_ids.update(id_set)
393
return sorted(FinalPaths(self).get_paths(new_ids))
395
def _inventory_altered(self):
396
"""Determine which trans_ids need new Inventory entries.
398
An new entry is needed when anything that would be reflected by an
399
inventory entry changes, including file name, file_id, parent file_id,
400
file kind, and the execute bit.
402
Some care is taken to return entries with real changes, not cases
403
where the value is deleted and then restored to its original value,
404
but some actually unchanged values may be returned.
406
:returns: A list of (path, trans_id) for all items requiring an
407
inventory change. Ordered by path.
410
# Find entries whose file_ids are new (or changed).
411
new_file_id = set(t for t in self._new_id
412
if self._new_id[t] != self.tree_file_id(t))
413
for id_set in [self._new_name, self._new_parent, new_file_id,
414
self._new_executability]:
415
changed_ids.update(id_set)
416
# removing implies a kind change
417
changed_kind = set(self._removed_contents)
419
changed_kind.intersection_update(self._new_contents)
420
# Ignore entries that are already known to have changed.
421
changed_kind.difference_update(changed_ids)
422
# to keep only the truly changed ones
423
changed_kind = (t for t in changed_kind
424
if self.tree_kind(t) != self.final_kind(t))
425
# all kind changes will alter the inventory
426
changed_ids.update(changed_kind)
427
# To find entries with changed parent_ids, find parents which existed,
428
# but changed file_id.
429
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
430
# Now add all their children to the set.
431
for parent_trans_id in new_file_id:
432
changed_ids.update(self.iter_tree_children(parent_trans_id))
433
return sorted(FinalPaths(self).get_paths(changed_ids))
435
def final_kind(self, trans_id):
436
"""Determine the final file kind, after any changes applied.
438
:return: None if the file does not exist/has no contents. (It is
439
conceivable that a path would be created without the corresponding
440
contents insertion command)
442
if trans_id in self._new_contents:
443
return self._new_contents[trans_id]
444
elif trans_id in self._removed_contents:
447
return self.tree_kind(trans_id)
449
def tree_file_id(self, trans_id):
450
"""Determine the file id associated with the trans_id in the tree"""
452
path = self._tree_id_paths[trans_id]
454
# the file is a new, unversioned file, or invalid trans_id
456
# the file is old; the old id is still valid
457
if self._new_root == trans_id:
458
return self._tree.get_root_id()
459
return self._tree.path2id(path)
461
def final_file_id(self, trans_id):
462
"""Determine the file id after any changes are applied, or None.
464
None indicates that the file will not be versioned after changes are
468
return self._new_id[trans_id]
470
if trans_id in self._removed_id:
472
return self.tree_file_id(trans_id)
474
def inactive_file_id(self, trans_id):
475
"""Return the inactive file_id associated with a transaction id.
476
That is, the one in the tree or in non_present_ids.
477
The file_id may actually be active, too.
479
file_id = self.tree_file_id(trans_id)
480
if file_id is not None:
482
for key, value in self._non_present_ids.iteritems():
483
if value == trans_id:
486
def final_parent(self, trans_id):
487
"""Determine the parent file_id, after any changes are applied.
489
ROOT_PARENT is returned for the tree root.
492
return self._new_parent[trans_id]
494
return self.get_tree_parent(trans_id)
496
def final_name(self, trans_id):
497
"""Determine the final filename, after all changes are applied."""
499
return self._new_name[trans_id]
502
return os.path.basename(self._tree_id_paths[trans_id])
504
raise NoFinalPath(trans_id, self)
507
"""Return a map of parent: children for known parents.
509
Only new paths and parents of tree files with assigned ids are used.
512
items = list(self._new_parent.iteritems())
513
items.extend((t, self.final_parent(t)) for t in
514
self._tree_id_paths.keys())
515
for trans_id, parent_id in items:
516
if parent_id not in by_parent:
517
by_parent[parent_id] = set()
518
by_parent[parent_id].add(trans_id)
521
def path_changed(self, trans_id):
522
"""Return True if a trans_id's path has changed."""
523
return (trans_id in self._new_name) or (trans_id in self._new_parent)
525
def new_contents(self, trans_id):
526
return (trans_id in self._new_contents)
528
def find_conflicts(self):
529
"""Find any violations of inventory or filesystem invariants"""
530
if self._done is True:
531
raise ReusingTransform()
533
# ensure all children of all existent parents are known
534
# all children of non-existent parents are known, by definition.
535
self._add_tree_children()
536
by_parent = self.by_parent()
537
conflicts.extend(self._unversioned_parents(by_parent))
538
conflicts.extend(self._parent_loops())
539
conflicts.extend(self._duplicate_entries(by_parent))
540
conflicts.extend(self._duplicate_ids())
541
conflicts.extend(self._parent_type_conflicts(by_parent))
542
conflicts.extend(self._improper_versioning())
543
conflicts.extend(self._executability_conflicts())
544
conflicts.extend(self._overwrite_conflicts())
547
def _check_malformed(self):
548
conflicts = self.find_conflicts()
549
if len(conflicts) != 0:
550
raise MalformedTransform(conflicts=conflicts)
552
def _add_tree_children(self):
553
"""Add all the children of all active parents to the known paths.
555
Active parents are those which gain children, and those which are
556
removed. This is a necessary first step in detecting conflicts.
558
parents = self.by_parent().keys()
559
parents.extend([t for t in self._removed_contents if
560
self.tree_kind(t) == 'directory'])
561
for trans_id in self._removed_id:
562
file_id = self.tree_file_id(trans_id)
563
if file_id is not None:
564
if self._tree.stored_kind(file_id) == 'directory':
565
parents.append(trans_id)
566
elif self.tree_kind(trans_id) == 'directory':
567
parents.append(trans_id)
569
for parent_id in parents:
570
# ensure that all children are registered with the transaction
571
list(self.iter_tree_children(parent_id))
573
@deprecated_method(deprecated_in((2, 3, 0)))
574
def has_named_child(self, by_parent, parent_id, name):
575
return self._has_named_child(
576
name, parent_id, known_children=by_parent.get(parent_id, []))
578
def _has_named_child(self, name, parent_id, known_children):
579
"""Does a parent already have a name child.
581
:param name: The searched for name.
583
:param parent_id: The parent for which the check is made.
585
:param known_children: The already known children. This should have
586
been recently obtained from `self.by_parent.get(parent_id)`
587
(or will be if None is passed).
589
if known_children is None:
590
known_children = self.by_parent().get(parent_id, [])
591
for child in known_children:
592
if self.final_name(child) == name:
594
parent_path = self._tree_id_paths.get(parent_id, None)
595
if parent_path is None:
596
# No parent... no children
598
child_path = joinpath(parent_path, name)
599
child_id = self._tree_path_ids.get(child_path, None)
601
# Not known by the tree transform yet, check the filesystem
602
return osutils.lexists(self._tree.abspath(child_path))
604
raise AssertionError('child_id is missing: %s, %s, %s'
605
% (name, parent_id, child_id))
607
def _available_backup_name(self, name, target_id):
608
"""Find an available backup name.
610
:param name: The basename of the file.
612
:param target_id: The directory trans_id where the backup should
615
known_children = self.by_parent().get(target_id, [])
616
return osutils.available_backup_name(
618
lambda base: self._has_named_child(
619
base, target_id, known_children))
621
def _parent_loops(self):
622
"""No entry should be its own ancestor"""
624
for trans_id in self._new_parent:
627
while parent_id is not ROOT_PARENT:
630
parent_id = self.final_parent(parent_id)
633
if parent_id == trans_id:
634
conflicts.append(('parent loop', trans_id))
635
if parent_id in seen:
639
def _unversioned_parents(self, by_parent):
640
"""If parent directories are versioned, children must be versioned."""
642
for parent_id, children in by_parent.iteritems():
643
if parent_id is ROOT_PARENT:
645
if self.final_file_id(parent_id) is not None:
647
for child_id in children:
648
if self.final_file_id(child_id) is not None:
649
conflicts.append(('unversioned parent', parent_id))
653
def _improper_versioning(self):
654
"""Cannot version a file with no contents, or a bad type.
656
However, existing entries with no contents are okay.
659
for trans_id in self._new_id.iterkeys():
660
kind = self.final_kind(trans_id)
662
conflicts.append(('versioning no contents', trans_id))
664
if not inventory.InventoryEntry.versionable_kind(kind):
665
conflicts.append(('versioning bad kind', trans_id, kind))
668
def _executability_conflicts(self):
669
"""Check for bad executability changes.
671
Only versioned files may have their executability set, because
672
1. only versioned entries can have executability under windows
673
2. only files can be executable. (The execute bit on a directory
674
does not indicate searchability)
677
for trans_id in self._new_executability:
678
if self.final_file_id(trans_id) is None:
679
conflicts.append(('unversioned executability', trans_id))
681
if self.final_kind(trans_id) != "file":
682
conflicts.append(('non-file executability', trans_id))
685
def _overwrite_conflicts(self):
686
"""Check for overwrites (not permitted on Win32)"""
688
for trans_id in self._new_contents:
689
if self.tree_kind(trans_id) is None:
691
if trans_id not in self._removed_contents:
692
conflicts.append(('overwrite', trans_id,
693
self.final_name(trans_id)))
696
def _duplicate_entries(self, by_parent):
697
"""No directory may have two entries with the same name."""
699
if (self._new_name, self._new_parent) == ({}, {}):
701
for children in by_parent.itervalues():
703
for child_tid in children:
704
name = self.final_name(child_tid)
706
# Keep children only if they still exist in the end
707
if not self._case_sensitive_target:
709
name_ids.append((name, child_tid))
713
for name, trans_id in name_ids:
714
kind = self.final_kind(trans_id)
715
file_id = self.final_file_id(trans_id)
716
if kind is None and file_id is None:
718
if name == last_name:
719
conflicts.append(('duplicate', last_trans_id, trans_id,
722
last_trans_id = trans_id
725
def _duplicate_ids(self):
726
"""Each inventory id may only be used once"""
728
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
730
all_ids = self._tree.all_file_ids()
731
active_tree_ids = all_ids.difference(removed_tree_ids)
732
for trans_id, file_id in self._new_id.iteritems():
733
if file_id in active_tree_ids:
734
old_trans_id = self.trans_id_tree_file_id(file_id)
735
conflicts.append(('duplicate id', old_trans_id, trans_id))
738
def _parent_type_conflicts(self, by_parent):
739
"""Children must have a directory parent"""
741
for parent_id, children in by_parent.iteritems():
742
if parent_id is ROOT_PARENT:
745
for child_id in children:
746
if self.final_kind(child_id) is not None:
751
# There is at least a child, so we need an existing directory to
753
kind = self.final_kind(parent_id)
755
# The directory will be deleted
756
conflicts.append(('missing parent', parent_id))
757
elif kind != "directory":
758
# Meh, we need a *directory* to put something in it
759
conflicts.append(('non-directory parent', parent_id))
762
def _set_executability(self, path, trans_id):
763
"""Set the executability of versioned files """
764
if supports_executable():
765
new_executability = self._new_executability[trans_id]
766
abspath = self._tree.abspath(path)
767
current_mode = os.stat(abspath).st_mode
768
if new_executability:
771
to_mode = current_mode | (0100 & ~umask)
772
# Enable x-bit for others only if they can read it.
773
if current_mode & 0004:
774
to_mode |= 0001 & ~umask
775
if current_mode & 0040:
776
to_mode |= 0010 & ~umask
778
to_mode = current_mode & ~0111
779
os.chmod(abspath, to_mode)
781
def _new_entry(self, name, parent_id, file_id):
782
"""Helper function to create a new filesystem entry."""
783
trans_id = self.create_path(name, parent_id)
784
if file_id is not None:
785
self.version_file(file_id, trans_id)
788
def new_file(self, name, parent_id, contents, file_id=None,
789
executable=None, sha1=None):
790
"""Convenience method to create files.
792
name is the name of the file to create.
793
parent_id is the transaction id of the parent directory of the file.
794
contents is an iterator of bytestrings, which will be used to produce
796
:param file_id: The inventory ID of the file, if it is to be versioned.
797
:param executable: Only valid when a file_id has been supplied.
799
trans_id = self._new_entry(name, parent_id, file_id)
800
# TODO: rather than scheduling a set_executable call,
801
# have create_file create the file with the right mode.
802
self.create_file(contents, trans_id, sha1=sha1)
803
if executable is not None:
804
self.set_executability(executable, trans_id)
807
def new_directory(self, name, parent_id, file_id=None):
808
"""Convenience method to create directories.
810
name is the name of the directory to create.
811
parent_id is the transaction id of the parent directory of the
813
file_id is the inventory ID of the directory, if it is to be versioned.
815
trans_id = self._new_entry(name, parent_id, file_id)
816
self.create_directory(trans_id)
819
def new_symlink(self, name, parent_id, target, file_id=None):
820
"""Convenience method to create symbolic link.
822
name is the name of the symlink to create.
823
parent_id is the transaction id of the parent directory of the symlink.
824
target is a bytestring of the target of the symlink.
825
file_id is the inventory ID of the file, if it is to be versioned.
827
trans_id = self._new_entry(name, parent_id, file_id)
828
self.create_symlink(target, trans_id)
831
def new_orphan(self, trans_id, parent_id):
832
"""Schedule an item to be orphaned.
834
When a directory is about to be removed, its children, if they are not
835
versioned are moved out of the way: they don't have a parent anymore.
837
:param trans_id: The trans_id of the existing item.
838
:param parent_id: The parent trans_id of the item.
840
raise NotImplementedError(self.new_orphan)
842
def _get_potential_orphans(self, dir_id):
843
"""Find the potential orphans in a directory.
845
A directory can't be safely deleted if there are versioned files in it.
846
If all the contained files are unversioned then they can be orphaned.
848
The 'None' return value means that the directory contains at least one
849
versioned file and should not be deleted.
851
:param dir_id: The directory trans id.
853
:return: A list of the orphan trans ids or None if at least one
854
versioned file is present.
857
# Find the potential orphans, stop if one item should be kept
858
for child_tid in self.by_parent()[dir_id]:
859
if child_tid in self._removed_contents:
860
# The child is removed as part of the transform. Since it was
861
# versioned before, it's not an orphan
863
elif self.final_file_id(child_tid) is None:
864
# The child is not versioned
865
orphans.append(child_tid)
867
# We have a versioned file here, searching for orphans is
873
def _affected_ids(self):
874
"""Return the set of transform ids affected by the transform"""
875
trans_ids = set(self._removed_id)
876
trans_ids.update(self._new_id.keys())
877
trans_ids.update(self._removed_contents)
878
trans_ids.update(self._new_contents.keys())
879
trans_ids.update(self._new_executability.keys())
880
trans_ids.update(self._new_name.keys())
881
trans_ids.update(self._new_parent.keys())
884
def _get_file_id_maps(self):
885
"""Return mapping of file_ids to trans_ids in the to and from states"""
886
trans_ids = self._affected_ids()
889
# Build up two dicts: trans_ids associated with file ids in the
890
# FROM state, vs the TO state.
891
for trans_id in trans_ids:
892
from_file_id = self.tree_file_id(trans_id)
893
if from_file_id is not None:
894
from_trans_ids[from_file_id] = trans_id
895
to_file_id = self.final_file_id(trans_id)
896
if to_file_id is not None:
897
to_trans_ids[to_file_id] = trans_id
898
return from_trans_ids, to_trans_ids
900
def _from_file_data(self, from_trans_id, from_versioned, file_id):
901
"""Get data about a file in the from (tree) state
903
Return a (name, parent, kind, executable) tuple
905
from_path = self._tree_id_paths.get(from_trans_id)
907
# get data from working tree if versioned
908
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
909
from_name = from_entry.name
910
from_parent = from_entry.parent_id
913
if from_path is None:
914
# File does not exist in FROM state
918
# File exists, but is not versioned. Have to use path-
920
from_name = os.path.basename(from_path)
921
tree_parent = self.get_tree_parent(from_trans_id)
922
from_parent = self.tree_file_id(tree_parent)
923
if from_path is not None:
924
from_kind, from_executable, from_stats = \
925
self._tree._comparison_data(from_entry, from_path)
928
from_executable = False
929
return from_name, from_parent, from_kind, from_executable
931
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
932
"""Get data about a file in the to (target) state
934
Return a (name, parent, kind, executable) tuple
936
to_name = self.final_name(to_trans_id)
937
to_kind = self.final_kind(to_trans_id)
938
to_parent = self.final_file_id(self.final_parent(to_trans_id))
939
if to_trans_id in self._new_executability:
940
to_executable = self._new_executability[to_trans_id]
941
elif to_trans_id == from_trans_id:
942
to_executable = from_executable
944
to_executable = False
945
return to_name, to_parent, to_kind, to_executable
947
def iter_changes(self):
948
"""Produce output in the same format as Tree.iter_changes.
950
Will produce nonsensical results if invoked while inventory/filesystem
951
conflicts (as reported by TreeTransform.find_conflicts()) are present.
953
This reads the Transform, but only reproduces changes involving a
954
file_id. Files that are not versioned in either of the FROM or TO
955
states are not reflected.
957
final_paths = FinalPaths(self)
958
from_trans_ids, to_trans_ids = self._get_file_id_maps()
960
# Now iterate through all active file_ids
961
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
963
from_trans_id = from_trans_ids.get(file_id)
964
# find file ids, and determine versioning state
965
if from_trans_id is None:
966
from_versioned = False
967
from_trans_id = to_trans_ids[file_id]
969
from_versioned = True
970
to_trans_id = to_trans_ids.get(file_id)
971
if to_trans_id is None:
973
to_trans_id = from_trans_id
977
from_name, from_parent, from_kind, from_executable = \
978
self._from_file_data(from_trans_id, from_versioned, file_id)
980
to_name, to_parent, to_kind, to_executable = \
981
self._to_file_data(to_trans_id, from_trans_id, from_executable)
983
if not from_versioned:
986
from_path = self._tree_id_paths.get(from_trans_id)
990
to_path = final_paths.get_path(to_trans_id)
991
if from_kind != to_kind:
993
elif to_kind in ('file', 'symlink') and (
994
to_trans_id != from_trans_id or
995
to_trans_id in self._new_contents):
997
if (not modified and from_versioned == to_versioned and
998
from_parent==to_parent and from_name == to_name and
999
from_executable == to_executable):
1001
results.append((file_id, (from_path, to_path), modified,
1002
(from_versioned, to_versioned),
1003
(from_parent, to_parent),
1004
(from_name, to_name),
1005
(from_kind, to_kind),
1006
(from_executable, to_executable)))
1007
return iter(sorted(results, key=lambda x:x[1]))
1009
def get_preview_tree(self):
1010
"""Return a tree representing the result of the transform.
1012
The tree is a snapshot, and altering the TreeTransform will invalidate
1015
return _PreviewTree(self)
1017
def commit(self, branch, message, merge_parents=None, strict=False,
1018
timestamp=None, timezone=None, committer=None, authors=None,
1019
revprops=None, revision_id=None):
1020
"""Commit the result of this TreeTransform to a branch.
1022
:param branch: The branch to commit to.
1023
:param message: The message to attach to the commit.
1024
:param merge_parents: Additional parent revision-ids specified by
1026
:param strict: If True, abort the commit if there are unversioned
1028
:param timestamp: if not None, seconds-since-epoch for the time and
1029
date. (May be a float.)
1030
:param timezone: Optional timezone for timestamp, as an offset in
1032
:param committer: Optional committer in email-id format.
1033
(e.g. "J Random Hacker <jrandom@example.com>")
1034
:param authors: Optional list of authors in email-id format.
1035
:param revprops: Optional dictionary of revision properties.
1036
:param revision_id: Optional revision id. (Specifying a revision-id
1037
may reduce performance for some non-native formats.)
1038
:return: The revision_id of the revision committed.
1040
self._check_malformed()
1042
unversioned = set(self._new_contents).difference(set(self._new_id))
1043
for trans_id in unversioned:
1044
if self.final_file_id(trans_id) is None:
1045
raise errors.StrictCommitFailed()
1047
revno, last_rev_id = branch.last_revision_info()
1048
if last_rev_id == _mod_revision.NULL_REVISION:
1049
if merge_parents is not None:
1050
raise ValueError('Cannot supply merge parents for first'
1054
parent_ids = [last_rev_id]
1055
if merge_parents is not None:
1056
parent_ids.extend(merge_parents)
1057
if self._tree.get_revision_id() != last_rev_id:
1058
raise ValueError('TreeTransform not based on branch basis: %s' %
1059
self._tree.get_revision_id())
1060
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1061
builder = branch.get_commit_builder(parent_ids,
1062
timestamp=timestamp,
1064
committer=committer,
1066
revision_id=revision_id)
1067
preview = self.get_preview_tree()
1068
list(builder.record_iter_changes(preview, last_rev_id,
1069
self.iter_changes()))
1070
builder.finish_inventory()
1071
revision_id = builder.commit(message)
1072
branch.set_last_revision_info(revno + 1, revision_id)
1075
def _text_parent(self, trans_id):
1076
file_id = self.tree_file_id(trans_id)
1078
if file_id is None or self._tree.kind(file_id) != 'file':
1080
except errors.NoSuchFile:
1084
def _get_parents_texts(self, trans_id):
1085
"""Get texts for compression parents of this file."""
1086
file_id = self._text_parent(trans_id)
1089
return (self._tree.get_file_text(file_id),)
1091
def _get_parents_lines(self, trans_id):
1092
"""Get lines for compression parents of this file."""
1093
file_id = self._text_parent(trans_id)
1096
return (self._tree.get_file_lines(file_id),)
1098
def serialize(self, serializer):
1099
"""Serialize this TreeTransform.
1101
:param serializer: A Serialiser like pack.ContainerSerializer.
1103
new_name = dict((k, v.encode('utf-8')) for k, v in
1104
self._new_name.items())
1105
new_executability = dict((k, int(v)) for k, v in
1106
self._new_executability.items())
1107
tree_path_ids = dict((k.encode('utf-8'), v)
1108
for k, v in self._tree_path_ids.items())
1110
'_id_number': self._id_number,
1111
'_new_name': new_name,
1112
'_new_parent': self._new_parent,
1113
'_new_executability': new_executability,
1114
'_new_id': self._new_id,
1115
'_tree_path_ids': tree_path_ids,
1116
'_removed_id': list(self._removed_id),
1117
'_removed_contents': list(self._removed_contents),
1118
'_non_present_ids': self._non_present_ids,
1120
yield serializer.bytes_record(bencode.bencode(attribs),
1122
for trans_id, kind in self._new_contents.items():
1124
lines = osutils.chunks_to_lines(
1125
self._read_file_chunks(trans_id))
1126
parents = self._get_parents_lines(trans_id)
1127
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1128
content = ''.join(mpdiff.to_patch())
1129
if kind == 'directory':
1131
if kind == 'symlink':
1132
content = self._read_symlink_target(trans_id)
1133
yield serializer.bytes_record(content, ((trans_id, kind),))
1135
def deserialize(self, records):
1136
"""Deserialize a stored TreeTransform.
1138
:param records: An iterable of (names, content) tuples, as per
1139
pack.ContainerPushParser.
1141
names, content = records.next()
1142
attribs = bencode.bdecode(content)
1143
self._id_number = attribs['_id_number']
1144
self._new_name = dict((k, v.decode('utf-8'))
1145
for k, v in attribs['_new_name'].items())
1146
self._new_parent = attribs['_new_parent']
1147
self._new_executability = dict((k, bool(v)) for k, v in
1148
attribs['_new_executability'].items())
1149
self._new_id = attribs['_new_id']
1150
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1151
self._tree_path_ids = {}
1152
self._tree_id_paths = {}
1153
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1154
path = bytepath.decode('utf-8')
1155
self._tree_path_ids[path] = trans_id
1156
self._tree_id_paths[trans_id] = path
1157
self._removed_id = set(attribs['_removed_id'])
1158
self._removed_contents = set(attribs['_removed_contents'])
1159
self._non_present_ids = attribs['_non_present_ids']
1160
for ((trans_id, kind),), content in records:
1162
mpdiff = multiparent.MultiParent.from_patch(content)
1163
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1164
self.create_file(lines, trans_id)
1165
if kind == 'directory':
1166
self.create_directory(trans_id)
1167
if kind == 'symlink':
1168
self.create_symlink(content.decode('utf-8'), trans_id)
1171
class DiskTreeTransform(TreeTransformBase):
1172
"""Tree transform storing its contents on disk."""
1174
def __init__(self, tree, limbodir, pb=None,
1175
case_sensitive=True):
1177
:param tree: The tree that will be transformed, but not necessarily
1179
:param limbodir: A directory where new files can be stored until
1180
they are installed in their proper places
1182
:param case_sensitive: If True, the target of the transform is
1183
case sensitive, not just case preserving.
1185
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1186
self._limbodir = limbodir
1187
self._deletiondir = None
1188
# A mapping of transform ids to their limbo filename
1189
self._limbo_files = {}
1190
self._possibly_stale_limbo_files = set()
1191
# A mapping of transform ids to a set of the transform ids of children
1192
# that their limbo directory has
1193
self._limbo_children = {}
1194
# Map transform ids to maps of child filename to child transform id
1195
self._limbo_children_names = {}
1196
# List of transform ids that need to be renamed from limbo into place
1197
self._needs_rename = set()
1198
self._creation_mtime = None
1201
"""Release the working tree lock, if held, clean up limbo dir.
1203
This is required if apply has not been invoked, but can be invoked
1206
if self._tree is None:
1209
limbo_paths = self._limbo_files.values() + list(
1210
self._possibly_stale_limbo_files)
1211
limbo_paths = sorted(limbo_paths, reverse=True)
1212
for path in limbo_paths:
1216
if e.errno != errno.ENOENT:
1218
# XXX: warn? perhaps we just got interrupted at an
1219
# inconvenient moment, but perhaps files are disappearing
1222
delete_any(self._limbodir)
1224
# We don't especially care *why* the dir is immortal.
1225
raise ImmortalLimbo(self._limbodir)
1227
if self._deletiondir is not None:
1228
delete_any(self._deletiondir)
1230
raise errors.ImmortalPendingDeletion(self._deletiondir)
1232
TreeTransformBase.finalize(self)
1234
def _limbo_name(self, trans_id):
1235
"""Generate the limbo name of a file"""
1236
limbo_name = self._limbo_files.get(trans_id)
1237
if limbo_name is None:
1238
limbo_name = self._generate_limbo_path(trans_id)
1239
self._limbo_files[trans_id] = limbo_name
1242
def _generate_limbo_path(self, trans_id):
1243
"""Generate a limbo path using the trans_id as the relative path.
1245
This is suitable as a fallback, and when the transform should not be
1246
sensitive to the path encoding of the limbo directory.
1248
self._needs_rename.add(trans_id)
1249
return pathjoin(self._limbodir, trans_id)
1251
def adjust_path(self, name, parent, trans_id):
1252
previous_parent = self._new_parent.get(trans_id)
1253
previous_name = self._new_name.get(trans_id)
1254
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1255
if (trans_id in self._limbo_files and
1256
trans_id not in self._needs_rename):
1257
self._rename_in_limbo([trans_id])
1258
if previous_parent != parent:
1259
self._limbo_children[previous_parent].remove(trans_id)
1260
if previous_parent != parent or previous_name != name:
1261
del self._limbo_children_names[previous_parent][previous_name]
1263
def _rename_in_limbo(self, trans_ids):
1264
"""Fix limbo names so that the right final path is produced.
1266
This means we outsmarted ourselves-- we tried to avoid renaming
1267
these files later by creating them with their final names in their
1268
final parents. But now the previous name or parent is no longer
1269
suitable, so we have to rename them.
1271
Even for trans_ids that have no new contents, we must remove their
1272
entries from _limbo_files, because they are now stale.
1274
for trans_id in trans_ids:
1275
old_path = self._limbo_files[trans_id]
1276
self._possibly_stale_limbo_files.add(old_path)
1277
del self._limbo_files[trans_id]
1278
if trans_id not in self._new_contents:
1280
new_path = self._limbo_name(trans_id)
1281
os.rename(old_path, new_path)
1282
self._possibly_stale_limbo_files.remove(old_path)
1283
for descendant in self._limbo_descendants(trans_id):
1284
desc_path = self._limbo_files[descendant]
1285
desc_path = new_path + desc_path[len(old_path):]
1286
self._limbo_files[descendant] = desc_path
1288
def _limbo_descendants(self, trans_id):
1289
"""Return the set of trans_ids whose limbo paths descend from this."""
1290
descendants = set(self._limbo_children.get(trans_id, []))
1291
for descendant in list(descendants):
1292
descendants.update(self._limbo_descendants(descendant))
1295
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1296
"""Schedule creation of a new file.
1300
:param contents: an iterator of strings, all of which will be written
1301
to the target destination.
1302
:param trans_id: TreeTransform handle
1303
:param mode_id: If not None, force the mode of the target file to match
1304
the mode of the object referenced by mode_id.
1305
Otherwise, we will try to preserve mode bits of an existing file.
1306
:param sha1: If the sha1 of this content is already known, pass it in.
1307
We can use it to prevent future sha1 computations.
1309
name = self._limbo_name(trans_id)
1310
f = open(name, 'wb')
1312
unique_add(self._new_contents, trans_id, 'file')
1313
f.writelines(contents)
1316
self._set_mtime(name)
1317
self._set_mode(trans_id, mode_id, S_ISREG)
1318
# It is unfortunate we have to use lstat instead of fstat, but we just
1319
# used utime and chmod on the file, so we need the accurate final
1321
if sha1 is not None:
1322
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1324
def _read_file_chunks(self, trans_id):
1325
cur_file = open(self._limbo_name(trans_id), 'rb')
1327
return cur_file.readlines()
1331
def _read_symlink_target(self, trans_id):
1332
return os.readlink(self._limbo_name(trans_id))
1334
def _set_mtime(self, path):
1335
"""All files that are created get the same mtime.
1337
This time is set by the first object to be created.
1339
if self._creation_mtime is None:
1340
self._creation_mtime = time.time()
1341
os.utime(path, (self._creation_mtime, self._creation_mtime))
1343
def create_hardlink(self, path, trans_id):
1344
"""Schedule creation of a hard link"""
1345
name = self._limbo_name(trans_id)
1349
if e.errno != errno.EPERM:
1351
raise errors.HardLinkNotSupported(path)
1353
unique_add(self._new_contents, trans_id, 'file')
1355
# Clean up the file, it never got registered so
1356
# TreeTransform.finalize() won't clean it up.
1360
def create_directory(self, trans_id):
1361
"""Schedule creation of a new directory.
1363
See also new_directory.
1365
os.mkdir(self._limbo_name(trans_id))
1366
unique_add(self._new_contents, trans_id, 'directory')
1368
def create_symlink(self, target, trans_id):
1369
"""Schedule creation of a new symbolic link.
1371
target is a bytestring.
1372
See also new_symlink.
1375
os.symlink(target, self._limbo_name(trans_id))
1376
unique_add(self._new_contents, trans_id, 'symlink')
1379
path = FinalPaths(self).get_path(trans_id)
1382
raise UnableCreateSymlink(path=path)
1384
def cancel_creation(self, trans_id):
1385
"""Cancel the creation of new file contents."""
1386
del self._new_contents[trans_id]
1387
if trans_id in self._observed_sha1s:
1388
del self._observed_sha1s[trans_id]
1389
children = self._limbo_children.get(trans_id)
1390
# if this is a limbo directory with children, move them before removing
1392
if children is not None:
1393
self._rename_in_limbo(children)
1394
del self._limbo_children[trans_id]
1395
del self._limbo_children_names[trans_id]
1396
delete_any(self._limbo_name(trans_id))
1398
def new_orphan(self, trans_id, parent_id):
1399
# FIXME: There is no tree config, so we use the branch one (it's weird
1400
# to define it this way as orphaning can only occur in a working tree,
1401
# but that's all we have (for now). It will find the option in
1402
# locations.conf or bazaar.conf though) -- vila 20100916
1403
conf = self._tree.branch.get_config()
1404
conf_var_name = 'bzr.transform.orphan_policy'
1405
orphan_policy = conf.get_user_option(conf_var_name)
1406
default_policy = orphaning_registry.default_key
1407
if orphan_policy is None:
1408
orphan_policy = default_policy
1409
if orphan_policy not in orphaning_registry:
1410
trace.warning('%s (from %s) is not a known policy, defaulting '
1411
'to %s' % (orphan_policy, conf_var_name, default_policy))
1412
orphan_policy = default_policy
1413
handle_orphan = orphaning_registry.get(orphan_policy)
1414
handle_orphan(self, trans_id, parent_id)
1417
class OrphaningError(errors.BzrError):
1419
# Only bugs could lead to such exception being seen by the user
1420
internal_error = True
1421
_fmt = "Error while orphaning %s in %s directory"
1423
def __init__(self, orphan, parent):
1424
errors.BzrError.__init__(self)
1425
self.orphan = orphan
1426
self.parent = parent
1429
class OrphaningForbidden(OrphaningError):
1431
_fmt = "Policy: %s doesn't allow creating orphans."
1433
def __init__(self, policy):
1434
errors.BzrError.__init__(self)
1435
self.policy = policy
1438
def move_orphan(tt, orphan_id, parent_id):
1439
"""See TreeTransformBase.new_orphan.
1441
This creates a new orphan in the `bzr-orphans` dir at the root of the
1444
:param tt: The TreeTransform orphaning `trans_id`.
1446
:param orphan_id: The trans id that should be orphaned.
1448
:param parent_id: The orphan parent trans id.
1450
# Add the orphan dir if it doesn't exist
1451
orphan_dir_basename = 'bzr-orphans'
1452
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1453
if tt.final_kind(od_id) is None:
1454
tt.create_directory(od_id)
1455
parent_path = tt._tree_id_paths[parent_id]
1456
# Find a name that doesn't exist yet in the orphan dir
1457
actual_name = tt.final_name(orphan_id)
1458
new_name = tt._available_backup_name(actual_name, od_id)
1459
tt.adjust_path(new_name, od_id, orphan_id)
1460
trace.warning('%s has been orphaned in %s'
1461
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1464
def refuse_orphan(tt, orphan_id, parent_id):
1465
"""See TreeTransformBase.new_orphan.
1467
This refuses to create orphan, letting the caller handle the conflict.
1469
raise OrphaningForbidden('never')
1472
orphaning_registry = registry.Registry()
1473
orphaning_registry.register(
1474
'conflict', refuse_orphan,
1475
'Leave orphans in place and create a conflict on the directory.')
1476
orphaning_registry.register(
1477
'move', move_orphan,
1478
'Move orphans into the bzr-orphans directory.')
1479
orphaning_registry._set_default_key('conflict')
1482
class TreeTransform(DiskTreeTransform):
1483
"""Represent a tree transformation.
1485
This object is designed to support incremental generation of the transform,
1488
However, it gives optimum performance when parent directories are created
1489
before their contents. The transform is then able to put child files
1490
directly in their parent directory, avoiding later renames.
1492
It is easy to produce malformed transforms, but they are generally
1493
harmless. Attempting to apply a malformed transform will cause an
1494
exception to be raised before any modifications are made to the tree.
1496
Many kinds of malformed transforms can be corrected with the
1497
resolve_conflicts function. The remaining ones indicate programming error,
1498
such as trying to create a file with no path.
1500
Two sets of file creation methods are supplied. Convenience methods are:
1505
These are composed of the low-level methods:
1507
* create_file or create_directory or create_symlink
1511
Transform/Transaction ids
1512
-------------------------
1513
trans_ids are temporary ids assigned to all files involved in a transform.
1514
It's possible, even common, that not all files in the Tree have trans_ids.
1516
trans_ids are used because filenames and file_ids are not good enough
1517
identifiers; filenames change, and not all files have file_ids. File-ids
1518
are also associated with trans-ids, so that moving a file moves its
1521
trans_ids are only valid for the TreeTransform that generated them.
1525
Limbo is a temporary directory use to hold new versions of files.
1526
Files are added to limbo by create_file, create_directory, create_symlink,
1527
and their convenience variants (new_*). Files may be removed from limbo
1528
using cancel_creation. Files are renamed from limbo into their final
1529
location as part of TreeTransform.apply
1531
Limbo must be cleaned up, by either calling TreeTransform.apply or
1532
calling TreeTransform.finalize.
1534
Files are placed into limbo inside their parent directories, where
1535
possible. This reduces subsequent renames, and makes operations involving
1536
lots of files faster. This optimization is only possible if the parent
1537
directory is created *before* creating any of its children, so avoid
1538
creating children before parents, where possible.
1542
This temporary directory is used by _FileMover for storing files that are
1543
about to be deleted. In case of rollback, the files will be restored.
1544
FileMover does not delete files until it is sure that a rollback will not
1547
def __init__(self, tree, pb=None):
1548
"""Note: a tree_write lock is taken on the tree.
1550
Use TreeTransform.finalize() to release the lock (can be omitted if
1551
TreeTransform.apply() called).
1553
tree.lock_tree_write()
1556
limbodir = urlutils.local_path_from_url(
1557
tree._transport.abspath('limbo'))
1561
if e.errno == errno.EEXIST:
1562
raise ExistingLimbo(limbodir)
1563
deletiondir = urlutils.local_path_from_url(
1564
tree._transport.abspath('pending-deletion'))
1566
os.mkdir(deletiondir)
1568
if e.errno == errno.EEXIST:
1569
raise errors.ExistingPendingDeletion(deletiondir)
1574
# Cache of realpath results, to speed up canonical_path
1575
self._realpaths = {}
1576
# Cache of relpath results, to speed up canonical_path
1578
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1579
tree.case_sensitive)
1580
self._deletiondir = deletiondir
1582
def canonical_path(self, path):
1583
"""Get the canonical tree-relative path"""
1584
# don't follow final symlinks
1585
abs = self._tree.abspath(path)
1586
if abs in self._relpaths:
1587
return self._relpaths[abs]
1588
dirname, basename = os.path.split(abs)
1589
if dirname not in self._realpaths:
1590
self._realpaths[dirname] = os.path.realpath(dirname)
1591
dirname = self._realpaths[dirname]
1592
abs = pathjoin(dirname, basename)
1593
if dirname in self._relpaths:
1594
relpath = pathjoin(self._relpaths[dirname], basename)
1595
relpath = relpath.rstrip('/\\')
1597
relpath = self._tree.relpath(abs)
1598
self._relpaths[abs] = relpath
1601
def tree_kind(self, trans_id):
1602
"""Determine the file kind in the working tree.
1604
:returns: The file kind or None if the file does not exist
1606
path = self._tree_id_paths.get(trans_id)
1610
return file_kind(self._tree.abspath(path))
1611
except errors.NoSuchFile:
1614
def _set_mode(self, trans_id, mode_id, typefunc):
1615
"""Set the mode of new file contents.
1616
The mode_id is the existing file to get the mode from (often the same
1617
as trans_id). The operation is only performed if there's a mode match
1618
according to typefunc.
1623
old_path = self._tree_id_paths[mode_id]
1627
mode = os.stat(self._tree.abspath(old_path)).st_mode
1629
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1630
# Either old_path doesn't exist, or the parent of the
1631
# target is not a directory (but will be one eventually)
1632
# Either way, we know it doesn't exist *right now*
1633
# See also bug #248448
1638
os.chmod(self._limbo_name(trans_id), mode)
1640
def iter_tree_children(self, parent_id):
1641
"""Iterate through the entry's tree children, if any"""
1643
path = self._tree_id_paths[parent_id]
1647
children = os.listdir(self._tree.abspath(path))
1649
if not (osutils._is_error_enotdir(e)
1650
or e.errno in (errno.ENOENT, errno.ESRCH)):
1654
for child in children:
1655
childpath = joinpath(path, child)
1656
if self._tree.is_control_filename(childpath):
1658
yield self.trans_id_tree_path(childpath)
1660
def _generate_limbo_path(self, trans_id):
1661
"""Generate a limbo path using the final path if possible.
1663
This optimizes the performance of applying the tree transform by
1664
avoiding renames. These renames can be avoided only when the parent
1665
directory is already scheduled for creation.
1667
If the final path cannot be used, falls back to using the trans_id as
1670
parent = self._new_parent.get(trans_id)
1671
# if the parent directory is already in limbo (e.g. when building a
1672
# tree), choose a limbo name inside the parent, to reduce further
1674
use_direct_path = False
1675
if self._new_contents.get(parent) == 'directory':
1676
filename = self._new_name.get(trans_id)
1677
if filename is not None:
1678
if parent not in self._limbo_children:
1679
self._limbo_children[parent] = set()
1680
self._limbo_children_names[parent] = {}
1681
use_direct_path = True
1682
# the direct path can only be used if no other file has
1683
# already taken this pathname, i.e. if the name is unused, or
1684
# if it is already associated with this trans_id.
1685
elif self._case_sensitive_target:
1686
if (self._limbo_children_names[parent].get(filename)
1687
in (trans_id, None)):
1688
use_direct_path = True
1690
for l_filename, l_trans_id in\
1691
self._limbo_children_names[parent].iteritems():
1692
if l_trans_id == trans_id:
1694
if l_filename.lower() == filename.lower():
1697
use_direct_path = True
1699
if not use_direct_path:
1700
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1702
limbo_name = pathjoin(self._limbo_files[parent], filename)
1703
self._limbo_children[parent].add(trans_id)
1704
self._limbo_children_names[parent][filename] = trans_id
1708
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1709
"""Apply all changes to the inventory and filesystem.
1711
If filesystem or inventory conflicts are present, MalformedTransform
1714
If apply succeeds, finalize is not necessary.
1716
:param no_conflicts: if True, the caller guarantees there are no
1717
conflicts, so no check is made.
1718
:param precomputed_delta: An inventory delta to use instead of
1720
:param _mover: Supply an alternate FileMover, for testing
1722
if not no_conflicts:
1723
self._check_malformed()
1724
child_pb = ui.ui_factory.nested_progress_bar()
1726
if precomputed_delta is None:
1727
child_pb.update(gettext('Apply phase'), 0, 2)
1728
inventory_delta = self._generate_inventory_delta()
1731
inventory_delta = precomputed_delta
1734
mover = _FileMover()
1738
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1739
self._apply_removals(mover)
1740
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1741
modified_paths = self._apply_insertions(mover)
1746
mover.apply_deletions()
1749
if self.final_file_id(self.root) is None:
1750
inventory_delta = [e for e in inventory_delta if e[0] != '']
1751
self._tree.apply_inventory_delta(inventory_delta)
1752
self._apply_observed_sha1s()
1755
return _TransformResults(modified_paths, self.rename_count)
1757
def _generate_inventory_delta(self):
1758
"""Generate an inventory delta for the current transform."""
1759
inventory_delta = []
1760
child_pb = ui.ui_factory.nested_progress_bar()
1761
new_paths = self._inventory_altered()
1762
total_entries = len(new_paths) + len(self._removed_id)
1764
for num, trans_id in enumerate(self._removed_id):
1766
child_pb.update(gettext('removing file'), num, total_entries)
1767
if trans_id == self._new_root:
1768
file_id = self._tree.get_root_id()
1770
file_id = self.tree_file_id(trans_id)
1771
# File-id isn't really being deleted, just moved
1772
if file_id in self._r_new_id:
1774
path = self._tree_id_paths[trans_id]
1775
inventory_delta.append((path, None, file_id, None))
1776
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1778
entries = self._tree.iter_entries_by_dir(
1779
new_path_file_ids.values())
1780
old_paths = dict((e.file_id, p) for p, e in entries)
1782
for num, (path, trans_id) in enumerate(new_paths):
1784
child_pb.update(gettext('adding file'),
1785
num + len(self._removed_id), total_entries)
1786
file_id = new_path_file_ids[trans_id]
1790
kind = self.final_kind(trans_id)
1792
kind = self._tree.stored_kind(file_id)
1793
parent_trans_id = self.final_parent(trans_id)
1794
parent_file_id = new_path_file_ids.get(parent_trans_id)
1795
if parent_file_id is None:
1796
parent_file_id = self.final_file_id(parent_trans_id)
1797
if trans_id in self._new_reference_revision:
1798
new_entry = inventory.TreeReference(
1800
self._new_name[trans_id],
1801
self.final_file_id(self._new_parent[trans_id]),
1802
None, self._new_reference_revision[trans_id])
1804
new_entry = inventory.make_entry(kind,
1805
self.final_name(trans_id),
1806
parent_file_id, file_id)
1807
old_path = old_paths.get(new_entry.file_id)
1808
new_executability = self._new_executability.get(trans_id)
1809
if new_executability is not None:
1810
new_entry.executable = new_executability
1811
inventory_delta.append(
1812
(old_path, path, new_entry.file_id, new_entry))
1815
return inventory_delta
1817
def _apply_removals(self, mover):
1818
"""Perform tree operations that remove directory/inventory names.
1820
That is, delete files that are to be deleted, and put any files that
1821
need renaming into limbo. This must be done in strict child-to-parent
1824
If inventory_delta is None, no inventory delta generation is performed.
1826
tree_paths = list(self._tree_path_ids.iteritems())
1827
tree_paths.sort(reverse=True)
1828
child_pb = ui.ui_factory.nested_progress_bar()
1830
for num, (path, trans_id) in enumerate(tree_paths):
1831
# do not attempt to move root into a subdirectory of itself.
1834
child_pb.update(gettext('removing file'), num, len(tree_paths))
1835
full_path = self._tree.abspath(path)
1836
if trans_id in self._removed_contents:
1837
delete_path = os.path.join(self._deletiondir, trans_id)
1838
mover.pre_delete(full_path, delete_path)
1839
elif (trans_id in self._new_name
1840
or trans_id in self._new_parent):
1842
mover.rename(full_path, self._limbo_name(trans_id))
1843
except errors.TransformRenameFailed, e:
1844
if e.errno != errno.ENOENT:
1847
self.rename_count += 1
1851
def _apply_insertions(self, mover):
1852
"""Perform tree operations that insert directory/inventory names.
1854
That is, create any files that need to be created, and restore from
1855
limbo any files that needed renaming. This must be done in strict
1856
parent-to-child order.
1858
If inventory_delta is None, no inventory delta is calculated, and
1859
no list of modified paths is returned.
1861
new_paths = self.new_paths(filesystem_only=True)
1863
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1865
child_pb = ui.ui_factory.nested_progress_bar()
1867
for num, (path, trans_id) in enumerate(new_paths):
1869
child_pb.update(gettext('adding file'), num, len(new_paths))
1870
full_path = self._tree.abspath(path)
1871
if trans_id in self._needs_rename:
1873
mover.rename(self._limbo_name(trans_id), full_path)
1874
except errors.TransformRenameFailed, e:
1875
# We may be renaming a dangling inventory id
1876
if e.errno != errno.ENOENT:
1879
self.rename_count += 1
1880
# TODO: if trans_id in self._observed_sha1s, we should
1881
# re-stat the final target, since ctime will be
1882
# updated by the change.
1883
if (trans_id in self._new_contents or
1884
self.path_changed(trans_id)):
1885
if trans_id in self._new_contents:
1886
modified_paths.append(full_path)
1887
if trans_id in self._new_executability:
1888
self._set_executability(path, trans_id)
1889
if trans_id in self._observed_sha1s:
1890
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1891
st = osutils.lstat(full_path)
1892
self._observed_sha1s[trans_id] = (o_sha1, st)
1895
for path, trans_id in new_paths:
1896
# new_paths includes stuff like workingtree conflicts. Only the
1897
# stuff in new_contents actually comes from limbo.
1898
if trans_id in self._limbo_files:
1899
del self._limbo_files[trans_id]
1900
self._new_contents.clear()
1901
return modified_paths
1903
def _apply_observed_sha1s(self):
1904
"""After we have finished renaming everything, update observed sha1s
1906
This has to be done after self._tree.apply_inventory_delta, otherwise
1907
it doesn't know anything about the files we are updating. Also, we want
1908
to do this as late as possible, so that most entries end up cached.
1910
# TODO: this doesn't update the stat information for directories. So
1911
# the first 'bzr status' will still need to rewrite
1912
# .bzr/checkout/dirstate. However, we at least don't need to
1913
# re-read all of the files.
1914
# TODO: If the operation took a while, we could do a time.sleep(3) here
1915
# to allow the clock to tick over and ensure we won't have any
1916
# problems. (we could observe start time, and finish time, and if
1917
# it is less than eg 10% overhead, add a sleep call.)
1918
paths = FinalPaths(self)
1919
for trans_id, observed in self._observed_sha1s.iteritems():
1920
path = paths.get_path(trans_id)
1921
# We could get the file_id, but dirstate prefers to use the path
1922
# anyway, and it is 'cheaper' to determine.
1923
# file_id = self._new_id[trans_id]
1924
self._tree._observed_sha1(None, path, observed)
1927
class TransformPreview(DiskTreeTransform):
1928
"""A TreeTransform for generating preview trees.
1930
Unlike TreeTransform, this version works when the input tree is a
1931
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1932
unversioned files in the input tree.
1935
def __init__(self, tree, pb=None, case_sensitive=True):
1937
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1938
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1940
def canonical_path(self, path):
1943
def tree_kind(self, trans_id):
1944
path = self._tree_id_paths.get(trans_id)
1947
kind = self._tree.path_content_summary(path)[0]
1948
if kind == 'missing':
1952
def _set_mode(self, trans_id, mode_id, typefunc):
1953
"""Set the mode of new file contents.
1954
The mode_id is the existing file to get the mode from (often the same
1955
as trans_id). The operation is only performed if there's a mode match
1956
according to typefunc.
1958
# is it ok to ignore this? probably
1961
def iter_tree_children(self, parent_id):
1962
"""Iterate through the entry's tree children, if any"""
1964
path = self._tree_id_paths[parent_id]
1967
file_id = self.tree_file_id(parent_id)
1970
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1971
children = getattr(entry, 'children', {})
1972
for child in children:
1973
childpath = joinpath(path, child)
1974
yield self.trans_id_tree_path(childpath)
1976
def new_orphan(self, trans_id, parent_id):
1977
raise NotImplementedError(self.new_orphan)
1980
class _PreviewTree(tree.InventoryTree):
1981
"""Partial implementation of Tree to support show_diff_trees"""
1983
def __init__(self, transform):
1984
self._transform = transform
1985
self._final_paths = FinalPaths(transform)
1986
self.__by_parent = None
1987
self._parent_ids = []
1988
self._all_children_cache = {}
1989
self._path2trans_id_cache = {}
1990
self._final_name_cache = {}
1991
self._iter_changes_cache = dict((c[0], c) for c in
1992
self._transform.iter_changes())
1994
def _content_change(self, file_id):
1995
"""Return True if the content of this file changed"""
1996
changes = self._iter_changes_cache.get(file_id)
1997
# changes[2] is true if the file content changed. See
1998
# InterTree.iter_changes.
1999
return (changes is not None and changes[2])
2001
def _get_repository(self):
2002
repo = getattr(self._transform._tree, '_repository', None)
2004
repo = self._transform._tree.branch.repository
2007
def _iter_parent_trees(self):
2008
for revision_id in self.get_parent_ids():
2010
yield self.revision_tree(revision_id)
2011
except errors.NoSuchRevisionInTree:
2012
yield self._get_repository().revision_tree(revision_id)
2014
def _get_file_revision(self, file_id, vf, tree_revision):
2015
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2016
self._iter_parent_trees()]
2017
vf.add_lines((file_id, tree_revision), parent_keys,
2018
self.get_file_lines(file_id))
2019
repo = self._get_repository()
2020
base_vf = repo.texts
2021
if base_vf not in vf.fallback_versionedfiles:
2022
vf.fallback_versionedfiles.append(base_vf)
2023
return tree_revision
2025
def _stat_limbo_file(self, file_id=None, trans_id=None):
2026
if trans_id is None:
2027
trans_id = self._transform.trans_id_file_id(file_id)
2028
name = self._transform._limbo_name(trans_id)
2029
return os.lstat(name)
2032
def _by_parent(self):
2033
if self.__by_parent is None:
2034
self.__by_parent = self._transform.by_parent()
2035
return self.__by_parent
2037
def _comparison_data(self, entry, path):
2038
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2039
if kind == 'missing':
2043
file_id = self._transform.final_file_id(self._path2trans_id(path))
2044
executable = self.is_executable(file_id, path)
2045
return kind, executable, None
2047
def is_locked(self):
2050
def lock_read(self):
2051
# Perhaps in theory, this should lock the TreeTransform?
2058
def inventory(self):
2059
"""This Tree does not use inventory as its backing data."""
2060
raise NotImplementedError(_PreviewTree.inventory)
2062
def get_root_id(self):
2063
return self._transform.final_file_id(self._transform.root)
2065
def all_file_ids(self):
2066
tree_ids = set(self._transform._tree.all_file_ids())
2067
tree_ids.difference_update(self._transform.tree_file_id(t)
2068
for t in self._transform._removed_id)
2069
tree_ids.update(self._transform._new_id.values())
2073
return iter(self.all_file_ids())
2075
def _has_id(self, file_id, fallback_check):
2076
if file_id in self._transform._r_new_id:
2078
elif file_id in set([self._transform.tree_file_id(trans_id) for
2079
trans_id in self._transform._removed_id]):
2082
return fallback_check(file_id)
2084
def has_id(self, file_id):
2085
return self._has_id(file_id, self._transform._tree.has_id)
2087
def has_or_had_id(self, file_id):
2088
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2090
def _path2trans_id(self, path):
2091
# We must not use None here, because that is a valid value to store.
2092
trans_id = self._path2trans_id_cache.get(path, object)
2093
if trans_id is not object:
2095
segments = splitpath(path)
2096
cur_parent = self._transform.root
2097
for cur_segment in segments:
2098
for child in self._all_children(cur_parent):
2099
final_name = self._final_name_cache.get(child)
2100
if final_name is None:
2101
final_name = self._transform.final_name(child)
2102
self._final_name_cache[child] = final_name
2103
if final_name == cur_segment:
2107
self._path2trans_id_cache[path] = None
2109
self._path2trans_id_cache[path] = cur_parent
2112
def path2id(self, path):
2113
return self._transform.final_file_id(self._path2trans_id(path))
2115
def id2path(self, file_id):
2116
trans_id = self._transform.trans_id_file_id(file_id)
2118
return self._final_paths._determine_path(trans_id)
2120
raise errors.NoSuchId(self, file_id)
2122
def _all_children(self, trans_id):
2123
children = self._all_children_cache.get(trans_id)
2124
if children is not None:
2126
children = set(self._transform.iter_tree_children(trans_id))
2127
# children in the _new_parent set are provided by _by_parent.
2128
children.difference_update(self._transform._new_parent.keys())
2129
children.update(self._by_parent.get(trans_id, []))
2130
self._all_children_cache[trans_id] = children
2133
def iter_children(self, file_id):
2134
trans_id = self._transform.trans_id_file_id(file_id)
2135
for child_trans_id in self._all_children(trans_id):
2136
yield self._transform.final_file_id(child_trans_id)
2139
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2140
in self._transform._tree.extras())
2141
possible_extras.update(self._transform._new_contents)
2142
possible_extras.update(self._transform._removed_id)
2143
for trans_id in possible_extras:
2144
if self._transform.final_file_id(trans_id) is None:
2145
yield self._final_paths._determine_path(trans_id)
2147
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2148
yield_parents=False):
2149
for trans_id, parent_file_id in ordered_entries:
2150
file_id = self._transform.final_file_id(trans_id)
2153
if (specific_file_ids is not None
2154
and file_id not in specific_file_ids):
2156
kind = self._transform.final_kind(trans_id)
2158
kind = self._transform._tree.stored_kind(file_id)
2159
new_entry = inventory.make_entry(
2161
self._transform.final_name(trans_id),
2162
parent_file_id, file_id)
2163
yield new_entry, trans_id
2165
def _list_files_by_dir(self):
2166
todo = [ROOT_PARENT]
2168
while len(todo) > 0:
2170
parent_file_id = self._transform.final_file_id(parent)
2171
children = list(self._all_children(parent))
2172
paths = dict(zip(children, self._final_paths.get_paths(children)))
2173
children.sort(key=paths.get)
2174
todo.extend(reversed(children))
2175
for trans_id in children:
2176
ordered_ids.append((trans_id, parent_file_id))
2179
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2180
# This may not be a maximally efficient implementation, but it is
2181
# reasonably straightforward. An implementation that grafts the
2182
# TreeTransform changes onto the tree's iter_entries_by_dir results
2183
# might be more efficient, but requires tricky inferences about stack
2185
ordered_ids = self._list_files_by_dir()
2186
for entry, trans_id in self._make_inv_entries(ordered_ids,
2187
specific_file_ids, yield_parents=yield_parents):
2188
yield unicode(self._final_paths.get_path(trans_id)), entry
2190
def _iter_entries_for_dir(self, dir_path):
2191
"""Return path, entry for items in a directory without recursing down."""
2192
dir_file_id = self.path2id(dir_path)
2194
for file_id in self.iter_children(dir_file_id):
2195
trans_id = self._transform.trans_id_file_id(file_id)
2196
ordered_ids.append((trans_id, file_id))
2197
for entry, trans_id in self._make_inv_entries(ordered_ids):
2198
yield unicode(self._final_paths.get_path(trans_id)), entry
2200
def list_files(self, include_root=False, from_dir=None, recursive=True):
2201
"""See WorkingTree.list_files."""
2202
# XXX This should behave like WorkingTree.list_files, but is really
2203
# more like RevisionTree.list_files.
2207
prefix = from_dir + '/'
2208
entries = self.iter_entries_by_dir()
2209
for path, entry in entries:
2210
if entry.name == '' and not include_root:
2213
if not path.startswith(prefix):
2215
path = path[len(prefix):]
2216
yield path, 'V', entry.kind, entry.file_id, entry
2218
if from_dir is None and include_root is True:
2219
root_entry = inventory.make_entry('directory', '',
2220
ROOT_PARENT, self.get_root_id())
2221
yield '', 'V', 'directory', root_entry.file_id, root_entry
2222
entries = self._iter_entries_for_dir(from_dir or '')
2223
for path, entry in entries:
2224
yield path, 'V', entry.kind, entry.file_id, entry
2226
def kind(self, file_id):
2227
trans_id = self._transform.trans_id_file_id(file_id)
2228
return self._transform.final_kind(trans_id)
2230
def stored_kind(self, file_id):
2231
trans_id = self._transform.trans_id_file_id(file_id)
2233
return self._transform._new_contents[trans_id]
2235
return self._transform._tree.stored_kind(file_id)
2237
def get_file_mtime(self, file_id, path=None):
2238
"""See Tree.get_file_mtime"""
2239
if not self._content_change(file_id):
2240
return self._transform._tree.get_file_mtime(file_id)
2241
return self._stat_limbo_file(file_id).st_mtime
2243
def _file_size(self, entry, stat_value):
2244
return self.get_file_size(entry.file_id)
2246
def get_file_size(self, file_id):
2247
"""See Tree.get_file_size"""
2248
trans_id = self._transform.trans_id_file_id(file_id)
2249
kind = self._transform.final_kind(trans_id)
2252
if trans_id in self._transform._new_contents:
2253
return self._stat_limbo_file(trans_id=trans_id).st_size
2254
if self.kind(file_id) == 'file':
2255
return self._transform._tree.get_file_size(file_id)
2259
def get_file_verifier(self, file_id, path=None, stat_value=None):
2260
trans_id = self._transform.trans_id_file_id(file_id)
2261
kind = self._transform._new_contents.get(trans_id)
2263
return self._transform._tree.get_file_verifier(file_id)
2265
fileobj = self.get_file(file_id)
2267
return ("SHA1", sha_file(fileobj))
2271
def get_file_sha1(self, file_id, path=None, stat_value=None):
2272
trans_id = self._transform.trans_id_file_id(file_id)
2273
kind = self._transform._new_contents.get(trans_id)
2275
return self._transform._tree.get_file_sha1(file_id)
2277
fileobj = self.get_file(file_id)
2279
return sha_file(fileobj)
2283
def is_executable(self, file_id, path=None):
2286
trans_id = self._transform.trans_id_file_id(file_id)
2288
return self._transform._new_executability[trans_id]
2291
return self._transform._tree.is_executable(file_id, path)
2293
if e.errno == errno.ENOENT:
2296
except errors.NoSuchId:
2299
def has_filename(self, path):
2300
trans_id = self._path2trans_id(path)
2301
if trans_id in self._transform._new_contents:
2303
elif trans_id in self._transform._removed_contents:
2306
return self._transform._tree.has_filename(path)
2308
def path_content_summary(self, path):
2309
trans_id = self._path2trans_id(path)
2310
tt = self._transform
2311
tree_path = tt._tree_id_paths.get(trans_id)
2312
kind = tt._new_contents.get(trans_id)
2314
if tree_path is None or trans_id in tt._removed_contents:
2315
return 'missing', None, None, None
2316
summary = tt._tree.path_content_summary(tree_path)
2317
kind, size, executable, link_or_sha1 = summary
2320
limbo_name = tt._limbo_name(trans_id)
2321
if trans_id in tt._new_reference_revision:
2322
kind = 'tree-reference'
2324
statval = os.lstat(limbo_name)
2325
size = statval.st_size
2326
if not supports_executable():
2329
executable = statval.st_mode & S_IEXEC
2333
if kind == 'symlink':
2334
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2335
executable = tt._new_executability.get(trans_id, executable)
2336
return kind, size, executable, link_or_sha1
2338
def iter_changes(self, from_tree, include_unchanged=False,
2339
specific_files=None, pb=None, extra_trees=None,
2340
require_versioned=True, want_unversioned=False):
2341
"""See InterTree.iter_changes.
2343
This has a fast path that is only used when the from_tree matches
2344
the transform tree, and no fancy options are supplied.
2346
if (from_tree is not self._transform._tree or include_unchanged or
2347
specific_files or want_unversioned):
2348
return tree.InterTree(from_tree, self).iter_changes(
2349
include_unchanged=include_unchanged,
2350
specific_files=specific_files,
2352
extra_trees=extra_trees,
2353
require_versioned=require_versioned,
2354
want_unversioned=want_unversioned)
2355
if want_unversioned:
2356
raise ValueError('want_unversioned is not supported')
2357
return self._transform.iter_changes()
2359
def get_file(self, file_id, path=None):
2360
"""See Tree.get_file"""
2361
if not self._content_change(file_id):
2362
return self._transform._tree.get_file(file_id, path)
2363
trans_id = self._transform.trans_id_file_id(file_id)
2364
name = self._transform._limbo_name(trans_id)
2365
return open(name, 'rb')
2367
def get_file_with_stat(self, file_id, path=None):
2368
return self.get_file(file_id, path), None
2370
def annotate_iter(self, file_id,
2371
default_revision=_mod_revision.CURRENT_REVISION):
2372
changes = self._iter_changes_cache.get(file_id)
2376
changed_content, versioned, kind = (changes[2], changes[3],
2380
get_old = (kind[0] == 'file' and versioned[0])
2382
old_annotation = self._transform._tree.annotate_iter(file_id,
2383
default_revision=default_revision)
2387
return old_annotation
2388
if not changed_content:
2389
return old_annotation
2390
# TODO: This is doing something similar to what WT.annotate_iter is
2391
# doing, however it fails slightly because it doesn't know what
2392
# the *other* revision_id is, so it doesn't know how to give the
2393
# other as the origin for some lines, they all get
2394
# 'default_revision'
2395
# It would be nice to be able to use the new Annotator based
2396
# approach, as well.
2397
return annotate.reannotate([old_annotation],
2398
self.get_file(file_id).readlines(),
2401
def get_symlink_target(self, file_id, path=None):
2402
"""See Tree.get_symlink_target"""
2403
if not self._content_change(file_id):
2404
return self._transform._tree.get_symlink_target(file_id)
2405
trans_id = self._transform.trans_id_file_id(file_id)
2406
name = self._transform._limbo_name(trans_id)
2407
return osutils.readlink(name)
2409
def walkdirs(self, prefix=''):
2410
pending = [self._transform.root]
2411
while len(pending) > 0:
2412
parent_id = pending.pop()
2415
prefix = prefix.rstrip('/')
2416
parent_path = self._final_paths.get_path(parent_id)
2417
parent_file_id = self._transform.final_file_id(parent_id)
2418
for child_id in self._all_children(parent_id):
2419
path_from_root = self._final_paths.get_path(child_id)
2420
basename = self._transform.final_name(child_id)
2421
file_id = self._transform.final_file_id(child_id)
2422
kind = self._transform.final_kind(child_id)
2423
if kind is not None:
2424
versioned_kind = kind
2427
versioned_kind = self._transform._tree.stored_kind(file_id)
2428
if versioned_kind == 'directory':
2429
subdirs.append(child_id)
2430
children.append((path_from_root, basename, kind, None,
2431
file_id, versioned_kind))
2433
if parent_path.startswith(prefix):
2434
yield (parent_path, parent_file_id), children
2435
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2438
def get_parent_ids(self):
2439
return self._parent_ids
2441
def set_parent_ids(self, parent_ids):
2442
self._parent_ids = parent_ids
2444
def get_revision_tree(self, revision_id):
2445
return self._transform._tree.get_revision_tree(revision_id)
2448
def joinpath(parent, child):
2449
"""Join tree-relative paths, handling the tree root specially"""
2450
if parent is None or parent == "":
2453
return pathjoin(parent, child)
2456
class FinalPaths(object):
2457
"""Make path calculation cheap by memoizing paths.
2459
The underlying tree must not be manipulated between calls, or else
2460
the results will likely be incorrect.
2462
def __init__(self, transform):
2463
object.__init__(self)
2464
self._known_paths = {}
2465
self.transform = transform
2467
def _determine_path(self, trans_id):
2468
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2470
name = self.transform.final_name(trans_id)
2471
parent_id = self.transform.final_parent(trans_id)
2472
if parent_id == self.transform.root:
2475
return pathjoin(self.get_path(parent_id), name)
2477
def get_path(self, trans_id):
2478
"""Find the final path associated with a trans_id"""
2479
if trans_id not in self._known_paths:
2480
self._known_paths[trans_id] = self._determine_path(trans_id)
2481
return self._known_paths[trans_id]
2483
def get_paths(self, trans_ids):
2484
return [(self.get_path(t), t) for t in trans_ids]
2488
def topology_sorted_ids(tree):
2489
"""Determine the topological order of the ids in a tree"""
2490
file_ids = list(tree)
2491
file_ids.sort(key=tree.id2path)
2495
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2496
delta_from_tree=False):
2497
"""Create working tree for a branch, using a TreeTransform.
2499
This function should be used on empty trees, having a tree root at most.
2500
(see merge and revert functionality for working with existing trees)
2502
Existing files are handled like so:
2504
- Existing bzrdirs take precedence over creating new items. They are
2505
created as '%s.diverted' % name.
2506
- Otherwise, if the content on disk matches the content we are building,
2507
it is silently replaced.
2508
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2510
:param tree: The tree to convert wt into a copy of
2511
:param wt: The working tree that files will be placed into
2512
:param accelerator_tree: A tree which can be used for retrieving file
2513
contents more quickly than tree itself, i.e. a workingtree. tree
2514
will be used for cases where accelerator_tree's content is different.
2515
:param hardlink: If true, hard-link files to accelerator_tree, where
2516
possible. accelerator_tree must implement abspath, i.e. be a
2518
:param delta_from_tree: If true, build_tree may use the input Tree to
2519
generate the inventory delta.
2521
wt.lock_tree_write()
2525
if accelerator_tree is not None:
2526
accelerator_tree.lock_read()
2528
return _build_tree(tree, wt, accelerator_tree, hardlink,
2531
if accelerator_tree is not None:
2532
accelerator_tree.unlock()
2539
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2540
"""See build_tree."""
2541
for num, _unused in enumerate(wt.all_file_ids()):
2542
if num > 0: # more than just a root
2543
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2545
top_pb = ui.ui_factory.nested_progress_bar()
2546
pp = ProgressPhase("Build phase", 2, top_pb)
2547
if tree.get_root_id() is not None:
2548
# This is kind of a hack: we should be altering the root
2549
# as part of the regular tree shape diff logic.
2550
# The conditional test here is to avoid doing an
2551
# expensive operation (flush) every time the root id
2552
# is set within the tree, nor setting the root and thus
2553
# marking the tree as dirty, because we use two different
2554
# idioms here: tree interfaces and inventory interfaces.
2555
if wt.get_root_id() != tree.get_root_id():
2556
wt.set_root_id(tree.get_root_id())
2558
tt = TreeTransform(wt)
2562
file_trans_id[wt.get_root_id()] = \
2563
tt.trans_id_tree_file_id(wt.get_root_id())
2564
pb = ui.ui_factory.nested_progress_bar()
2566
deferred_contents = []
2568
total = len(tree.all_file_ids())
2570
precomputed_delta = []
2572
precomputed_delta = None
2573
# Check if tree inventory has content. If so, we populate
2574
# existing_files with the directory content. If there are no
2575
# entries we skip populating existing_files as its not used.
2576
# This improves performance and unncessary work on large
2577
# directory trees. (#501307)
2579
existing_files = set()
2580
for dir, files in wt.walkdirs():
2581
existing_files.update(f[0] for f in files)
2582
for num, (tree_path, entry) in \
2583
enumerate(tree.iter_entries_by_dir()):
2584
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2585
if entry.parent_id is None:
2588
file_id = entry.file_id
2590
precomputed_delta.append((None, tree_path, file_id, entry))
2591
if tree_path in existing_files:
2592
target_path = wt.abspath(tree_path)
2593
kind = file_kind(target_path)
2594
if kind == "directory":
2596
controldir.ControlDir.open(target_path)
2597
except errors.NotBranchError:
2601
if (file_id not in divert and
2602
_content_match(tree, entry, file_id, kind,
2604
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2605
if kind == 'directory':
2607
parent_id = file_trans_id[entry.parent_id]
2608
if entry.kind == 'file':
2609
# We *almost* replicate new_by_entry, so that we can defer
2610
# getting the file text, and get them all at once.
2611
trans_id = tt.create_path(entry.name, parent_id)
2612
file_trans_id[file_id] = trans_id
2613
tt.version_file(file_id, trans_id)
2614
executable = tree.is_executable(file_id, tree_path)
2616
tt.set_executability(executable, trans_id)
2617
trans_data = (trans_id, tree_path, entry.text_sha1)
2618
deferred_contents.append((file_id, trans_data))
2620
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2623
new_trans_id = file_trans_id[file_id]
2624
old_parent = tt.trans_id_tree_path(tree_path)
2625
_reparent_children(tt, old_parent, new_trans_id)
2626
offset = num + 1 - len(deferred_contents)
2627
_create_files(tt, tree, deferred_contents, pb, offset,
2628
accelerator_tree, hardlink)
2632
divert_trans = set(file_trans_id[f] for f in divert)
2633
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2634
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2635
if len(raw_conflicts) > 0:
2636
precomputed_delta = None
2637
conflicts = cook_conflicts(raw_conflicts, tt)
2638
for conflict in conflicts:
2639
trace.warning(unicode(conflict))
2641
wt.add_conflicts(conflicts)
2642
except errors.UnsupportedOperation:
2644
result = tt.apply(no_conflicts=True,
2645
precomputed_delta=precomputed_delta)
2652
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2654
total = len(desired_files) + offset
2656
if accelerator_tree is None:
2657
new_desired_files = desired_files
2659
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2660
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2661
in iter if not (c or e[0] != e[1])]
2662
if accelerator_tree.supports_content_filtering():
2663
unchanged = [(f, p) for (f, p) in unchanged
2664
if not accelerator_tree.iter_search_rules([p]).next()]
2665
unchanged = dict(unchanged)
2666
new_desired_files = []
2668
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2669
accelerator_path = unchanged.get(file_id)
2670
if accelerator_path is None:
2671
new_desired_files.append((file_id,
2672
(trans_id, tree_path, text_sha1)))
2674
pb.update(gettext('Adding file contents'), count + offset, total)
2676
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2679
contents = accelerator_tree.get_file(file_id, accelerator_path)
2680
if wt.supports_content_filtering():
2681
filters = wt._content_filter_stack(tree_path)
2682
contents = filtered_output_bytes(contents, filters,
2683
ContentFilterContext(tree_path, tree))
2685
tt.create_file(contents, trans_id, sha1=text_sha1)
2689
except AttributeError:
2690
# after filtering, contents may no longer be file-like
2694
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2695
tree.iter_files_bytes(new_desired_files)):
2696
if wt.supports_content_filtering():
2697
filters = wt._content_filter_stack(tree_path)
2698
contents = filtered_output_bytes(contents, filters,
2699
ContentFilterContext(tree_path, tree))
2700
tt.create_file(contents, trans_id, sha1=text_sha1)
2701
pb.update(gettext('Adding file contents'), count + offset, total)
2704
def _reparent_children(tt, old_parent, new_parent):
2705
for child in tt.iter_tree_children(old_parent):
2706
tt.adjust_path(tt.final_name(child), new_parent, child)
2709
def _reparent_transform_children(tt, old_parent, new_parent):
2710
by_parent = tt.by_parent()
2711
for child in by_parent[old_parent]:
2712
tt.adjust_path(tt.final_name(child), new_parent, child)
2713
return by_parent[old_parent]
2716
def _content_match(tree, entry, file_id, kind, target_path):
2717
if entry.kind != kind:
2719
if entry.kind == "directory":
2721
if entry.kind == "file":
2722
f = file(target_path, 'rb')
2724
if tree.get_file_text(file_id) == f.read():
2728
elif entry.kind == "symlink":
2729
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2734
def resolve_checkout(tt, conflicts, divert):
2735
new_conflicts = set()
2736
for c_type, conflict in ((c[0], c) for c in conflicts):
2737
# Anything but a 'duplicate' would indicate programmer error
2738
if c_type != 'duplicate':
2739
raise AssertionError(c_type)
2740
# Now figure out which is new and which is old
2741
if tt.new_contents(conflict[1]):
2742
new_file = conflict[1]
2743
old_file = conflict[2]
2745
new_file = conflict[2]
2746
old_file = conflict[1]
2748
# We should only get here if the conflict wasn't completely
2750
final_parent = tt.final_parent(old_file)
2751
if new_file in divert:
2752
new_name = tt.final_name(old_file)+'.diverted'
2753
tt.adjust_path(new_name, final_parent, new_file)
2754
new_conflicts.add((c_type, 'Diverted to',
2755
new_file, old_file))
2757
new_name = tt.final_name(old_file)+'.moved'
2758
tt.adjust_path(new_name, final_parent, old_file)
2759
new_conflicts.add((c_type, 'Moved existing file to',
2760
old_file, new_file))
2761
return new_conflicts
2764
def new_by_entry(tt, entry, parent_id, tree):
2765
"""Create a new file according to its inventory entry"""
2769
contents = tree.get_file(entry.file_id).readlines()
2770
executable = tree.is_executable(entry.file_id)
2771
return tt.new_file(name, parent_id, contents, entry.file_id,
2773
elif kind in ('directory', 'tree-reference'):
2774
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2775
if kind == 'tree-reference':
2776
tt.set_tree_reference(entry.reference_revision, trans_id)
2778
elif kind == 'symlink':
2779
target = tree.get_symlink_target(entry.file_id)
2780
return tt.new_symlink(name, parent_id, target, entry.file_id)
2782
raise errors.BadFileKindError(name, kind)
2785
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2786
filter_tree_path=None):
2787
"""Create new file contents according to tree contents.
2789
:param filter_tree_path: the tree path to use to lookup
2790
content filters to apply to the bytes output in the working tree.
2791
This only applies if the working tree supports content filtering.
2793
kind = tree.kind(file_id)
2794
if kind == 'directory':
2795
tt.create_directory(trans_id)
2796
elif kind == "file":
2798
tree_file = tree.get_file(file_id)
2800
bytes = tree_file.readlines()
2804
if wt.supports_content_filtering() and filter_tree_path is not None:
2805
filters = wt._content_filter_stack(filter_tree_path)
2806
bytes = filtered_output_bytes(bytes, filters,
2807
ContentFilterContext(filter_tree_path, tree))
2808
tt.create_file(bytes, trans_id)
2809
elif kind == "symlink":
2810
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2812
raise AssertionError('Unknown kind %r' % kind)
2815
def create_entry_executability(tt, entry, trans_id):
2816
"""Set the executability of a trans_id according to an inventory entry"""
2817
if entry.kind == "file":
2818
tt.set_executability(entry.executable, trans_id)
2821
@deprecated_function(deprecated_in((2, 3, 0)))
2822
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2823
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2826
@deprecated_function(deprecated_in((2, 3, 0)))
2827
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2828
"""Produce a backup-style name that appears to be available"""
2832
yield "%s.~%d~" % (name, counter)
2834
for new_name in name_gen():
2835
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2839
def revert(working_tree, target_tree, filenames, backups=False,
2840
pb=None, change_reporter=None):
2841
"""Revert a working tree's contents to those of a target tree."""
2842
target_tree.lock_read()
2843
pb = ui.ui_factory.nested_progress_bar()
2844
tt = TreeTransform(working_tree, pb)
2846
pp = ProgressPhase("Revert phase", 3, pb)
2847
conflicts, merge_modified = _prepare_revert_transform(
2848
working_tree, target_tree, tt, filenames, backups, pp)
2850
change_reporter = delta._ChangeReporter(
2851
unversioned_filter=working_tree.is_ignored)
2852
delta.report_changes(tt.iter_changes(), change_reporter)
2853
for conflict in conflicts:
2854
trace.warning(unicode(conflict))
2857
working_tree.set_merge_modified(merge_modified)
2859
target_tree.unlock()
2865
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2866
backups, pp, basis_tree=None,
2867
merge_modified=None):
2868
child_pb = ui.ui_factory.nested_progress_bar()
2870
if merge_modified is None:
2871
merge_modified = working_tree.merge_modified()
2872
merge_modified = _alter_files(working_tree, target_tree, tt,
2873
child_pb, filenames, backups,
2874
merge_modified, basis_tree)
2877
child_pb = ui.ui_factory.nested_progress_bar()
2879
raw_conflicts = resolve_conflicts(tt, child_pb,
2880
lambda t, c: conflict_pass(t, c, target_tree))
2883
conflicts = cook_conflicts(raw_conflicts, tt)
2884
return conflicts, merge_modified
2887
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2888
backups, merge_modified, basis_tree=None):
2889
if basis_tree is not None:
2890
basis_tree.lock_read()
2891
# We ask the working_tree for its changes relative to the target, rather
2892
# than the target changes relative to the working tree. Because WT4 has an
2893
# optimizer to compare itself to a target, but no optimizer for the
2895
change_list = working_tree.iter_changes(target_tree,
2896
specific_files=specific_files, pb=pb)
2897
if target_tree.get_root_id() is None:
2903
for id_num, (file_id, path, changed_content, versioned, parent, name,
2904
kind, executable) in enumerate(change_list):
2905
target_path, wt_path = path
2906
target_versioned, wt_versioned = versioned
2907
target_parent, wt_parent = parent
2908
target_name, wt_name = name
2909
target_kind, wt_kind = kind
2910
target_executable, wt_executable = executable
2911
if skip_root and wt_parent is None:
2913
trans_id = tt.trans_id_file_id(file_id)
2916
keep_content = False
2917
if wt_kind == 'file' and (backups or target_kind is None):
2918
wt_sha1 = working_tree.get_file_sha1(file_id)
2919
if merge_modified.get(file_id) != wt_sha1:
2920
# acquire the basis tree lazily to prevent the
2921
# expense of accessing it when it's not needed ?
2922
# (Guessing, RBC, 200702)
2923
if basis_tree is None:
2924
basis_tree = working_tree.basis_tree()
2925
basis_tree.lock_read()
2926
if basis_tree.has_id(file_id):
2927
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2929
elif target_kind is None and not target_versioned:
2931
if wt_kind is not None:
2932
if not keep_content:
2933
tt.delete_contents(trans_id)
2934
elif target_kind is not None:
2935
parent_trans_id = tt.trans_id_file_id(wt_parent)
2936
backup_name = tt._available_backup_name(
2937
wt_name, parent_trans_id)
2938
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2939
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2940
if wt_versioned and target_versioned:
2941
tt.unversion_file(trans_id)
2942
tt.version_file(file_id, new_trans_id)
2943
# New contents should have the same unix perms as old
2946
trans_id = new_trans_id
2947
if target_kind in ('directory', 'tree-reference'):
2948
tt.create_directory(trans_id)
2949
if target_kind == 'tree-reference':
2950
revision = target_tree.get_reference_revision(file_id,
2952
tt.set_tree_reference(revision, trans_id)
2953
elif target_kind == 'symlink':
2954
tt.create_symlink(target_tree.get_symlink_target(file_id),
2956
elif target_kind == 'file':
2957
deferred_files.append((file_id, (trans_id, mode_id)))
2958
if basis_tree is None:
2959
basis_tree = working_tree.basis_tree()
2960
basis_tree.lock_read()
2961
new_sha1 = target_tree.get_file_sha1(file_id)
2962
if (basis_tree.has_id(file_id) and
2963
new_sha1 == basis_tree.get_file_sha1(file_id)):
2964
if file_id in merge_modified:
2965
del merge_modified[file_id]
2967
merge_modified[file_id] = new_sha1
2969
# preserve the execute bit when backing up
2970
if keep_content and wt_executable == target_executable:
2971
tt.set_executability(target_executable, trans_id)
2972
elif target_kind is not None:
2973
raise AssertionError(target_kind)
2974
if not wt_versioned and target_versioned:
2975
tt.version_file(file_id, trans_id)
2976
if wt_versioned and not target_versioned:
2977
tt.unversion_file(trans_id)
2978
if (target_name is not None and
2979
(wt_name != target_name or wt_parent != target_parent)):
2980
if target_name == '' and target_parent is None:
2981
parent_trans = ROOT_PARENT
2983
parent_trans = tt.trans_id_file_id(target_parent)
2984
if wt_parent is None and wt_versioned:
2985
tt.adjust_root_path(target_name, parent_trans)
2987
tt.adjust_path(target_name, parent_trans, trans_id)
2988
if wt_executable != target_executable and target_kind == "file":
2989
tt.set_executability(target_executable, trans_id)
2990
if working_tree.supports_content_filtering():
2991
for index, ((trans_id, mode_id), bytes) in enumerate(
2992
target_tree.iter_files_bytes(deferred_files)):
2993
file_id = deferred_files[index][0]
2994
# We're reverting a tree to the target tree so using the
2995
# target tree to find the file path seems the best choice
2996
# here IMO - Ian C 27/Oct/2009
2997
filter_tree_path = target_tree.id2path(file_id)
2998
filters = working_tree._content_filter_stack(filter_tree_path)
2999
bytes = filtered_output_bytes(bytes, filters,
3000
ContentFilterContext(filter_tree_path, working_tree))
3001
tt.create_file(bytes, trans_id, mode_id)
3003
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3005
tt.create_file(bytes, trans_id, mode_id)
3006
tt.fixup_new_roots()
3008
if basis_tree is not None:
3010
return merge_modified
3013
def resolve_conflicts(tt, pb=None, pass_func=None):
3014
"""Make many conflict-resolution attempts, but die if they fail"""
3015
if pass_func is None:
3016
pass_func = conflict_pass
3017
new_conflicts = set()
3018
pb = ui.ui_factory.nested_progress_bar()
3021
pb.update(gettext('Resolution pass'), n+1, 10)
3022
conflicts = tt.find_conflicts()
3023
if len(conflicts) == 0:
3024
return new_conflicts
3025
new_conflicts.update(pass_func(tt, conflicts))
3026
raise MalformedTransform(conflicts=conflicts)
3031
def conflict_pass(tt, conflicts, path_tree=None):
3032
"""Resolve some classes of conflicts.
3034
:param tt: The transform to resolve conflicts in
3035
:param conflicts: The conflicts to resolve
3036
:param path_tree: A Tree to get supplemental paths from
3038
new_conflicts = set()
3039
for c_type, conflict in ((c[0], c) for c in conflicts):
3040
if c_type == 'duplicate id':
3041
tt.unversion_file(conflict[1])
3042
new_conflicts.add((c_type, 'Unversioned existing file',
3043
conflict[1], conflict[2], ))
3044
elif c_type == 'duplicate':
3045
# files that were renamed take precedence
3046
final_parent = tt.final_parent(conflict[1])
3047
if tt.path_changed(conflict[1]):
3048
existing_file, new_file = conflict[2], conflict[1]
3050
existing_file, new_file = conflict[1], conflict[2]
3051
new_name = tt.final_name(existing_file) + '.moved'
3052
tt.adjust_path(new_name, final_parent, existing_file)
3053
new_conflicts.add((c_type, 'Moved existing file to',
3054
existing_file, new_file))
3055
elif c_type == 'parent loop':
3056
# break the loop by undoing one of the ops that caused the loop
3058
while not tt.path_changed(cur):
3059
cur = tt.final_parent(cur)
3060
new_conflicts.add((c_type, 'Cancelled move', cur,
3061
tt.final_parent(cur),))
3062
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3064
elif c_type == 'missing parent':
3065
trans_id = conflict[1]
3066
if trans_id in tt._removed_contents:
3067
cancel_deletion = True
3068
orphans = tt._get_potential_orphans(trans_id)
3070
cancel_deletion = False
3071
# All children are orphans
3074
tt.new_orphan(o, trans_id)
3075
except OrphaningError:
3076
# Something bad happened so we cancel the directory
3077
# deletion which will leave it in place with a
3078
# conflict. The user can deal with it from there.
3079
# Note that this also catch the case where we don't
3080
# want to create orphans and leave the directory in
3082
cancel_deletion = True
3085
# Cancel the directory deletion
3086
tt.cancel_deletion(trans_id)
3087
new_conflicts.add(('deleting parent', 'Not deleting',
3092
tt.final_name(trans_id)
3094
if path_tree is not None:
3095
file_id = tt.final_file_id(trans_id)
3097
file_id = tt.inactive_file_id(trans_id)
3098
_, entry = path_tree.iter_entries_by_dir(
3100
# special-case the other tree root (move its
3101
# children to current root)
3102
if entry.parent_id is None:
3104
moved = _reparent_transform_children(
3105
tt, trans_id, tt.root)
3107
new_conflicts.add((c_type, 'Moved to root',
3110
parent_trans_id = tt.trans_id_file_id(
3112
tt.adjust_path(entry.name, parent_trans_id,
3115
tt.create_directory(trans_id)
3116
new_conflicts.add((c_type, 'Created directory', trans_id))
3117
elif c_type == 'unversioned parent':
3118
file_id = tt.inactive_file_id(conflict[1])
3119
# special-case the other tree root (move its children instead)
3120
if path_tree and path_tree.has_id(file_id):
3121
if path_tree.path2id('') == file_id:
3122
# This is the root entry, skip it
3124
tt.version_file(file_id, conflict[1])
3125
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3126
elif c_type == 'non-directory parent':
3127
parent_id = conflict[1]
3128
parent_parent = tt.final_parent(parent_id)
3129
parent_name = tt.final_name(parent_id)
3130
parent_file_id = tt.final_file_id(parent_id)
3131
new_parent_id = tt.new_directory(parent_name + '.new',
3132
parent_parent, parent_file_id)
3133
_reparent_transform_children(tt, parent_id, new_parent_id)
3134
if parent_file_id is not None:
3135
tt.unversion_file(parent_id)
3136
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3137
elif c_type == 'versioning no contents':
3138
tt.cancel_versioning(conflict[1])
3139
return new_conflicts
3142
def cook_conflicts(raw_conflicts, tt):
3143
"""Generate a list of cooked conflicts, sorted by file path"""
3144
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3145
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3148
def iter_cook_conflicts(raw_conflicts, tt):
3150
for conflict in raw_conflicts:
3151
c_type = conflict[0]
3152
action = conflict[1]
3153
modified_path = fp.get_path(conflict[2])
3154
modified_id = tt.final_file_id(conflict[2])
3155
if len(conflict) == 3:
3156
yield conflicts.Conflict.factory(
3157
c_type, action=action, path=modified_path, file_id=modified_id)
3160
conflicting_path = fp.get_path(conflict[3])
3161
conflicting_id = tt.final_file_id(conflict[3])
3162
yield conflicts.Conflict.factory(
3163
c_type, action=action, path=modified_path,
3164
file_id=modified_id,
3165
conflict_path=conflicting_path,
3166
conflict_file_id=conflicting_id)
3169
class _FileMover(object):
3170
"""Moves and deletes files for TreeTransform, tracking operations"""
3173
self.past_renames = []
3174
self.pending_deletions = []
3176
def rename(self, from_, to):
3177
"""Rename a file from one path to another."""
3179
os.rename(from_, to)
3181
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3182
raise errors.FileExists(to, str(e))
3183
# normal OSError doesn't include filenames so it's hard to see where
3184
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3185
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3186
self.past_renames.append((from_, to))
3188
def pre_delete(self, from_, to):
3189
"""Rename a file out of the way and mark it for deletion.
3191
Unlike os.unlink, this works equally well for files and directories.
3192
:param from_: The current file path
3193
:param to: A temporary path for the file
3195
self.rename(from_, to)
3196
self.pending_deletions.append(to)
3199
"""Reverse all renames that have been performed"""
3200
for from_, to in reversed(self.past_renames):
3202
os.rename(to, from_)
3204
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3205
# after rollback, don't reuse _FileMover
3207
pending_deletions = None
3209
def apply_deletions(self):
3210
"""Apply all marked deletions"""
3211
for path in self.pending_deletions:
3213
# after apply_deletions, don't reuse _FileMover
3215
pending_deletions = None
added
removed
bzrlib/transform.py
