1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from stat import S_ISREG, S_IEXEC
25
config as _mod_config,
32
lazy_import.lazy_import(globals(), """
43
revision as _mod_revision,
47
from breezy.bzr import (
51
from breezy.i18n import gettext
53
from .errors import (DuplicateKey, MalformedTransform,
54
ReusingTransform, CantMoveRoot,
55
ImmortalLimbo, NoFinalPath,
57
from .filters import filtered_output_bytes, ContentFilterContext
58
from .mutabletree import MutableTree
59
from .osutils import (
67
from .progress import ProgressPhase
77
ROOT_PARENT = "root-parent"
79
def unique_add(map, key, value):
81
raise DuplicateKey(key=key)
86
class _TransformResults(object):
87
def __init__(self, modified_paths, rename_count):
89
self.modified_paths = modified_paths
90
self.rename_count = rename_count
93
class TreeTransformBase(object):
94
"""The base class for TreeTransform and its kin."""
96
def __init__(self, tree, pb=None, case_sensitive=True):
99
:param tree: The tree that will be transformed, but not necessarily
102
:param case_sensitive: If True, the target of the transform is
103
case sensitive, not just case preserving.
105
object.__init__(self)
108
# mapping of trans_id -> new basename
110
# mapping of trans_id -> new parent trans_id
111
self._new_parent = {}
112
# mapping of trans_id with new contents -> new file_kind
113
self._new_contents = {}
114
# mapping of trans_id => (sha1 of content, stat_value)
115
self._observed_sha1s = {}
116
# Set of trans_ids whose contents will be removed
117
self._removed_contents = set()
118
# Mapping of trans_id -> new execute-bit value
119
self._new_executability = {}
120
# Mapping of trans_id -> new tree-reference value
121
self._new_reference_revision = {}
122
# Mapping of trans_id -> new file_id
124
# Mapping of old file-id -> trans_id
125
self._non_present_ids = {}
126
# Mapping of new file_id -> trans_id
128
# Set of trans_ids that will be removed
129
self._removed_id = set()
130
# Mapping of path in old tree -> trans_id
131
self._tree_path_ids = {}
132
# Mapping trans_id -> path in old tree
133
self._tree_id_paths = {}
134
# The trans_id that will be used as the tree root
135
if tree.is_versioned(''):
136
self._new_root = self.trans_id_tree_path('')
138
self._new_root = None
139
# Indicator of whether the transform has been applied
143
# Whether the target is case sensitive
144
self._case_sensitive_target = case_sensitive
145
# A counter of how many files have been renamed
146
self.rename_count = 0
149
"""Support Context Manager API."""
152
def __exit__(self, exc_type, exc_val, exc_tb):
153
"""Support Context Manager API."""
157
"""Release the working tree lock, if held.
159
This is required if apply has not been invoked, but can be invoked
162
if self._tree is None:
164
for hook in MutableTree.hooks['post_transform']:
165
hook(self._tree, self)
169
def __get_root(self):
170
return self._new_root
172
root = property(__get_root)
174
def _assign_id(self):
175
"""Produce a new tranform id"""
176
new_id = "new-%s" % self._id_number
180
def create_path(self, name, parent):
181
"""Assign a transaction id to a new path"""
182
trans_id = self._assign_id()
183
unique_add(self._new_name, trans_id, name)
184
unique_add(self._new_parent, trans_id, parent)
187
def adjust_path(self, name, parent, trans_id):
188
"""Change the path that is assigned to a transaction id."""
190
raise ValueError("Parent trans-id may not be None")
191
if trans_id == self._new_root:
193
self._new_name[trans_id] = name
194
self._new_parent[trans_id] = parent
196
def adjust_root_path(self, name, parent):
197
"""Emulate moving the root by moving all children, instead.
199
We do this by undoing the association of root's transaction id with the
200
current tree. This allows us to create a new directory with that
201
transaction id. We unversion the root directory and version the
202
physically new directory, and hope someone versions the tree root
205
old_root = self._new_root
206
old_root_file_id = self.final_file_id(old_root)
207
# force moving all children of root
208
for child_id in self.iter_tree_children(old_root):
209
if child_id != parent:
210
self.adjust_path(self.final_name(child_id),
211
self.final_parent(child_id), child_id)
212
file_id = self.final_file_id(child_id)
213
if file_id is not None:
214
self.unversion_file(child_id)
215
self.version_file(file_id, child_id)
217
# the physical root needs a new transaction id
218
self._tree_path_ids.pop("")
219
self._tree_id_paths.pop(old_root)
220
self._new_root = self.trans_id_tree_path('')
221
if parent == old_root:
222
parent = self._new_root
223
self.adjust_path(name, parent, old_root)
224
self.create_directory(old_root)
225
self.version_file(old_root_file_id, old_root)
226
self.unversion_file(self._new_root)
228
def fixup_new_roots(self):
229
"""Reinterpret requests to change the root directory
231
Instead of creating a root directory, or moving an existing directory,
232
all the attributes and children of the new root are applied to the
233
existing root directory.
235
This means that the old root trans-id becomes obsolete, so it is
236
recommended only to invoke this after the root trans-id has become
240
new_roots = [k for k, v in viewitems(self._new_parent)
242
if len(new_roots) < 1:
244
if len(new_roots) != 1:
245
raise ValueError('A tree cannot have two roots!')
246
if self._new_root is None:
247
self._new_root = new_roots[0]
249
old_new_root = new_roots[0]
250
# unversion the new root's directory.
251
if self.final_kind(self._new_root) is None:
252
file_id = self.final_file_id(old_new_root)
254
file_id = self.final_file_id(self._new_root)
255
if old_new_root in self._new_id:
256
self.cancel_versioning(old_new_root)
258
self.unversion_file(old_new_root)
259
# if, at this stage, root still has an old file_id, zap it so we can
260
# stick a new one in.
261
if (self.tree_file_id(self._new_root) is not None and
262
self._new_root not in self._removed_id):
263
self.unversion_file(self._new_root)
264
if file_id is not None:
265
self.version_file(file_id, self._new_root)
267
# Now move children of new root into old root directory.
268
# Ensure all children are registered with the transaction, but don't
269
# use directly-- some tree children have new parents
270
list(self.iter_tree_children(old_new_root))
271
# Move all children of new root into old root directory.
272
for child in self.by_parent().get(old_new_root, []):
273
self.adjust_path(self.final_name(child), self._new_root, child)
275
# Ensure old_new_root has no directory.
276
if old_new_root in self._new_contents:
277
self.cancel_creation(old_new_root)
279
self.delete_contents(old_new_root)
281
# prevent deletion of root directory.
282
if self._new_root in self._removed_contents:
283
self.cancel_deletion(self._new_root)
285
# destroy path info for old_new_root.
286
del self._new_parent[old_new_root]
287
del self._new_name[old_new_root]
289
def trans_id_file_id(self, file_id):
290
"""Determine or set the transaction id associated with a file ID.
291
A new id is only created for file_ids that were never present. If
292
a transaction has been unversioned, it is deliberately still returned.
293
(this will likely lead to an unversioned parent conflict.)
296
raise ValueError('None is not a valid file id')
297
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
298
return self._r_new_id[file_id]
301
path = self._tree.id2path(file_id)
302
except errors.NoSuchId:
303
if file_id in self._non_present_ids:
304
return self._non_present_ids[file_id]
306
trans_id = self._assign_id()
307
self._non_present_ids[file_id] = trans_id
310
return self.trans_id_tree_path(path)
312
def trans_id_tree_path(self, path):
313
"""Determine (and maybe set) the transaction ID for a tree path."""
314
path = self.canonical_path(path)
315
if path not in self._tree_path_ids:
316
self._tree_path_ids[path] = self._assign_id()
317
self._tree_id_paths[self._tree_path_ids[path]] = path
318
return self._tree_path_ids[path]
320
def get_tree_parent(self, trans_id):
321
"""Determine id of the parent in the tree."""
322
path = self._tree_id_paths[trans_id]
325
return self.trans_id_tree_path(os.path.dirname(path))
327
def delete_contents(self, trans_id):
328
"""Schedule the contents of a path entry for deletion"""
329
kind = self.tree_kind(trans_id)
331
self._removed_contents.add(trans_id)
333
def cancel_deletion(self, trans_id):
334
"""Cancel a scheduled deletion"""
335
self._removed_contents.remove(trans_id)
337
def unversion_file(self, trans_id):
338
"""Schedule a path entry to become unversioned"""
339
self._removed_id.add(trans_id)
341
def delete_versioned(self, trans_id):
342
"""Delete and unversion a versioned file"""
343
self.delete_contents(trans_id)
344
self.unversion_file(trans_id)
346
def set_executability(self, executability, trans_id):
347
"""Schedule setting of the 'execute' bit
348
To unschedule, set to None
350
if executability is None:
351
del self._new_executability[trans_id]
353
unique_add(self._new_executability, trans_id, executability)
355
def set_tree_reference(self, revision_id, trans_id):
356
"""Set the reference associated with a directory"""
357
unique_add(self._new_reference_revision, trans_id, revision_id)
359
def version_file(self, file_id, trans_id):
360
"""Schedule a file to become versioned."""
363
unique_add(self._new_id, trans_id, file_id)
364
unique_add(self._r_new_id, file_id, trans_id)
366
def cancel_versioning(self, trans_id):
367
"""Undo a previous versioning of a file"""
368
file_id = self._new_id[trans_id]
369
del self._new_id[trans_id]
370
del self._r_new_id[file_id]
372
def new_paths(self, filesystem_only=False):
373
"""Determine the paths of all new and changed files.
375
:param filesystem_only: if True, only calculate values for files
376
that require renames or execute bit changes.
380
stale_ids = self._needs_rename.difference(self._new_name)
381
stale_ids.difference_update(self._new_parent)
382
stale_ids.difference_update(self._new_contents)
383
stale_ids.difference_update(self._new_id)
384
needs_rename = self._needs_rename.difference(stale_ids)
385
id_sets = (needs_rename, self._new_executability)
387
id_sets = (self._new_name, self._new_parent, self._new_contents,
388
self._new_id, self._new_executability)
389
for id_set in id_sets:
390
new_ids.update(id_set)
391
return sorted(FinalPaths(self).get_paths(new_ids))
393
def _inventory_altered(self):
394
"""Determine which trans_ids need new Inventory entries.
396
An new entry is needed when anything that would be reflected by an
397
inventory entry changes, including file name, file_id, parent file_id,
398
file kind, and the execute bit.
400
Some care is taken to return entries with real changes, not cases
401
where the value is deleted and then restored to its original value,
402
but some actually unchanged values may be returned.
404
:returns: A list of (path, trans_id) for all items requiring an
405
inventory change. Ordered by path.
408
# Find entries whose file_ids are new (or changed).
409
new_file_id = set(t for t in self._new_id
410
if self._new_id[t] != self.tree_file_id(t))
411
for id_set in [self._new_name, self._new_parent, new_file_id,
412
self._new_executability]:
413
changed_ids.update(id_set)
414
# removing implies a kind change
415
changed_kind = set(self._removed_contents)
417
changed_kind.intersection_update(self._new_contents)
418
# Ignore entries that are already known to have changed.
419
changed_kind.difference_update(changed_ids)
420
# to keep only the truly changed ones
421
changed_kind = (t for t in changed_kind
422
if self.tree_kind(t) != self.final_kind(t))
423
# all kind changes will alter the inventory
424
changed_ids.update(changed_kind)
425
# To find entries with changed parent_ids, find parents which existed,
426
# but changed file_id.
427
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
428
# Now add all their children to the set.
429
for parent_trans_id in new_file_id:
430
changed_ids.update(self.iter_tree_children(parent_trans_id))
431
return sorted(FinalPaths(self).get_paths(changed_ids))
433
def final_kind(self, trans_id):
434
"""Determine the final file kind, after any changes applied.
436
:return: None if the file does not exist/has no contents. (It is
437
conceivable that a path would be created without the corresponding
438
contents insertion command)
440
if trans_id in self._new_contents:
441
return self._new_contents[trans_id]
442
elif trans_id in self._removed_contents:
445
return self.tree_kind(trans_id)
447
def tree_path(self, trans_id):
448
"""Determine the tree path associated with the trans_id."""
449
return self._tree_id_paths.get(trans_id)
451
def tree_file_id(self, trans_id):
452
"""Determine the file id associated with the trans_id in the tree"""
453
path = self.tree_path(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 viewitems(self._non_present_ids):
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(viewitems(self._new_parent))
513
items.extend((t, self.final_parent(t))
514
for t in list(self._tree_id_paths))
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 = list(self.by_parent())
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
path = self.tree_path(trans_id)
564
if self._tree.stored_kind(path) == '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
def _has_named_child(self, name, parent_id, known_children):
574
"""Does a parent already have a name child.
576
:param name: The searched for name.
578
:param parent_id: The parent for which the check is made.
580
:param known_children: The already known children. This should have
581
been recently obtained from `self.by_parent.get(parent_id)`
582
(or will be if None is passed).
584
if known_children is None:
585
known_children = self.by_parent().get(parent_id, [])
586
for child in known_children:
587
if self.final_name(child) == name:
589
parent_path = self._tree_id_paths.get(parent_id, None)
590
if parent_path is None:
591
# No parent... no children
593
child_path = joinpath(parent_path, name)
594
child_id = self._tree_path_ids.get(child_path, None)
596
# Not known by the tree transform yet, check the filesystem
597
return osutils.lexists(self._tree.abspath(child_path))
599
raise AssertionError('child_id is missing: %s, %s, %s'
600
% (name, parent_id, child_id))
602
def _available_backup_name(self, name, target_id):
603
"""Find an available backup name.
605
:param name: The basename of the file.
607
:param target_id: The directory trans_id where the backup should
610
known_children = self.by_parent().get(target_id, [])
611
return osutils.available_backup_name(
613
lambda base: self._has_named_child(
614
base, target_id, known_children))
616
def _parent_loops(self):
617
"""No entry should be its own ancestor"""
619
for trans_id in self._new_parent:
622
while parent_id != ROOT_PARENT:
625
parent_id = self.final_parent(parent_id)
628
if parent_id == trans_id:
629
conflicts.append(('parent loop', trans_id))
630
if parent_id in seen:
634
def _unversioned_parents(self, by_parent):
635
"""If parent directories are versioned, children must be versioned."""
637
for parent_id, children in viewitems(by_parent):
638
if parent_id == ROOT_PARENT:
640
if self.final_file_id(parent_id) is not None:
642
for child_id in children:
643
if self.final_file_id(child_id) is not None:
644
conflicts.append(('unversioned parent', parent_id))
648
def _improper_versioning(self):
649
"""Cannot version a file with no contents, or a bad type.
651
However, existing entries with no contents are okay.
654
for trans_id in self._new_id:
655
kind = self.final_kind(trans_id)
657
conflicts.append(('versioning no contents', trans_id))
659
if not self._tree.versionable_kind(kind):
660
conflicts.append(('versioning bad kind', trans_id, kind))
663
def _executability_conflicts(self):
664
"""Check for bad executability changes.
666
Only versioned files may have their executability set, because
667
1. only versioned entries can have executability under windows
668
2. only files can be executable. (The execute bit on a directory
669
does not indicate searchability)
672
for trans_id in self._new_executability:
673
if self.final_file_id(trans_id) is None:
674
conflicts.append(('unversioned executability', trans_id))
676
if self.final_kind(trans_id) != "file":
677
conflicts.append(('non-file executability', trans_id))
680
def _overwrite_conflicts(self):
681
"""Check for overwrites (not permitted on Win32)"""
683
for trans_id in self._new_contents:
684
if self.tree_kind(trans_id) is None:
686
if trans_id not in self._removed_contents:
687
conflicts.append(('overwrite', trans_id,
688
self.final_name(trans_id)))
691
def _duplicate_entries(self, by_parent):
692
"""No directory may have two entries with the same name."""
694
if (self._new_name, self._new_parent) == ({}, {}):
696
for children in viewvalues(by_parent):
698
for child_tid in children:
699
name = self.final_name(child_tid)
701
# Keep children only if they still exist in the end
702
if not self._case_sensitive_target:
704
name_ids.append((name, child_tid))
708
for name, trans_id in name_ids:
709
kind = self.final_kind(trans_id)
710
file_id = self.final_file_id(trans_id)
711
if kind is None and file_id is None:
713
if name == last_name:
714
conflicts.append(('duplicate', last_trans_id, trans_id,
717
last_trans_id = trans_id
720
def _duplicate_ids(self):
721
"""Each inventory id may only be used once"""
723
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
725
all_ids = self._tree.all_file_ids()
726
active_tree_ids = all_ids.difference(removed_tree_ids)
727
for trans_id, file_id in viewitems(self._new_id):
728
if file_id in active_tree_ids:
729
path = self._tree.id2path(file_id)
730
old_trans_id = self.trans_id_tree_path(path)
731
conflicts.append(('duplicate id', old_trans_id, trans_id))
734
def _parent_type_conflicts(self, by_parent):
735
"""Children must have a directory parent"""
737
for parent_id, children in viewitems(by_parent):
738
if parent_id == ROOT_PARENT:
741
for child_id in children:
742
if self.final_kind(child_id) is not None:
747
# There is at least a child, so we need an existing directory to
749
kind = self.final_kind(parent_id)
751
# The directory will be deleted
752
conflicts.append(('missing parent', parent_id))
753
elif kind != "directory":
754
# Meh, we need a *directory* to put something in it
755
conflicts.append(('non-directory parent', parent_id))
758
def _set_executability(self, path, trans_id):
759
"""Set the executability of versioned files """
760
if self._tree._supports_executable():
761
new_executability = self._new_executability[trans_id]
762
abspath = self._tree.abspath(path)
763
current_mode = os.stat(abspath).st_mode
764
if new_executability:
767
to_mode = current_mode | (0o100 & ~umask)
768
# Enable x-bit for others only if they can read it.
769
if current_mode & 0o004:
770
to_mode |= 0o001 & ~umask
771
if current_mode & 0o040:
772
to_mode |= 0o010 & ~umask
774
to_mode = current_mode & ~0o111
775
osutils.chmod_if_possible(abspath, to_mode)
777
def _new_entry(self, name, parent_id, file_id):
778
"""Helper function to create a new filesystem entry."""
779
trans_id = self.create_path(name, parent_id)
780
if file_id is not None:
781
self.version_file(file_id, trans_id)
784
def new_file(self, name, parent_id, contents, file_id=None,
785
executable=None, sha1=None):
786
"""Convenience method to create files.
788
name is the name of the file to create.
789
parent_id is the transaction id of the parent directory of the file.
790
contents is an iterator of bytestrings, which will be used to produce
792
:param file_id: The inventory ID of the file, if it is to be versioned.
793
:param executable: Only valid when a file_id has been supplied.
795
trans_id = self._new_entry(name, parent_id, file_id)
796
# TODO: rather than scheduling a set_executable call,
797
# have create_file create the file with the right mode.
798
self.create_file(contents, trans_id, sha1=sha1)
799
if executable is not None:
800
self.set_executability(executable, trans_id)
803
def new_directory(self, name, parent_id, file_id=None):
804
"""Convenience method to create directories.
806
name is the name of the directory to create.
807
parent_id is the transaction id of the parent directory of the
809
file_id is the inventory ID of the directory, if it is to be versioned.
811
trans_id = self._new_entry(name, parent_id, file_id)
812
self.create_directory(trans_id)
815
def new_symlink(self, name, parent_id, target, file_id=None):
816
"""Convenience method to create symbolic link.
818
name is the name of the symlink to create.
819
parent_id is the transaction id of the parent directory of the symlink.
820
target is a bytestring of the target of the symlink.
821
file_id is the inventory ID of the file, if it is to be versioned.
823
trans_id = self._new_entry(name, parent_id, file_id)
824
self.create_symlink(target, trans_id)
827
def new_orphan(self, trans_id, parent_id):
828
"""Schedule an item to be orphaned.
830
When a directory is about to be removed, its children, if they are not
831
versioned are moved out of the way: they don't have a parent anymore.
833
:param trans_id: The trans_id of the existing item.
834
:param parent_id: The parent trans_id of the item.
836
raise NotImplementedError(self.new_orphan)
838
def _get_potential_orphans(self, dir_id):
839
"""Find the potential orphans in a directory.
841
A directory can't be safely deleted if there are versioned files in it.
842
If all the contained files are unversioned then they can be orphaned.
844
The 'None' return value means that the directory contains at least one
845
versioned file and should not be deleted.
847
:param dir_id: The directory trans id.
849
:return: A list of the orphan trans ids or None if at least one
850
versioned file is present.
853
# Find the potential orphans, stop if one item should be kept
854
for child_tid in self.by_parent()[dir_id]:
855
if child_tid in self._removed_contents:
856
# The child is removed as part of the transform. Since it was
857
# versioned before, it's not an orphan
859
elif self.final_file_id(child_tid) is None:
860
# The child is not versioned
861
orphans.append(child_tid)
863
# We have a versioned file here, searching for orphans is
869
def _affected_ids(self):
870
"""Return the set of transform ids affected by the transform"""
871
trans_ids = set(self._removed_id)
872
trans_ids.update(self._new_id)
873
trans_ids.update(self._removed_contents)
874
trans_ids.update(self._new_contents)
875
trans_ids.update(self._new_executability)
876
trans_ids.update(self._new_name)
877
trans_ids.update(self._new_parent)
880
def _get_file_id_maps(self):
881
"""Return mapping of file_ids to trans_ids in the to and from states"""
882
trans_ids = self._affected_ids()
885
# Build up two dicts: trans_ids associated with file ids in the
886
# FROM state, vs the TO state.
887
for trans_id in trans_ids:
888
from_file_id = self.tree_file_id(trans_id)
889
if from_file_id is not None:
890
from_trans_ids[from_file_id] = trans_id
891
to_file_id = self.final_file_id(trans_id)
892
if to_file_id is not None:
893
to_trans_ids[to_file_id] = trans_id
894
return from_trans_ids, to_trans_ids
896
def _from_file_data(self, from_trans_id, from_versioned, from_path):
897
"""Get data about a file in the from (tree) state
899
Return a (name, parent, kind, executable) tuple
901
from_path = self._tree_id_paths.get(from_trans_id)
903
# get data from working tree if versioned
904
from_entry = next(self._tree.iter_entries_by_dir(
905
specific_files=[from_path]))[1]
906
from_name = from_entry.name
907
from_parent = from_entry.parent_id
910
if from_path is None:
911
# File does not exist in FROM state
915
# File exists, but is not versioned. Have to use path-
917
from_name = os.path.basename(from_path)
918
tree_parent = self.get_tree_parent(from_trans_id)
919
from_parent = self.tree_file_id(tree_parent)
920
if from_path is not None:
921
from_kind, from_executable, from_stats = \
922
self._tree._comparison_data(from_entry, from_path)
925
from_executable = False
926
return from_name, from_parent, from_kind, from_executable
928
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
929
"""Get data about a file in the to (target) state
931
Return a (name, parent, kind, executable) tuple
933
to_name = self.final_name(to_trans_id)
934
to_kind = self.final_kind(to_trans_id)
935
to_parent = self.final_file_id(self.final_parent(to_trans_id))
936
if to_trans_id in self._new_executability:
937
to_executable = self._new_executability[to_trans_id]
938
elif to_trans_id == from_trans_id:
939
to_executable = from_executable
941
to_executable = False
942
return to_name, to_parent, to_kind, to_executable
944
def iter_changes(self):
945
"""Produce output in the same format as Tree.iter_changes.
947
Will produce nonsensical results if invoked while inventory/filesystem
948
conflicts (as reported by TreeTransform.find_conflicts()) are present.
950
This reads the Transform, but only reproduces changes involving a
951
file_id. Files that are not versioned in either of the FROM or TO
952
states are not reflected.
954
final_paths = FinalPaths(self)
955
from_trans_ids, to_trans_ids = self._get_file_id_maps()
957
# Now iterate through all active file_ids
958
for file_id in set(from_trans_ids).union(to_trans_ids):
960
from_trans_id = from_trans_ids.get(file_id)
961
# find file ids, and determine versioning state
962
if from_trans_id is None:
963
from_versioned = False
964
from_trans_id = to_trans_ids[file_id]
966
from_versioned = True
967
to_trans_id = to_trans_ids.get(file_id)
968
if to_trans_id is None:
970
to_trans_id = from_trans_id
974
if not from_versioned:
977
from_path = self._tree_id_paths.get(from_trans_id)
981
to_path = final_paths.get_path(to_trans_id)
983
from_name, from_parent, from_kind, from_executable = \
984
self._from_file_data(from_trans_id, from_versioned, from_path)
986
to_name, to_parent, to_kind, to_executable = \
987
self._to_file_data(to_trans_id, from_trans_id, from_executable)
989
if from_kind != to_kind:
991
elif to_kind in ('file', 'symlink') and (
992
to_trans_id != from_trans_id or
993
to_trans_id in self._new_contents):
995
if (not modified and from_versioned == to_versioned and
996
from_parent==to_parent and from_name == to_name and
997
from_executable == to_executable):
999
results.append((file_id, (from_path, to_path), modified,
1000
(from_versioned, to_versioned),
1001
(from_parent, to_parent),
1002
(from_name, to_name),
1003
(from_kind, to_kind),
1004
(from_executable, to_executable)))
1005
return iter(sorted(results, key=lambda x:x[1]))
1007
def get_preview_tree(self):
1008
"""Return a tree representing the result of the transform.
1010
The tree is a snapshot, and altering the TreeTransform will invalidate
1013
return _PreviewTree(self)
1015
def commit(self, branch, message, merge_parents=None, strict=False,
1016
timestamp=None, timezone=None, committer=None, authors=None,
1017
revprops=None, revision_id=None):
1018
"""Commit the result of this TreeTransform to a branch.
1020
:param branch: The branch to commit to.
1021
:param message: The message to attach to the commit.
1022
:param merge_parents: Additional parent revision-ids specified by
1024
:param strict: If True, abort the commit if there are unversioned
1026
:param timestamp: if not None, seconds-since-epoch for the time and
1027
date. (May be a float.)
1028
:param timezone: Optional timezone for timestamp, as an offset in
1030
:param committer: Optional committer in email-id format.
1031
(e.g. "J Random Hacker <jrandom@example.com>")
1032
:param authors: Optional list of authors in email-id format.
1033
:param revprops: Optional dictionary of revision properties.
1034
:param revision_id: Optional revision id. (Specifying a revision-id
1035
may reduce performance for some non-native formats.)
1036
:return: The revision_id of the revision committed.
1038
self._check_malformed()
1040
unversioned = set(self._new_contents).difference(set(self._new_id))
1041
for trans_id in unversioned:
1042
if self.final_file_id(trans_id) is None:
1043
raise errors.StrictCommitFailed()
1045
revno, last_rev_id = branch.last_revision_info()
1046
if last_rev_id == _mod_revision.NULL_REVISION:
1047
if merge_parents is not None:
1048
raise ValueError('Cannot supply merge parents for first'
1052
parent_ids = [last_rev_id]
1053
if merge_parents is not None:
1054
parent_ids.extend(merge_parents)
1055
if self._tree.get_revision_id() != last_rev_id:
1056
raise ValueError('TreeTransform not based on branch basis: %s' %
1057
self._tree.get_revision_id())
1058
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1059
builder = branch.get_commit_builder(parent_ids,
1060
timestamp=timestamp,
1062
committer=committer,
1064
revision_id=revision_id)
1065
preview = self.get_preview_tree()
1066
list(builder.record_iter_changes(preview, last_rev_id,
1067
self.iter_changes()))
1068
builder.finish_inventory()
1069
revision_id = builder.commit(message)
1070
branch.set_last_revision_info(revno + 1, revision_id)
1073
def _text_parent(self, trans_id):
1074
path = self.tree_path(trans_id)
1076
if path is None or self._tree.kind(path) != 'file':
1078
except errors.NoSuchFile:
1082
def _get_parents_texts(self, trans_id):
1083
"""Get texts for compression parents of this file."""
1084
path = self._text_parent(trans_id)
1087
return (self._tree.get_file_text(path),)
1089
def _get_parents_lines(self, trans_id):
1090
"""Get lines for compression parents of this file."""
1091
path = self._text_parent(trans_id)
1094
return (self._tree.get_file_lines(path),)
1096
def serialize(self, serializer):
1097
"""Serialize this TreeTransform.
1099
:param serializer: A Serialiser like pack.ContainerSerializer.
1101
new_name = dict((k, v.encode('utf-8')) for k, v in
1102
viewitems(self._new_name))
1103
new_executability = dict((k, int(v)) for k, v in
1104
viewitems(self._new_executability))
1105
tree_path_ids = dict((k.encode('utf-8'), v)
1106
for k, v in viewitems(self._tree_path_ids))
1108
'_id_number': self._id_number,
1109
'_new_name': new_name,
1110
'_new_parent': self._new_parent,
1111
'_new_executability': new_executability,
1112
'_new_id': self._new_id,
1113
'_tree_path_ids': tree_path_ids,
1114
'_removed_id': list(self._removed_id),
1115
'_removed_contents': list(self._removed_contents),
1116
'_non_present_ids': self._non_present_ids,
1118
yield serializer.bytes_record(bencode.bencode(attribs),
1120
for trans_id, kind in viewitems(self._new_contents):
1122
with open(self._limbo_name(trans_id), 'rb') as cur_file:
1123
lines = cur_file.readlines()
1124
parents = self._get_parents_lines(trans_id)
1125
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1126
content = b''.join(mpdiff.to_patch())
1127
if kind == 'directory':
1129
if kind == 'symlink':
1130
content = self._read_symlink_target(trans_id)
1131
yield serializer.bytes_record(content, ((trans_id, kind),))
1133
def deserialize(self, records):
1134
"""Deserialize a stored TreeTransform.
1136
:param records: An iterable of (names, content) tuples, as per
1137
pack.ContainerPushParser.
1139
names, content = next(records)
1140
attribs = bencode.bdecode(content)
1141
self._id_number = attribs['_id_number']
1142
self._new_name = dict((k, v.decode('utf-8'))
1143
for k, v in viewitems(attribs['_new_name']))
1144
self._new_parent = attribs['_new_parent']
1145
self._new_executability = dict((k, bool(v))
1146
for k, v in viewitems(attribs['_new_executability']))
1147
self._new_id = attribs['_new_id']
1148
self._r_new_id = dict((v, k) for k, v in viewitems(self._new_id))
1149
self._tree_path_ids = {}
1150
self._tree_id_paths = {}
1151
for bytepath, trans_id in viewitems(attribs['_tree_path_ids']):
1152
path = bytepath.decode('utf-8')
1153
self._tree_path_ids[path] = trans_id
1154
self._tree_id_paths[trans_id] = path
1155
self._removed_id = set(attribs['_removed_id'])
1156
self._removed_contents = set(attribs['_removed_contents'])
1157
self._non_present_ids = attribs['_non_present_ids']
1158
for ((trans_id, kind),), content in records:
1160
mpdiff = multiparent.MultiParent.from_patch(content)
1161
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1162
self.create_file(lines, trans_id)
1163
if kind == 'directory':
1164
self.create_directory(trans_id)
1165
if kind == 'symlink':
1166
self.create_symlink(content.decode('utf-8'), trans_id)
1169
class DiskTreeTransform(TreeTransformBase):
1170
"""Tree transform storing its contents on disk."""
1172
def __init__(self, tree, limbodir, pb=None,
1173
case_sensitive=True):
1175
:param tree: The tree that will be transformed, but not necessarily
1177
:param limbodir: A directory where new files can be stored until
1178
they are installed in their proper places
1180
:param case_sensitive: If True, the target of the transform is
1181
case sensitive, not just case preserving.
1183
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1184
self._limbodir = limbodir
1185
self._deletiondir = None
1186
# A mapping of transform ids to their limbo filename
1187
self._limbo_files = {}
1188
self._possibly_stale_limbo_files = set()
1189
# A mapping of transform ids to a set of the transform ids of children
1190
# that their limbo directory has
1191
self._limbo_children = {}
1192
# Map transform ids to maps of child filename to child transform id
1193
self._limbo_children_names = {}
1194
# List of transform ids that need to be renamed from limbo into place
1195
self._needs_rename = set()
1196
self._creation_mtime = None
1199
"""Release the working tree lock, if held, clean up limbo dir.
1201
This is required if apply has not been invoked, but can be invoked
1204
if self._tree is None:
1207
limbo_paths = list(viewvalues(self._limbo_files))
1208
limbo_paths.extend(self._possibly_stale_limbo_files)
1209
limbo_paths.sort(reverse=True)
1210
for path in limbo_paths:
1213
except OSError as e:
1214
if e.errno != errno.ENOENT:
1216
# XXX: warn? perhaps we just got interrupted at an
1217
# inconvenient moment, but perhaps files are disappearing
1220
delete_any(self._limbodir)
1222
# We don't especially care *why* the dir is immortal.
1223
raise ImmortalLimbo(self._limbodir)
1225
if self._deletiondir is not None:
1226
delete_any(self._deletiondir)
1228
raise errors.ImmortalPendingDeletion(self._deletiondir)
1230
TreeTransformBase.finalize(self)
1232
def _limbo_supports_executable(self):
1233
"""Check if the limbo path supports the executable bit."""
1234
# FIXME: Check actual file system capabilities of limbodir
1235
return osutils.supports_executable()
1237
def _limbo_name(self, trans_id):
1238
"""Generate the limbo name of a file"""
1239
limbo_name = self._limbo_files.get(trans_id)
1240
if limbo_name is None:
1241
limbo_name = self._generate_limbo_path(trans_id)
1242
self._limbo_files[trans_id] = limbo_name
1245
def _generate_limbo_path(self, trans_id):
1246
"""Generate a limbo path using the trans_id as the relative path.
1248
This is suitable as a fallback, and when the transform should not be
1249
sensitive to the path encoding of the limbo directory.
1251
self._needs_rename.add(trans_id)
1252
return pathjoin(self._limbodir, trans_id)
1254
def adjust_path(self, name, parent, trans_id):
1255
previous_parent = self._new_parent.get(trans_id)
1256
previous_name = self._new_name.get(trans_id)
1257
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1258
if (trans_id in self._limbo_files and
1259
trans_id not in self._needs_rename):
1260
self._rename_in_limbo([trans_id])
1261
if previous_parent != parent:
1262
self._limbo_children[previous_parent].remove(trans_id)
1263
if previous_parent != parent or previous_name != name:
1264
del self._limbo_children_names[previous_parent][previous_name]
1266
def _rename_in_limbo(self, trans_ids):
1267
"""Fix limbo names so that the right final path is produced.
1269
This means we outsmarted ourselves-- we tried to avoid renaming
1270
these files later by creating them with their final names in their
1271
final parents. But now the previous name or parent is no longer
1272
suitable, so we have to rename them.
1274
Even for trans_ids that have no new contents, we must remove their
1275
entries from _limbo_files, because they are now stale.
1277
for trans_id in trans_ids:
1278
old_path = self._limbo_files[trans_id]
1279
self._possibly_stale_limbo_files.add(old_path)
1280
del self._limbo_files[trans_id]
1281
if trans_id not in self._new_contents:
1283
new_path = self._limbo_name(trans_id)
1284
os.rename(old_path, new_path)
1285
self._possibly_stale_limbo_files.remove(old_path)
1286
for descendant in self._limbo_descendants(trans_id):
1287
desc_path = self._limbo_files[descendant]
1288
desc_path = new_path + desc_path[len(old_path):]
1289
self._limbo_files[descendant] = desc_path
1291
def _limbo_descendants(self, trans_id):
1292
"""Return the set of trans_ids whose limbo paths descend from this."""
1293
descendants = set(self._limbo_children.get(trans_id, []))
1294
for descendant in list(descendants):
1295
descendants.update(self._limbo_descendants(descendant))
1298
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1299
"""Schedule creation of a new file.
1303
:param contents: an iterator of strings, all of which will be written
1304
to the target destination.
1305
:param trans_id: TreeTransform handle
1306
:param mode_id: If not None, force the mode of the target file to match
1307
the mode of the object referenced by mode_id.
1308
Otherwise, we will try to preserve mode bits of an existing file.
1309
:param sha1: If the sha1 of this content is already known, pass it in.
1310
We can use it to prevent future sha1 computations.
1312
name = self._limbo_name(trans_id)
1313
with open(name, 'wb') as f:
1314
unique_add(self._new_contents, trans_id, 'file')
1315
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_symlink_target(self, trans_id):
1325
return os.readlink(self._limbo_name(trans_id))
1327
def _set_mtime(self, path):
1328
"""All files that are created get the same mtime.
1330
This time is set by the first object to be created.
1332
if self._creation_mtime is None:
1333
self._creation_mtime = time.time()
1334
os.utime(path, (self._creation_mtime, self._creation_mtime))
1336
def create_hardlink(self, path, trans_id):
1337
"""Schedule creation of a hard link"""
1338
name = self._limbo_name(trans_id)
1341
except OSError as e:
1342
if e.errno != errno.EPERM:
1344
raise errors.HardLinkNotSupported(path)
1346
unique_add(self._new_contents, trans_id, 'file')
1348
# Clean up the file, it never got registered so
1349
# TreeTransform.finalize() won't clean it up.
1353
def create_directory(self, trans_id):
1354
"""Schedule creation of a new directory.
1356
See also new_directory.
1358
os.mkdir(self._limbo_name(trans_id))
1359
unique_add(self._new_contents, trans_id, 'directory')
1361
def create_symlink(self, target, trans_id):
1362
"""Schedule creation of a new symbolic link.
1364
target is a bytestring.
1365
See also new_symlink.
1368
os.symlink(target, self._limbo_name(trans_id))
1369
unique_add(self._new_contents, trans_id, 'symlink')
1372
path = FinalPaths(self).get_path(trans_id)
1375
raise UnableCreateSymlink(path=path)
1377
def cancel_creation(self, trans_id):
1378
"""Cancel the creation of new file contents."""
1379
del self._new_contents[trans_id]
1380
if trans_id in self._observed_sha1s:
1381
del self._observed_sha1s[trans_id]
1382
children = self._limbo_children.get(trans_id)
1383
# if this is a limbo directory with children, move them before removing
1385
if children is not None:
1386
self._rename_in_limbo(children)
1387
del self._limbo_children[trans_id]
1388
del self._limbo_children_names[trans_id]
1389
delete_any(self._limbo_name(trans_id))
1391
def new_orphan(self, trans_id, parent_id):
1392
conf = self._tree.get_config_stack()
1393
handle_orphan = conf.get('transform.orphan_policy')
1394
handle_orphan(self, trans_id, parent_id)
1397
class OrphaningError(errors.BzrError):
1399
# Only bugs could lead to such exception being seen by the user
1400
internal_error = True
1401
_fmt = "Error while orphaning %s in %s directory"
1403
def __init__(self, orphan, parent):
1404
errors.BzrError.__init__(self)
1405
self.orphan = orphan
1406
self.parent = parent
1409
class OrphaningForbidden(OrphaningError):
1411
_fmt = "Policy: %s doesn't allow creating orphans."
1413
def __init__(self, policy):
1414
errors.BzrError.__init__(self)
1415
self.policy = policy
1418
def move_orphan(tt, orphan_id, parent_id):
1419
"""See TreeTransformBase.new_orphan.
1421
This creates a new orphan in the `brz-orphans` dir at the root of the
1424
:param tt: The TreeTransform orphaning `trans_id`.
1426
:param orphan_id: The trans id that should be orphaned.
1428
:param parent_id: The orphan parent trans id.
1430
# Add the orphan dir if it doesn't exist
1431
orphan_dir_basename = 'brz-orphans'
1432
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1433
if tt.final_kind(od_id) is None:
1434
tt.create_directory(od_id)
1435
parent_path = tt._tree_id_paths[parent_id]
1436
# Find a name that doesn't exist yet in the orphan dir
1437
actual_name = tt.final_name(orphan_id)
1438
new_name = tt._available_backup_name(actual_name, od_id)
1439
tt.adjust_path(new_name, od_id, orphan_id)
1440
trace.warning('%s has been orphaned in %s'
1441
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1444
def refuse_orphan(tt, orphan_id, parent_id):
1445
"""See TreeTransformBase.new_orphan.
1447
This refuses to create orphan, letting the caller handle the conflict.
1449
raise OrphaningForbidden('never')
1452
orphaning_registry = registry.Registry()
1453
orphaning_registry.register(
1454
'conflict', refuse_orphan,
1455
'Leave orphans in place and create a conflict on the directory.')
1456
orphaning_registry.register(
1457
'move', move_orphan,
1458
'Move orphans into the brz-orphans directory.')
1459
orphaning_registry._set_default_key('conflict')
1462
opt_transform_orphan = _mod_config.RegistryOption(
1463
'transform.orphan_policy', orphaning_registry,
1464
help='Policy for orphaned files during transform operations.',
1468
class TreeTransform(DiskTreeTransform):
1469
"""Represent a tree transformation.
1471
This object is designed to support incremental generation of the transform,
1474
However, it gives optimum performance when parent directories are created
1475
before their contents. The transform is then able to put child files
1476
directly in their parent directory, avoiding later renames.
1478
It is easy to produce malformed transforms, but they are generally
1479
harmless. Attempting to apply a malformed transform will cause an
1480
exception to be raised before any modifications are made to the tree.
1482
Many kinds of malformed transforms can be corrected with the
1483
resolve_conflicts function. The remaining ones indicate programming error,
1484
such as trying to create a file with no path.
1486
Two sets of file creation methods are supplied. Convenience methods are:
1491
These are composed of the low-level methods:
1493
* create_file or create_directory or create_symlink
1497
Transform/Transaction ids
1498
-------------------------
1499
trans_ids are temporary ids assigned to all files involved in a transform.
1500
It's possible, even common, that not all files in the Tree have trans_ids.
1502
trans_ids are used because filenames and file_ids are not good enough
1503
identifiers; filenames change, and not all files have file_ids. File-ids
1504
are also associated with trans-ids, so that moving a file moves its
1507
trans_ids are only valid for the TreeTransform that generated them.
1511
Limbo is a temporary directory use to hold new versions of files.
1512
Files are added to limbo by create_file, create_directory, create_symlink,
1513
and their convenience variants (new_*). Files may be removed from limbo
1514
using cancel_creation. Files are renamed from limbo into their final
1515
location as part of TreeTransform.apply
1517
Limbo must be cleaned up, by either calling TreeTransform.apply or
1518
calling TreeTransform.finalize.
1520
Files are placed into limbo inside their parent directories, where
1521
possible. This reduces subsequent renames, and makes operations involving
1522
lots of files faster. This optimization is only possible if the parent
1523
directory is created *before* creating any of its children, so avoid
1524
creating children before parents, where possible.
1528
This temporary directory is used by _FileMover for storing files that are
1529
about to be deleted. In case of rollback, the files will be restored.
1530
FileMover does not delete files until it is sure that a rollback will not
1533
def __init__(self, tree, pb=None):
1534
"""Note: a tree_write lock is taken on the tree.
1536
Use TreeTransform.finalize() to release the lock (can be omitted if
1537
TreeTransform.apply() called).
1539
tree.lock_tree_write()
1541
limbodir = urlutils.local_path_from_url(
1542
tree._transport.abspath('limbo'))
1543
osutils.ensure_empty_directory_exists(
1545
errors.ExistingLimbo)
1546
deletiondir = urlutils.local_path_from_url(
1547
tree._transport.abspath('pending-deletion'))
1548
osutils.ensure_empty_directory_exists(
1550
errors.ExistingPendingDeletion)
1555
# Cache of realpath results, to speed up canonical_path
1556
self._realpaths = {}
1557
# Cache of relpath results, to speed up canonical_path
1559
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1560
tree.case_sensitive)
1561
self._deletiondir = deletiondir
1563
def canonical_path(self, path):
1564
"""Get the canonical tree-relative path"""
1565
# don't follow final symlinks
1566
abs = self._tree.abspath(path)
1567
if abs in self._relpaths:
1568
return self._relpaths[abs]
1569
dirname, basename = os.path.split(abs)
1570
if dirname not in self._realpaths:
1571
self._realpaths[dirname] = os.path.realpath(dirname)
1572
dirname = self._realpaths[dirname]
1573
abs = pathjoin(dirname, basename)
1574
if dirname in self._relpaths:
1575
relpath = pathjoin(self._relpaths[dirname], basename)
1576
relpath = relpath.rstrip('/\\')
1578
relpath = self._tree.relpath(abs)
1579
self._relpaths[abs] = relpath
1582
def tree_kind(self, trans_id):
1583
"""Determine the file kind in the working tree.
1585
:returns: The file kind or None if the file does not exist
1587
path = self._tree_id_paths.get(trans_id)
1591
return file_kind(self._tree.abspath(path))
1592
except errors.NoSuchFile:
1595
def _set_mode(self, trans_id, mode_id, typefunc):
1596
"""Set the mode of new file contents.
1597
The mode_id is the existing file to get the mode from (often the same
1598
as trans_id). The operation is only performed if there's a mode match
1599
according to typefunc.
1604
old_path = self._tree_id_paths[mode_id]
1608
mode = os.stat(self._tree.abspath(old_path)).st_mode
1609
except OSError as e:
1610
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1611
# Either old_path doesn't exist, or the parent of the
1612
# target is not a directory (but will be one eventually)
1613
# Either way, we know it doesn't exist *right now*
1614
# See also bug #248448
1619
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1621
def iter_tree_children(self, parent_id):
1622
"""Iterate through the entry's tree children, if any"""
1624
path = self._tree_id_paths[parent_id]
1628
children = os.listdir(self._tree.abspath(path))
1629
except OSError as e:
1630
if not (osutils._is_error_enotdir(e)
1631
or e.errno in (errno.ENOENT, errno.ESRCH)):
1635
for child in children:
1636
childpath = joinpath(path, child)
1637
if self._tree.is_control_filename(childpath):
1639
yield self.trans_id_tree_path(childpath)
1641
def _generate_limbo_path(self, trans_id):
1642
"""Generate a limbo path using the final path if possible.
1644
This optimizes the performance of applying the tree transform by
1645
avoiding renames. These renames can be avoided only when the parent
1646
directory is already scheduled for creation.
1648
If the final path cannot be used, falls back to using the trans_id as
1651
parent = self._new_parent.get(trans_id)
1652
# if the parent directory is already in limbo (e.g. when building a
1653
# tree), choose a limbo name inside the parent, to reduce further
1655
use_direct_path = False
1656
if self._new_contents.get(parent) == 'directory':
1657
filename = self._new_name.get(trans_id)
1658
if filename is not None:
1659
if parent not in self._limbo_children:
1660
self._limbo_children[parent] = set()
1661
self._limbo_children_names[parent] = {}
1662
use_direct_path = True
1663
# the direct path can only be used if no other file has
1664
# already taken this pathname, i.e. if the name is unused, or
1665
# if it is already associated with this trans_id.
1666
elif self._case_sensitive_target:
1667
if (self._limbo_children_names[parent].get(filename)
1668
in (trans_id, None)):
1669
use_direct_path = True
1671
for l_filename, l_trans_id in viewitems(
1672
self._limbo_children_names[parent]):
1673
if l_trans_id == trans_id:
1675
if l_filename.lower() == filename.lower():
1678
use_direct_path = True
1680
if not use_direct_path:
1681
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1683
limbo_name = pathjoin(self._limbo_files[parent], filename)
1684
self._limbo_children[parent].add(trans_id)
1685
self._limbo_children_names[parent][filename] = trans_id
1689
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1690
"""Apply all changes to the inventory and filesystem.
1692
If filesystem or inventory conflicts are present, MalformedTransform
1695
If apply succeeds, finalize is not necessary.
1697
:param no_conflicts: if True, the caller guarantees there are no
1698
conflicts, so no check is made.
1699
:param precomputed_delta: An inventory delta to use instead of
1701
:param _mover: Supply an alternate FileMover, for testing
1703
for hook in MutableTree.hooks['pre_transform']:
1704
hook(self._tree, self)
1705
if not no_conflicts:
1706
self._check_malformed()
1707
with ui.ui_factory.nested_progress_bar() as child_pb:
1708
if precomputed_delta is None:
1709
child_pb.update(gettext('Apply phase'), 0, 2)
1710
inventory_delta = self._generate_inventory_delta()
1713
inventory_delta = precomputed_delta
1716
mover = _FileMover()
1720
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1721
self._apply_removals(mover)
1722
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1723
modified_paths = self._apply_insertions(mover)
1728
mover.apply_deletions()
1729
if self.final_file_id(self.root) is None:
1730
inventory_delta = [e for e in inventory_delta if e[0] != '']
1731
self._tree.apply_inventory_delta(inventory_delta)
1732
self._apply_observed_sha1s()
1735
return _TransformResults(modified_paths, self.rename_count)
1737
def _generate_inventory_delta(self):
1738
"""Generate an inventory delta for the current transform."""
1739
inventory_delta = []
1740
new_paths = self._inventory_altered()
1741
total_entries = len(new_paths) + len(self._removed_id)
1742
with ui.ui_factory.nested_progress_bar() as child_pb:
1743
for num, trans_id in enumerate(self._removed_id):
1745
child_pb.update(gettext('removing file'), num, total_entries)
1746
if trans_id == self._new_root:
1747
file_id = self._tree.get_root_id()
1749
file_id = self.tree_file_id(trans_id)
1750
# File-id isn't really being deleted, just moved
1751
if file_id in self._r_new_id:
1753
path = self._tree_id_paths[trans_id]
1754
inventory_delta.append((path, None, file_id, None))
1755
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1758
for num, (path, trans_id) in enumerate(new_paths):
1760
child_pb.update(gettext('adding file'),
1761
num + len(self._removed_id), total_entries)
1762
file_id = new_path_file_ids[trans_id]
1766
kind = self.final_kind(trans_id)
1768
kind = self._tree.stored_kind(
1769
self._tree.id2path(file_id), file_id)
1770
parent_trans_id = self.final_parent(trans_id)
1771
parent_file_id = new_path_file_ids.get(parent_trans_id)
1772
if parent_file_id is None:
1773
parent_file_id = self.final_file_id(parent_trans_id)
1774
if trans_id in self._new_reference_revision:
1775
new_entry = inventory.TreeReference(
1777
self._new_name[trans_id],
1778
self.final_file_id(self._new_parent[trans_id]),
1779
None, self._new_reference_revision[trans_id])
1781
new_entry = inventory.make_entry(kind,
1782
self.final_name(trans_id),
1783
parent_file_id, file_id)
1785
old_path = self._tree.id2path(new_entry.file_id)
1786
except errors.NoSuchId:
1788
new_executability = self._new_executability.get(trans_id)
1789
if new_executability is not None:
1790
new_entry.executable = new_executability
1791
inventory_delta.append(
1792
(old_path, path, new_entry.file_id, new_entry))
1793
return inventory_delta
1795
def _apply_removals(self, mover):
1796
"""Perform tree operations that remove directory/inventory names.
1798
That is, delete files that are to be deleted, and put any files that
1799
need renaming into limbo. This must be done in strict child-to-parent
1802
If inventory_delta is None, no inventory delta generation is performed.
1804
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1805
with ui.ui_factory.nested_progress_bar() as child_pb:
1806
for num, (path, trans_id) in enumerate(tree_paths):
1807
# do not attempt to move root into a subdirectory of itself.
1810
child_pb.update(gettext('removing file'), num, len(tree_paths))
1811
full_path = self._tree.abspath(path)
1812
if trans_id in self._removed_contents:
1813
delete_path = os.path.join(self._deletiondir, trans_id)
1814
mover.pre_delete(full_path, delete_path)
1815
elif (trans_id in self._new_name
1816
or trans_id in self._new_parent):
1818
mover.rename(full_path, self._limbo_name(trans_id))
1819
except errors.TransformRenameFailed as e:
1820
if e.errno != errno.ENOENT:
1823
self.rename_count += 1
1825
def _apply_insertions(self, mover):
1826
"""Perform tree operations that insert directory/inventory names.
1828
That is, create any files that need to be created, and restore from
1829
limbo any files that needed renaming. This must be done in strict
1830
parent-to-child order.
1832
If inventory_delta is None, no inventory delta is calculated, and
1833
no list of modified paths is returned.
1835
new_paths = self.new_paths(filesystem_only=True)
1837
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1839
with ui.ui_factory.nested_progress_bar() as child_pb:
1840
for num, (path, trans_id) in enumerate(new_paths):
1842
child_pb.update(gettext('adding file'), num, len(new_paths))
1843
full_path = self._tree.abspath(path)
1844
if trans_id in self._needs_rename:
1846
mover.rename(self._limbo_name(trans_id), full_path)
1847
except errors.TransformRenameFailed as e:
1848
# We may be renaming a dangling inventory id
1849
if e.errno != errno.ENOENT:
1852
self.rename_count += 1
1853
# TODO: if trans_id in self._observed_sha1s, we should
1854
# re-stat the final target, since ctime will be
1855
# updated by the change.
1856
if (trans_id in self._new_contents or
1857
self.path_changed(trans_id)):
1858
if trans_id in self._new_contents:
1859
modified_paths.append(full_path)
1860
if trans_id in self._new_executability:
1861
self._set_executability(path, trans_id)
1862
if trans_id in self._observed_sha1s:
1863
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1864
st = osutils.lstat(full_path)
1865
self._observed_sha1s[trans_id] = (o_sha1, st)
1866
for path, trans_id in new_paths:
1867
# new_paths includes stuff like workingtree conflicts. Only the
1868
# stuff in new_contents actually comes from limbo.
1869
if trans_id in self._limbo_files:
1870
del self._limbo_files[trans_id]
1871
self._new_contents.clear()
1872
return modified_paths
1874
def _apply_observed_sha1s(self):
1875
"""After we have finished renaming everything, update observed sha1s
1877
This has to be done after self._tree.apply_inventory_delta, otherwise
1878
it doesn't know anything about the files we are updating. Also, we want
1879
to do this as late as possible, so that most entries end up cached.
1881
# TODO: this doesn't update the stat information for directories. So
1882
# the first 'bzr status' will still need to rewrite
1883
# .bzr/checkout/dirstate. However, we at least don't need to
1884
# re-read all of the files.
1885
# TODO: If the operation took a while, we could do a time.sleep(3) here
1886
# to allow the clock to tick over and ensure we won't have any
1887
# problems. (we could observe start time, and finish time, and if
1888
# it is less than eg 10% overhead, add a sleep call.)
1889
paths = FinalPaths(self)
1890
for trans_id, observed in viewitems(self._observed_sha1s):
1891
path = paths.get_path(trans_id)
1892
# We could get the file_id, but dirstate prefers to use the path
1893
# anyway, and it is 'cheaper' to determine.
1894
# file_id = self._new_id[trans_id]
1895
self._tree._observed_sha1(None, path, observed)
1898
class TransformPreview(DiskTreeTransform):
1899
"""A TreeTransform for generating preview trees.
1901
Unlike TreeTransform, this version works when the input tree is a
1902
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1903
unversioned files in the input tree.
1906
def __init__(self, tree, pb=None, case_sensitive=True):
1908
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1909
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1911
def canonical_path(self, path):
1914
def tree_kind(self, trans_id):
1915
path = self._tree_id_paths.get(trans_id)
1918
kind = self._tree.path_content_summary(path)[0]
1919
if kind == 'missing':
1923
def _set_mode(self, trans_id, mode_id, typefunc):
1924
"""Set the mode of new file contents.
1925
The mode_id is the existing file to get the mode from (often the same
1926
as trans_id). The operation is only performed if there's a mode match
1927
according to typefunc.
1929
# is it ok to ignore this? probably
1932
def iter_tree_children(self, parent_id):
1933
"""Iterate through the entry's tree children, if any"""
1935
path = self._tree_id_paths[parent_id]
1938
entry = next(self._tree.iter_entries_by_dir(
1939
specific_files=[path]))[1]
1940
children = getattr(entry, 'children', {})
1941
for child in children:
1942
childpath = joinpath(path, child)
1943
yield self.trans_id_tree_path(childpath)
1945
def new_orphan(self, trans_id, parent_id):
1946
raise NotImplementedError(self.new_orphan)
1949
class _PreviewTree(inventorytree.InventoryTree):
1950
"""Partial implementation of Tree to support show_diff_trees"""
1952
def __init__(self, transform):
1953
self._transform = transform
1954
self._final_paths = FinalPaths(transform)
1955
self.__by_parent = None
1956
self._parent_ids = []
1957
self._all_children_cache = {}
1958
self._path2trans_id_cache = {}
1959
self._final_name_cache = {}
1960
self._iter_changes_cache = dict((c[0], c) for c in
1961
self._transform.iter_changes())
1963
def _content_change(self, file_id):
1964
"""Return True if the content of this file changed"""
1965
changes = self._iter_changes_cache.get(file_id)
1966
# changes[2] is true if the file content changed. See
1967
# InterTree.iter_changes.
1968
return (changes is not None and changes[2])
1970
def _get_repository(self):
1971
repo = getattr(self._transform._tree, '_repository', None)
1973
repo = self._transform._tree.branch.repository
1976
def _iter_parent_trees(self):
1977
for revision_id in self.get_parent_ids():
1979
yield self.revision_tree(revision_id)
1980
except errors.NoSuchRevisionInTree:
1981
yield self._get_repository().revision_tree(revision_id)
1983
def _get_file_revision(self, path, file_id, vf, tree_revision):
1985
(file_id, t.get_file_revision(t.id2path(file_id), file_id))
1986
for t in self._iter_parent_trees()]
1987
vf.add_lines((file_id, tree_revision), parent_keys,
1988
self.get_file_lines(path, file_id))
1989
repo = self._get_repository()
1990
base_vf = repo.texts
1991
if base_vf not in vf.fallback_versionedfiles:
1992
vf.fallback_versionedfiles.append(base_vf)
1993
return tree_revision
1995
def _stat_limbo_file(self, trans_id):
1996
name = self._transform._limbo_name(trans_id)
1997
return os.lstat(name)
2000
def _by_parent(self):
2001
if self.__by_parent is None:
2002
self.__by_parent = self._transform.by_parent()
2003
return self.__by_parent
2005
def _comparison_data(self, entry, path):
2006
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2007
if kind == 'missing':
2011
file_id = self._transform.final_file_id(self._path2trans_id(path))
2012
executable = self.is_executable(path, file_id)
2013
return kind, executable, None
2015
def is_locked(self):
2018
def lock_read(self):
2019
# Perhaps in theory, this should lock the TreeTransform?
2020
return lock.LogicalLockResult(self.unlock)
2026
def root_inventory(self):
2027
"""This Tree does not use inventory as its backing data."""
2028
raise NotImplementedError(_PreviewTree.root_inventory)
2030
def get_root_id(self):
2031
return self._transform.final_file_id(self._transform.root)
2033
def all_file_ids(self):
2034
tree_ids = set(self._transform._tree.all_file_ids())
2035
tree_ids.difference_update(self._transform.tree_file_id(t)
2036
for t in self._transform._removed_id)
2037
tree_ids.update(viewvalues(self._transform._new_id))
2040
def all_versioned_paths(self):
2041
return {self.id2path(fid) for fid in self.all_file_ids()}
2043
def _has_id(self, file_id, fallback_check):
2044
if file_id in self._transform._r_new_id:
2046
elif file_id in {self._transform.tree_file_id(trans_id) for
2047
trans_id in self._transform._removed_id}:
2050
return fallback_check(file_id)
2052
def has_id(self, file_id):
2053
return self._has_id(file_id, self._transform._tree.has_id)
2055
def has_or_had_id(self, file_id):
2056
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2058
def _path2trans_id(self, path):
2059
# We must not use None here, because that is a valid value to store.
2060
trans_id = self._path2trans_id_cache.get(path, object)
2061
if trans_id is not object:
2063
segments = splitpath(path)
2064
cur_parent = self._transform.root
2065
for cur_segment in segments:
2066
for child in self._all_children(cur_parent):
2067
final_name = self._final_name_cache.get(child)
2068
if final_name is None:
2069
final_name = self._transform.final_name(child)
2070
self._final_name_cache[child] = final_name
2071
if final_name == cur_segment:
2075
self._path2trans_id_cache[path] = None
2077
self._path2trans_id_cache[path] = cur_parent
2080
def path2id(self, path):
2081
if isinstance(path, list):
2084
path = osutils.pathjoin(*path)
2085
return self._transform.final_file_id(self._path2trans_id(path))
2087
def id2path(self, file_id):
2088
trans_id = self._transform.trans_id_file_id(file_id)
2090
return self._final_paths._determine_path(trans_id)
2092
raise errors.NoSuchId(self, file_id)
2094
def _all_children(self, trans_id):
2095
children = self._all_children_cache.get(trans_id)
2096
if children is not None:
2098
children = set(self._transform.iter_tree_children(trans_id))
2099
# children in the _new_parent set are provided by _by_parent.
2100
children.difference_update(self._transform._new_parent)
2101
children.update(self._by_parent.get(trans_id, []))
2102
self._all_children_cache[trans_id] = children
2105
def _iter_children(self, file_id):
2106
trans_id = self._transform.trans_id_file_id(file_id)
2107
for child_trans_id in self._all_children(trans_id):
2108
yield self._transform.final_file_id(child_trans_id)
2111
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2112
in self._transform._tree.extras())
2113
possible_extras.update(self._transform._new_contents)
2114
possible_extras.update(self._transform._removed_id)
2115
for trans_id in possible_extras:
2116
if self._transform.final_file_id(trans_id) is None:
2117
yield self._final_paths._determine_path(trans_id)
2119
def _make_inv_entries(self, ordered_entries, specific_files=None):
2120
for trans_id, parent_file_id in ordered_entries:
2121
file_id = self._transform.final_file_id(trans_id)
2124
if (specific_files is not None and
2125
unicode(self._final_paths.get_path(trans_id)) not in specific_files):
2127
kind = self._transform.final_kind(trans_id)
2129
kind = self._transform._tree.stored_kind(
2130
self._transform._tree.id2path(file_id),
2132
new_entry = inventory.make_entry(
2134
self._transform.final_name(trans_id),
2135
parent_file_id, file_id)
2136
yield new_entry, trans_id
2138
def _list_files_by_dir(self):
2139
todo = [ROOT_PARENT]
2141
while len(todo) > 0:
2143
parent_file_id = self._transform.final_file_id(parent)
2144
children = list(self._all_children(parent))
2145
paths = dict(zip(children, self._final_paths.get_paths(children)))
2146
children.sort(key=paths.get)
2147
todo.extend(reversed(children))
2148
for trans_id in children:
2149
ordered_ids.append((trans_id, parent_file_id))
2152
def iter_child_entries(self, path, file_id=None):
2153
trans_id = self._path2trans_id(path)
2154
if trans_id is None:
2155
raise errors.NoSuchFile(path)
2156
todo = [(child_trans_id, trans_id) for child_trans_id in
2157
self._all_children(trans_id)]
2158
for entry, trans_id in self._make_inv_entries(todo):
2161
def iter_entries_by_dir(self, specific_files=None):
2162
# This may not be a maximally efficient implementation, but it is
2163
# reasonably straightforward. An implementation that grafts the
2164
# TreeTransform changes onto the tree's iter_entries_by_dir results
2165
# might be more efficient, but requires tricky inferences about stack
2167
ordered_ids = self._list_files_by_dir()
2168
for entry, trans_id in self._make_inv_entries(ordered_ids,
2170
yield unicode(self._final_paths.get_path(trans_id)), entry
2172
def _iter_entries_for_dir(self, dir_path):
2173
"""Return path, entry for items in a directory without recursing down."""
2175
dir_trans_id = self._path2trans_id(dir_path)
2176
dir_id = self._transform.final_file_id(dir_trans_id)
2177
for child_trans_id in self._all_children(dir_trans_id):
2178
ordered_ids.append((child_trans_id, dir_id))
2179
for entry, trans_id in self._make_inv_entries(ordered_ids):
2180
yield unicode(self._final_paths.get_path(trans_id)), entry
2182
def list_files(self, include_root=False, from_dir=None, recursive=True):
2183
"""See WorkingTree.list_files."""
2184
# XXX This should behave like WorkingTree.list_files, but is really
2185
# more like RevisionTree.list_files.
2189
prefix = from_dir + '/'
2190
entries = self.iter_entries_by_dir()
2191
for path, entry in entries:
2192
if entry.name == '' and not include_root:
2195
if not path.startswith(prefix):
2197
path = path[len(prefix):]
2198
yield path, 'V', entry.kind, entry.file_id, entry
2200
if from_dir is None and include_root is True:
2201
root_entry = inventory.make_entry('directory', '',
2202
ROOT_PARENT, self.get_root_id())
2203
yield '', 'V', 'directory', root_entry.file_id, root_entry
2204
entries = self._iter_entries_for_dir(from_dir or '')
2205
for path, entry in entries:
2206
yield path, 'V', entry.kind, entry.file_id, entry
2208
def kind(self, path, file_id=None):
2209
trans_id = self._path2trans_id(path)
2210
if trans_id is None:
2211
raise errors.NoSuchFile(path)
2212
return self._transform.final_kind(trans_id)
2214
def stored_kind(self, path, file_id=None):
2215
trans_id = self._path2trans_id(path)
2216
if trans_id is None:
2217
raise errors.NoSuchFile(path)
2219
return self._transform._new_contents[trans_id]
2221
return self._transform._tree.stored_kind(path, file_id)
2223
def get_file_mtime(self, path, file_id=None):
2224
"""See Tree.get_file_mtime"""
2226
file_id = self.path2id(path)
2228
raise errors.NoSuchFile(path)
2229
if not self._content_change(file_id):
2230
return self._transform._tree.get_file_mtime(
2231
self._transform._tree.id2path(file_id), file_id)
2232
trans_id = self._path2trans_id(path)
2233
return self._stat_limbo_file(trans_id).st_mtime
2235
def get_file_size(self, path, file_id=None):
2236
"""See Tree.get_file_size"""
2237
trans_id = self._path2trans_id(path)
2238
if trans_id is None:
2239
raise errors.NoSuchFile(path)
2240
kind = self._transform.final_kind(trans_id)
2243
if trans_id in self._transform._new_contents:
2244
return self._stat_limbo_file(trans_id).st_size
2245
if self.kind(path, file_id) == 'file':
2246
return self._transform._tree.get_file_size(path, file_id)
2250
def get_file_verifier(self, path, file_id=None, stat_value=None):
2251
trans_id = self._path2trans_id(path)
2252
if trans_id is None:
2253
raise errors.NoSuchFile(path)
2254
kind = self._transform._new_contents.get(trans_id)
2256
return self._transform._tree.get_file_verifier(path, file_id)
2258
with self.get_file(path, file_id) as fileobj:
2259
return ("SHA1", sha_file(fileobj))
2261
def get_file_sha1(self, path, file_id=None, stat_value=None):
2262
trans_id = self._path2trans_id(path)
2263
if trans_id is None:
2264
raise errors.NoSuchFile(path)
2265
kind = self._transform._new_contents.get(trans_id)
2267
return self._transform._tree.get_file_sha1(path, file_id)
2269
with self.get_file(path, file_id) as fileobj:
2270
return sha_file(fileobj)
2272
def is_executable(self, path, file_id=None):
2273
trans_id = self._path2trans_id(path)
2274
if trans_id is None:
2277
return self._transform._new_executability[trans_id]
2280
return self._transform._tree.is_executable(path, file_id)
2281
except OSError as e:
2282
if e.errno == errno.ENOENT:
2285
except errors.NoSuchFile:
2288
def has_filename(self, path):
2289
trans_id = self._path2trans_id(path)
2290
if trans_id in self._transform._new_contents:
2292
elif trans_id in self._transform._removed_contents:
2295
return self._transform._tree.has_filename(path)
2297
def path_content_summary(self, path):
2298
trans_id = self._path2trans_id(path)
2299
tt = self._transform
2300
tree_path = tt._tree_id_paths.get(trans_id)
2301
kind = tt._new_contents.get(trans_id)
2303
if tree_path is None or trans_id in tt._removed_contents:
2304
return 'missing', None, None, None
2305
summary = tt._tree.path_content_summary(tree_path)
2306
kind, size, executable, link_or_sha1 = summary
2309
limbo_name = tt._limbo_name(trans_id)
2310
if trans_id in tt._new_reference_revision:
2311
kind = 'tree-reference'
2313
statval = os.lstat(limbo_name)
2314
size = statval.st_size
2315
if not tt._limbo_supports_executable():
2318
executable = statval.st_mode & S_IEXEC
2322
if kind == 'symlink':
2323
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2324
executable = tt._new_executability.get(trans_id, executable)
2325
return kind, size, executable, link_or_sha1
2327
def iter_changes(self, from_tree, include_unchanged=False,
2328
specific_files=None, pb=None, extra_trees=None,
2329
require_versioned=True, want_unversioned=False):
2330
"""See InterTree.iter_changes.
2332
This has a fast path that is only used when the from_tree matches
2333
the transform tree, and no fancy options are supplied.
2335
if (from_tree is not self._transform._tree or include_unchanged or
2336
specific_files or want_unversioned):
2337
return tree.InterTree(from_tree, self).iter_changes(
2338
include_unchanged=include_unchanged,
2339
specific_files=specific_files,
2341
extra_trees=extra_trees,
2342
require_versioned=require_versioned,
2343
want_unversioned=want_unversioned)
2344
if want_unversioned:
2345
raise ValueError('want_unversioned is not supported')
2346
return self._transform.iter_changes()
2348
def get_file(self, path, file_id=None):
2349
"""See Tree.get_file"""
2351
file_id = self.path2id(path)
2352
if not self._content_change(file_id):
2353
return self._transform._tree.get_file(path, file_id)
2354
trans_id = self._path2trans_id(path)
2355
name = self._transform._limbo_name(trans_id)
2356
return open(name, 'rb')
2358
def get_file_with_stat(self, path, file_id=None):
2359
return self.get_file(path, file_id), None
2361
def annotate_iter(self, path, file_id=None,
2362
default_revision=_mod_revision.CURRENT_REVISION):
2364
file_id = self.path2id(path)
2365
changes = self._iter_changes_cache.get(file_id)
2369
changed_content, versioned, kind = (changes[2], changes[3],
2373
get_old = (kind[0] == 'file' and versioned[0])
2375
old_annotation = self._transform._tree.annotate_iter(
2376
path, file_id=file_id, default_revision=default_revision)
2380
return old_annotation
2381
if not changed_content:
2382
return old_annotation
2383
# TODO: This is doing something similar to what WT.annotate_iter is
2384
# doing, however it fails slightly because it doesn't know what
2385
# the *other* revision_id is, so it doesn't know how to give the
2386
# other as the origin for some lines, they all get
2387
# 'default_revision'
2388
# It would be nice to be able to use the new Annotator based
2389
# approach, as well.
2390
return annotate.reannotate([old_annotation],
2391
self.get_file(path, file_id).readlines(),
2394
def get_symlink_target(self, path, file_id=None):
2395
"""See Tree.get_symlink_target"""
2397
file_id = self.path2id(path)
2398
if not self._content_change(file_id):
2399
return self._transform._tree.get_symlink_target(path)
2400
trans_id = self._path2trans_id(path)
2401
name = self._transform._limbo_name(trans_id)
2402
return osutils.readlink(name)
2404
def walkdirs(self, prefix=''):
2405
pending = [self._transform.root]
2406
while len(pending) > 0:
2407
parent_id = pending.pop()
2410
prefix = prefix.rstrip('/')
2411
parent_path = self._final_paths.get_path(parent_id)
2412
parent_file_id = self._transform.final_file_id(parent_id)
2413
for child_id in self._all_children(parent_id):
2414
path_from_root = self._final_paths.get_path(child_id)
2415
basename = self._transform.final_name(child_id)
2416
file_id = self._transform.final_file_id(child_id)
2417
kind = self._transform.final_kind(child_id)
2418
if kind is not None:
2419
versioned_kind = kind
2422
versioned_kind = self._transform._tree.stored_kind(
2423
self._transform._tree.id2path(file_id),
2425
if versioned_kind == 'directory':
2426
subdirs.append(child_id)
2427
children.append((path_from_root, basename, kind, None,
2428
file_id, versioned_kind))
2430
if parent_path.startswith(prefix):
2431
yield (parent_path, parent_file_id), children
2432
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2435
def get_parent_ids(self):
2436
return self._parent_ids
2438
def set_parent_ids(self, parent_ids):
2439
self._parent_ids = parent_ids
2441
def get_revision_tree(self, revision_id):
2442
return self._transform._tree.get_revision_tree(revision_id)
2445
def joinpath(parent, child):
2446
"""Join tree-relative paths, handling the tree root specially"""
2447
if parent is None or parent == "":
2450
return pathjoin(parent, child)
2453
class FinalPaths(object):
2454
"""Make path calculation cheap by memoizing paths.
2456
The underlying tree must not be manipulated between calls, or else
2457
the results will likely be incorrect.
2459
def __init__(self, transform):
2460
object.__init__(self)
2461
self._known_paths = {}
2462
self.transform = transform
2464
def _determine_path(self, trans_id):
2465
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2467
name = self.transform.final_name(trans_id)
2468
parent_id = self.transform.final_parent(trans_id)
2469
if parent_id == self.transform.root:
2472
return pathjoin(self.get_path(parent_id), name)
2474
def get_path(self, trans_id):
2475
"""Find the final path associated with a trans_id"""
2476
if trans_id not in self._known_paths:
2477
self._known_paths[trans_id] = self._determine_path(trans_id)
2478
return self._known_paths[trans_id]
2480
def get_paths(self, trans_ids):
2481
return [(self.get_path(t), t) for t in trans_ids]
2485
def topology_sorted_ids(tree):
2486
"""Determine the topological order of the ids in a tree"""
2487
file_ids = list(tree)
2488
file_ids.sort(key=tree.id2path)
2492
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2493
delta_from_tree=False):
2494
"""Create working tree for a branch, using a TreeTransform.
2496
This function should be used on empty trees, having a tree root at most.
2497
(see merge and revert functionality for working with existing trees)
2499
Existing files are handled like so:
2501
- Existing bzrdirs take precedence over creating new items. They are
2502
created as '%s.diverted' % name.
2503
- Otherwise, if the content on disk matches the content we are building,
2504
it is silently replaced.
2505
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2507
:param tree: The tree to convert wt into a copy of
2508
:param wt: The working tree that files will be placed into
2509
:param accelerator_tree: A tree which can be used for retrieving file
2510
contents more quickly than tree itself, i.e. a workingtree. tree
2511
will be used for cases where accelerator_tree's content is different.
2512
:param hardlink: If true, hard-link files to accelerator_tree, where
2513
possible. accelerator_tree must implement abspath, i.e. be a
2515
:param delta_from_tree: If true, build_tree may use the input Tree to
2516
generate the inventory delta.
2518
with wt.lock_tree_write(), tree.lock_read():
2519
if accelerator_tree is not None:
2520
accelerator_tree.lock_read()
2522
return _build_tree(tree, wt, accelerator_tree, hardlink,
2525
if accelerator_tree is not None:
2526
accelerator_tree.unlock()
2529
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2530
"""See build_tree."""
2531
for num, _unused in enumerate(wt.all_versioned_paths()):
2532
if num > 0: # more than just a root
2533
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2535
top_pb = ui.ui_factory.nested_progress_bar()
2536
pp = ProgressPhase("Build phase", 2, top_pb)
2537
if tree.get_root_id() is not None:
2538
# This is kind of a hack: we should be altering the root
2539
# as part of the regular tree shape diff logic.
2540
# The conditional test here is to avoid doing an
2541
# expensive operation (flush) every time the root id
2542
# is set within the tree, nor setting the root and thus
2543
# marking the tree as dirty, because we use two different
2544
# idioms here: tree interfaces and inventory interfaces.
2545
if wt.get_root_id() != tree.get_root_id():
2546
wt.set_root_id(tree.get_root_id())
2548
tt = TreeTransform(wt)
2552
file_trans_id[wt.get_root_id()] = tt.trans_id_tree_path('')
2553
with ui.ui_factory.nested_progress_bar() as pb:
2554
deferred_contents = []
2556
total = len(tree.all_versioned_paths())
2558
precomputed_delta = []
2560
precomputed_delta = None
2561
# Check if tree inventory has content. If so, we populate
2562
# existing_files with the directory content. If there are no
2563
# entries we skip populating existing_files as its not used.
2564
# This improves performance and unncessary work on large
2565
# directory trees. (#501307)
2567
existing_files = set()
2568
for dir, files in wt.walkdirs():
2569
existing_files.update(f[0] for f in files)
2570
for num, (tree_path, entry) in \
2571
enumerate(tree.iter_entries_by_dir()):
2572
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2573
if entry.parent_id is None:
2576
file_id = entry.file_id
2578
precomputed_delta.append((None, tree_path, file_id, entry))
2579
if tree_path in existing_files:
2580
target_path = wt.abspath(tree_path)
2581
kind = file_kind(target_path)
2582
if kind == "directory":
2584
controldir.ControlDir.open(target_path)
2585
except errors.NotBranchError:
2589
if (file_id not in divert and
2590
_content_match(tree, entry, tree_path, file_id, kind,
2592
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2593
if kind == 'directory':
2595
parent_id = file_trans_id[entry.parent_id]
2596
if entry.kind == 'file':
2597
# We *almost* replicate new_by_entry, so that we can defer
2598
# getting the file text, and get them all at once.
2599
trans_id = tt.create_path(entry.name, parent_id)
2600
file_trans_id[file_id] = trans_id
2601
tt.version_file(file_id, trans_id)
2602
executable = tree.is_executable(tree_path, file_id)
2604
tt.set_executability(executable, trans_id)
2605
trans_data = (trans_id, file_id, tree_path, entry.text_sha1)
2606
deferred_contents.append((tree_path, trans_data))
2608
file_trans_id[file_id] = new_by_entry(
2609
tree_path, tt, entry, parent_id, tree)
2611
new_trans_id = file_trans_id[file_id]
2612
old_parent = tt.trans_id_tree_path(tree_path)
2613
_reparent_children(tt, old_parent, new_trans_id)
2614
offset = num + 1 - len(deferred_contents)
2615
_create_files(tt, tree, deferred_contents, pb, offset,
2616
accelerator_tree, hardlink)
2618
divert_trans = set(file_trans_id[f] for f in divert)
2619
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2620
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2621
if len(raw_conflicts) > 0:
2622
precomputed_delta = None
2623
conflicts = cook_conflicts(raw_conflicts, tt)
2624
for conflict in conflicts:
2625
trace.warning(unicode(conflict))
2627
wt.add_conflicts(conflicts)
2628
except errors.UnsupportedOperation:
2630
result = tt.apply(no_conflicts=True,
2631
precomputed_delta=precomputed_delta)
2638
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2640
total = len(desired_files) + offset
2642
if accelerator_tree is None:
2643
new_desired_files = desired_files
2645
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2646
unchanged = [(p[0], p[1]) for (f, p, c, v, d, n, k, e)
2647
in iter if not (c or e[0] != e[1])]
2648
if accelerator_tree.supports_content_filtering():
2649
unchanged = [(tp, ap) for (tp, ap) in unchanged
2650
if not next(accelerator_tree.iter_search_rules([ap]))]
2651
unchanged = dict(unchanged)
2652
new_desired_files = []
2654
for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
2655
accelerator_path = unchanged.get(tree_path)
2656
if accelerator_path is None:
2657
new_desired_files.append((tree_path,
2658
(trans_id, file_id, tree_path, text_sha1)))
2660
pb.update(gettext('Adding file contents'), count + offset, total)
2662
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2665
with accelerator_tree.get_file(accelerator_path, file_id) as f:
2666
chunks = osutils.file_iterator(f)
2667
if wt.supports_content_filtering():
2668
filters = wt._content_filter_stack(tree_path)
2669
chunks = filtered_output_bytes(chunks, filters,
2670
ContentFilterContext(tree_path, tree))
2671
tt.create_file(chunks, trans_id, sha1=text_sha1)
2674
for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2675
tree.iter_files_bytes(new_desired_files)):
2676
if wt.supports_content_filtering():
2677
filters = wt._content_filter_stack(tree_path)
2678
contents = filtered_output_bytes(contents, filters,
2679
ContentFilterContext(tree_path, tree))
2680
tt.create_file(contents, trans_id, sha1=text_sha1)
2681
pb.update(gettext('Adding file contents'), count + offset, total)
2684
def _reparent_children(tt, old_parent, new_parent):
2685
for child in tt.iter_tree_children(old_parent):
2686
tt.adjust_path(tt.final_name(child), new_parent, child)
2689
def _reparent_transform_children(tt, old_parent, new_parent):
2690
by_parent = tt.by_parent()
2691
for child in by_parent[old_parent]:
2692
tt.adjust_path(tt.final_name(child), new_parent, child)
2693
return by_parent[old_parent]
2696
def _content_match(tree, entry, tree_path, file_id, kind, target_path):
2697
if entry.kind != kind:
2699
if entry.kind == "directory":
2701
if entry.kind == "file":
2702
with open(target_path, 'rb') as f1, \
2703
tree.get_file(tree_path, file_id) as f2:
2704
if osutils.compare_files(f1, f2):
2706
elif entry.kind == "symlink":
2707
if tree.get_symlink_target(tree_path, file_id) == os.readlink(target_path):
2712
def resolve_checkout(tt, conflicts, divert):
2713
new_conflicts = set()
2714
for c_type, conflict in ((c[0], c) for c in conflicts):
2715
# Anything but a 'duplicate' would indicate programmer error
2716
if c_type != 'duplicate':
2717
raise AssertionError(c_type)
2718
# Now figure out which is new and which is old
2719
if tt.new_contents(conflict[1]):
2720
new_file = conflict[1]
2721
old_file = conflict[2]
2723
new_file = conflict[2]
2724
old_file = conflict[1]
2726
# We should only get here if the conflict wasn't completely
2728
final_parent = tt.final_parent(old_file)
2729
if new_file in divert:
2730
new_name = tt.final_name(old_file)+'.diverted'
2731
tt.adjust_path(new_name, final_parent, new_file)
2732
new_conflicts.add((c_type, 'Diverted to',
2733
new_file, old_file))
2735
new_name = tt.final_name(old_file)+'.moved'
2736
tt.adjust_path(new_name, final_parent, old_file)
2737
new_conflicts.add((c_type, 'Moved existing file to',
2738
old_file, new_file))
2739
return new_conflicts
2742
def new_by_entry(path, tt, entry, parent_id, tree):
2743
"""Create a new file according to its inventory entry"""
2747
with tree.get_file(path, entry.file_id) as f:
2748
executable = tree.is_executable(path, entry.file_id)
2750
name, parent_id, osutils.file_iterator(f), entry.file_id,
2752
elif kind in ('directory', 'tree-reference'):
2753
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2754
if kind == 'tree-reference':
2755
tt.set_tree_reference(entry.reference_revision, trans_id)
2757
elif kind == 'symlink':
2758
target = tree.get_symlink_target(path, entry.file_id)
2759
return tt.new_symlink(name, parent_id, target, entry.file_id)
2761
raise errors.BadFileKindError(name, kind)
2764
def create_from_tree(tt, trans_id, tree, path, file_id=None, chunks=None,
2765
filter_tree_path=None):
2766
"""Create new file contents according to tree contents.
2768
:param filter_tree_path: the tree path to use to lookup
2769
content filters to apply to the bytes output in the working tree.
2770
This only applies if the working tree supports content filtering.
2772
kind = tree.kind(path, file_id)
2773
if kind == 'directory':
2774
tt.create_directory(trans_id)
2775
elif kind == "file":
2777
f = tree.get_file(path, file_id)
2778
chunks = osutils.file_iterator(f)
2783
if wt.supports_content_filtering() and filter_tree_path is not None:
2784
filters = wt._content_filter_stack(filter_tree_path)
2785
chunks = filtered_output_bytes(chunks, filters,
2786
ContentFilterContext(filter_tree_path, tree))
2787
tt.create_file(chunks, trans_id)
2791
elif kind == "symlink":
2792
tt.create_symlink(tree.get_symlink_target(path, file_id), trans_id)
2794
raise AssertionError('Unknown kind %r' % kind)
2797
def create_entry_executability(tt, entry, trans_id):
2798
"""Set the executability of a trans_id according to an inventory entry"""
2799
if entry.kind == "file":
2800
tt.set_executability(entry.executable, trans_id)
2803
def revert(working_tree, target_tree, filenames, backups=False,
2804
pb=None, change_reporter=None):
2805
"""Revert a working tree's contents to those of a target tree."""
2806
pb = ui.ui_factory.nested_progress_bar()
2808
with target_tree.lock_read(), TreeTransform(working_tree, pb) as tt:
2809
pp = ProgressPhase("Revert phase", 3, pb)
2810
conflicts, merge_modified = _prepare_revert_transform(
2811
working_tree, target_tree, tt, filenames, backups, pp)
2813
change_reporter = delta._ChangeReporter(
2814
unversioned_filter=working_tree.is_ignored)
2815
delta.report_changes(tt.iter_changes(), change_reporter)
2816
for conflict in conflicts:
2817
trace.warning(unicode(conflict))
2820
if working_tree.supports_merge_modified():
2821
working_tree.set_merge_modified(merge_modified)
2827
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2828
backups, pp, basis_tree=None,
2829
merge_modified=None):
2830
with ui.ui_factory.nested_progress_bar() as child_pb:
2831
if merge_modified is None:
2832
merge_modified = working_tree.merge_modified()
2833
merge_modified = _alter_files(working_tree, target_tree, tt,
2834
child_pb, filenames, backups,
2835
merge_modified, basis_tree)
2836
with ui.ui_factory.nested_progress_bar() as child_pb:
2837
raw_conflicts = resolve_conflicts(tt, child_pb,
2838
lambda t, c: conflict_pass(t, c, target_tree))
2839
conflicts = cook_conflicts(raw_conflicts, tt)
2840
return conflicts, merge_modified
2843
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2844
backups, merge_modified, basis_tree=None):
2845
if basis_tree is not None:
2846
basis_tree.lock_read()
2847
# We ask the working_tree for its changes relative to the target, rather
2848
# than the target changes relative to the working tree. Because WT4 has an
2849
# optimizer to compare itself to a target, but no optimizer for the
2851
change_list = working_tree.iter_changes(target_tree,
2852
specific_files=specific_files, pb=pb)
2853
if not target_tree.is_versioned(u''):
2859
for id_num, (file_id, path, changed_content, versioned, parent, name,
2860
kind, executable) in enumerate(change_list):
2861
target_path, wt_path = path
2862
target_versioned, wt_versioned = versioned
2863
target_parent, wt_parent = parent
2864
target_name, wt_name = name
2865
target_kind, wt_kind = kind
2866
target_executable, wt_executable = executable
2867
if skip_root and wt_parent is None:
2869
trans_id = tt.trans_id_file_id(file_id)
2872
keep_content = False
2873
if wt_kind == 'file' and (backups or target_kind is None):
2874
wt_sha1 = working_tree.get_file_sha1(wt_path, file_id)
2875
if merge_modified.get(file_id) != wt_sha1:
2876
# acquire the basis tree lazily to prevent the
2877
# expense of accessing it when it's not needed ?
2878
# (Guessing, RBC, 200702)
2879
if basis_tree is None:
2880
basis_tree = working_tree.basis_tree()
2881
basis_tree.lock_read()
2882
basis_path = find_previous_path(working_tree, basis_tree, wt_path)
2883
if basis_path is None:
2884
if target_kind is None and not target_versioned:
2887
if wt_sha1 != basis_tree.get_file_sha1(basis_path, file_id):
2889
if wt_kind is not None:
2890
if not keep_content:
2891
tt.delete_contents(trans_id)
2892
elif target_kind is not None:
2893
parent_trans_id = tt.trans_id_file_id(wt_parent)
2894
backup_name = tt._available_backup_name(
2895
wt_name, parent_trans_id)
2896
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2897
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2898
if wt_versioned and target_versioned:
2899
tt.unversion_file(trans_id)
2900
tt.version_file(file_id, new_trans_id)
2901
# New contents should have the same unix perms as old
2904
trans_id = new_trans_id
2905
if target_kind in ('directory', 'tree-reference'):
2906
tt.create_directory(trans_id)
2907
if target_kind == 'tree-reference':
2908
revision = target_tree.get_reference_revision(
2909
target_path, file_id)
2910
tt.set_tree_reference(revision, trans_id)
2911
elif target_kind == 'symlink':
2912
tt.create_symlink(target_tree.get_symlink_target(
2913
target_path, file_id), trans_id)
2914
elif target_kind == 'file':
2915
deferred_files.append((target_path, (trans_id, mode_id, file_id)))
2916
if basis_tree is None:
2917
basis_tree = working_tree.basis_tree()
2918
basis_tree.lock_read()
2919
new_sha1 = target_tree.get_file_sha1(target_path, file_id)
2920
basis_path = find_previous_path(target_tree, basis_tree, target_path)
2921
if (basis_path is not None and
2922
new_sha1 == basis_tree.get_file_sha1(basis_path, file_id)):
2923
if file_id in merge_modified:
2924
del merge_modified[file_id]
2926
merge_modified[file_id] = new_sha1
2928
# preserve the execute bit when backing up
2929
if keep_content and wt_executable == target_executable:
2930
tt.set_executability(target_executable, trans_id)
2931
elif target_kind is not None:
2932
raise AssertionError(target_kind)
2933
if not wt_versioned and target_versioned:
2934
tt.version_file(file_id, trans_id)
2935
if wt_versioned and not target_versioned:
2936
tt.unversion_file(trans_id)
2937
if (target_name is not None and
2938
(wt_name != target_name or wt_parent != target_parent)):
2939
if target_name == '' and target_parent is None:
2940
parent_trans = ROOT_PARENT
2942
parent_trans = tt.trans_id_file_id(target_parent)
2943
if wt_parent is None and wt_versioned:
2944
tt.adjust_root_path(target_name, parent_trans)
2946
tt.adjust_path(target_name, parent_trans, trans_id)
2947
if wt_executable != target_executable and target_kind == "file":
2948
tt.set_executability(target_executable, trans_id)
2949
if working_tree.supports_content_filtering():
2950
for (trans_id, mode_id, file_id), bytes in (
2951
target_tree.iter_files_bytes(deferred_files)):
2952
# We're reverting a tree to the target tree so using the
2953
# target tree to find the file path seems the best choice
2954
# here IMO - Ian C 27/Oct/2009
2955
filter_tree_path = target_tree.id2path(file_id)
2956
filters = working_tree._content_filter_stack(filter_tree_path)
2957
bytes = filtered_output_bytes(bytes, filters,
2958
ContentFilterContext(filter_tree_path, working_tree))
2959
tt.create_file(bytes, trans_id, mode_id)
2961
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
2963
tt.create_file(bytes, trans_id, mode_id)
2964
tt.fixup_new_roots()
2966
if basis_tree is not None:
2968
return merge_modified
2971
def resolve_conflicts(tt, pb=None, pass_func=None):
2972
"""Make many conflict-resolution attempts, but die if they fail"""
2973
if pass_func is None:
2974
pass_func = conflict_pass
2975
new_conflicts = set()
2976
with ui.ui_factory.nested_progress_bar() as pb:
2978
pb.update(gettext('Resolution pass'), n+1, 10)
2979
conflicts = tt.find_conflicts()
2980
if len(conflicts) == 0:
2981
return new_conflicts
2982
new_conflicts.update(pass_func(tt, conflicts))
2983
raise MalformedTransform(conflicts=conflicts)
2986
def conflict_pass(tt, conflicts, path_tree=None):
2987
"""Resolve some classes of conflicts.
2989
:param tt: The transform to resolve conflicts in
2990
:param conflicts: The conflicts to resolve
2991
:param path_tree: A Tree to get supplemental paths from
2993
new_conflicts = set()
2994
for c_type, conflict in ((c[0], c) for c in conflicts):
2995
if c_type == 'duplicate id':
2996
tt.unversion_file(conflict[1])
2997
new_conflicts.add((c_type, 'Unversioned existing file',
2998
conflict[1], conflict[2], ))
2999
elif c_type == 'duplicate':
3000
# files that were renamed take precedence
3001
final_parent = tt.final_parent(conflict[1])
3002
if tt.path_changed(conflict[1]):
3003
existing_file, new_file = conflict[2], conflict[1]
3005
existing_file, new_file = conflict[1], conflict[2]
3006
new_name = tt.final_name(existing_file) + '.moved'
3007
tt.adjust_path(new_name, final_parent, existing_file)
3008
new_conflicts.add((c_type, 'Moved existing file to',
3009
existing_file, new_file))
3010
elif c_type == 'parent loop':
3011
# break the loop by undoing one of the ops that caused the loop
3013
while not tt.path_changed(cur):
3014
cur = tt.final_parent(cur)
3015
new_conflicts.add((c_type, 'Cancelled move', cur,
3016
tt.final_parent(cur),))
3017
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3019
elif c_type == 'missing parent':
3020
trans_id = conflict[1]
3021
if trans_id in tt._removed_contents:
3022
cancel_deletion = True
3023
orphans = tt._get_potential_orphans(trans_id)
3025
cancel_deletion = False
3026
# All children are orphans
3029
tt.new_orphan(o, trans_id)
3030
except OrphaningError:
3031
# Something bad happened so we cancel the directory
3032
# deletion which will leave it in place with a
3033
# conflict. The user can deal with it from there.
3034
# Note that this also catch the case where we don't
3035
# want to create orphans and leave the directory in
3037
cancel_deletion = True
3040
# Cancel the directory deletion
3041
tt.cancel_deletion(trans_id)
3042
new_conflicts.add(('deleting parent', 'Not deleting',
3047
tt.final_name(trans_id)
3049
if path_tree is not None:
3050
file_id = tt.final_file_id(trans_id)
3052
file_id = tt.inactive_file_id(trans_id)
3053
_, entry = next(path_tree.iter_entries_by_dir(
3054
specific_files=[path_tree.id2path(file_id)]))
3055
# special-case the other tree root (move its
3056
# children to current root)
3057
if entry.parent_id is None:
3059
moved = _reparent_transform_children(
3060
tt, trans_id, tt.root)
3062
new_conflicts.add((c_type, 'Moved to root',
3065
parent_trans_id = tt.trans_id_file_id(
3067
tt.adjust_path(entry.name, parent_trans_id,
3070
tt.create_directory(trans_id)
3071
new_conflicts.add((c_type, 'Created directory', trans_id))
3072
elif c_type == 'unversioned parent':
3073
file_id = tt.inactive_file_id(conflict[1])
3074
# special-case the other tree root (move its children instead)
3075
if path_tree and path_tree.path2id('') == file_id:
3076
# This is the root entry, skip it
3078
tt.version_file(file_id, conflict[1])
3079
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3080
elif c_type == 'non-directory parent':
3081
parent_id = conflict[1]
3082
parent_parent = tt.final_parent(parent_id)
3083
parent_name = tt.final_name(parent_id)
3084
parent_file_id = tt.final_file_id(parent_id)
3085
new_parent_id = tt.new_directory(parent_name + '.new',
3086
parent_parent, parent_file_id)
3087
_reparent_transform_children(tt, parent_id, new_parent_id)
3088
if parent_file_id is not None:
3089
tt.unversion_file(parent_id)
3090
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3091
elif c_type == 'versioning no contents':
3092
tt.cancel_versioning(conflict[1])
3093
return new_conflicts
3096
def cook_conflicts(raw_conflicts, tt):
3097
"""Generate a list of cooked conflicts, sorted by file path"""
3098
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3099
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3102
def iter_cook_conflicts(raw_conflicts, tt):
3104
for conflict in raw_conflicts:
3105
c_type = conflict[0]
3106
action = conflict[1]
3107
modified_path = fp.get_path(conflict[2])
3108
modified_id = tt.final_file_id(conflict[2])
3109
if len(conflict) == 3:
3110
yield conflicts.Conflict.factory(
3111
c_type, action=action, path=modified_path, file_id=modified_id)
3114
conflicting_path = fp.get_path(conflict[3])
3115
conflicting_id = tt.final_file_id(conflict[3])
3116
yield conflicts.Conflict.factory(
3117
c_type, action=action, path=modified_path,
3118
file_id=modified_id,
3119
conflict_path=conflicting_path,
3120
conflict_file_id=conflicting_id)
3123
class _FileMover(object):
3124
"""Moves and deletes files for TreeTransform, tracking operations"""
3127
self.past_renames = []
3128
self.pending_deletions = []
3130
def rename(self, from_, to):
3131
"""Rename a file from one path to another."""
3133
os.rename(from_, to)
3134
except OSError as e:
3135
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3136
raise errors.FileExists(to, str(e))
3137
# normal OSError doesn't include filenames so it's hard to see where
3138
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3139
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3140
self.past_renames.append((from_, to))
3142
def pre_delete(self, from_, to):
3143
"""Rename a file out of the way and mark it for deletion.
3145
Unlike os.unlink, this works equally well for files and directories.
3146
:param from_: The current file path
3147
:param to: A temporary path for the file
3149
self.rename(from_, to)
3150
self.pending_deletions.append(to)
3153
"""Reverse all renames that have been performed"""
3154
for from_, to in reversed(self.past_renames):
3156
os.rename(to, from_)
3157
except OSError as e:
3158
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3159
# after rollback, don't reuse _FileMover
3161
pending_deletions = None
3163
def apply_deletions(self):
3164
"""Apply all marked deletions"""
3165
for path in self.pending_deletions:
3167
# after apply_deletions, don't reuse _FileMover
3169
pending_deletions = None
3172
def link_tree(target_tree, source_tree):
3173
"""Where possible, hard-link files in a tree to those in another tree.
3175
:param target_tree: Tree to change
3176
:param source_tree: Tree to hard-link from
3178
tt = TreeTransform(target_tree)
3180
for (file_id, paths, changed_content, versioned, parent, name, kind,
3181
executable) in target_tree.iter_changes(source_tree,
3182
include_unchanged=True):
3185
if kind != ('file', 'file'):
3187
if executable[0] != executable[1]:
3189
trans_id = tt.trans_id_tree_path(paths[1])
3190
tt.delete_contents(trans_id)
3191
tt.create_hardlink(source_tree.abspath(paths[0]), trans_id)
added
removed
breezy/transform.py
