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
lines = osutils.chunks_to_lines(
1123
self._read_file_chunks(trans_id))
1124
parents = self._get_parents_lines(trans_id)
1125
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1126
content = ''.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
f = open(name, 'wb')
1315
unique_add(self._new_contents, trans_id, 'file')
1316
f.writelines(contents)
1319
self._set_mtime(name)
1320
self._set_mode(trans_id, mode_id, S_ISREG)
1321
# It is unfortunate we have to use lstat instead of fstat, but we just
1322
# used utime and chmod on the file, so we need the accurate final
1324
if sha1 is not None:
1325
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1327
def _read_file_chunks(self, trans_id):
1328
cur_file = open(self._limbo_name(trans_id), 'rb')
1330
return cur_file.readlines()
1334
def _read_symlink_target(self, trans_id):
1335
return os.readlink(self._limbo_name(trans_id))
1337
def _set_mtime(self, path):
1338
"""All files that are created get the same mtime.
1340
This time is set by the first object to be created.
1342
if self._creation_mtime is None:
1343
self._creation_mtime = time.time()
1344
os.utime(path, (self._creation_mtime, self._creation_mtime))
1346
def create_hardlink(self, path, trans_id):
1347
"""Schedule creation of a hard link"""
1348
name = self._limbo_name(trans_id)
1351
except OSError as e:
1352
if e.errno != errno.EPERM:
1354
raise errors.HardLinkNotSupported(path)
1356
unique_add(self._new_contents, trans_id, 'file')
1358
# Clean up the file, it never got registered so
1359
# TreeTransform.finalize() won't clean it up.
1363
def create_directory(self, trans_id):
1364
"""Schedule creation of a new directory.
1366
See also new_directory.
1368
os.mkdir(self._limbo_name(trans_id))
1369
unique_add(self._new_contents, trans_id, 'directory')
1371
def create_symlink(self, target, trans_id):
1372
"""Schedule creation of a new symbolic link.
1374
target is a bytestring.
1375
See also new_symlink.
1378
os.symlink(target, self._limbo_name(trans_id))
1379
unique_add(self._new_contents, trans_id, 'symlink')
1382
path = FinalPaths(self).get_path(trans_id)
1385
raise UnableCreateSymlink(path=path)
1387
def cancel_creation(self, trans_id):
1388
"""Cancel the creation of new file contents."""
1389
del self._new_contents[trans_id]
1390
if trans_id in self._observed_sha1s:
1391
del self._observed_sha1s[trans_id]
1392
children = self._limbo_children.get(trans_id)
1393
# if this is a limbo directory with children, move them before removing
1395
if children is not None:
1396
self._rename_in_limbo(children)
1397
del self._limbo_children[trans_id]
1398
del self._limbo_children_names[trans_id]
1399
delete_any(self._limbo_name(trans_id))
1401
def new_orphan(self, trans_id, parent_id):
1402
conf = self._tree.get_config_stack()
1403
handle_orphan = conf.get('transform.orphan_policy')
1404
handle_orphan(self, trans_id, parent_id)
1407
class OrphaningError(errors.BzrError):
1409
# Only bugs could lead to such exception being seen by the user
1410
internal_error = True
1411
_fmt = "Error while orphaning %s in %s directory"
1413
def __init__(self, orphan, parent):
1414
errors.BzrError.__init__(self)
1415
self.orphan = orphan
1416
self.parent = parent
1419
class OrphaningForbidden(OrphaningError):
1421
_fmt = "Policy: %s doesn't allow creating orphans."
1423
def __init__(self, policy):
1424
errors.BzrError.__init__(self)
1425
self.policy = policy
1428
def move_orphan(tt, orphan_id, parent_id):
1429
"""See TreeTransformBase.new_orphan.
1431
This creates a new orphan in the `brz-orphans` dir at the root of the
1434
:param tt: The TreeTransform orphaning `trans_id`.
1436
:param orphan_id: The trans id that should be orphaned.
1438
:param parent_id: The orphan parent trans id.
1440
# Add the orphan dir if it doesn't exist
1441
orphan_dir_basename = 'brz-orphans'
1442
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1443
if tt.final_kind(od_id) is None:
1444
tt.create_directory(od_id)
1445
parent_path = tt._tree_id_paths[parent_id]
1446
# Find a name that doesn't exist yet in the orphan dir
1447
actual_name = tt.final_name(orphan_id)
1448
new_name = tt._available_backup_name(actual_name, od_id)
1449
tt.adjust_path(new_name, od_id, orphan_id)
1450
trace.warning('%s has been orphaned in %s'
1451
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1454
def refuse_orphan(tt, orphan_id, parent_id):
1455
"""See TreeTransformBase.new_orphan.
1457
This refuses to create orphan, letting the caller handle the conflict.
1459
raise OrphaningForbidden('never')
1462
orphaning_registry = registry.Registry()
1463
orphaning_registry.register(
1464
'conflict', refuse_orphan,
1465
'Leave orphans in place and create a conflict on the directory.')
1466
orphaning_registry.register(
1467
'move', move_orphan,
1468
'Move orphans into the brz-orphans directory.')
1469
orphaning_registry._set_default_key('conflict')
1472
opt_transform_orphan = _mod_config.RegistryOption(
1473
'transform.orphan_policy', orphaning_registry,
1474
help='Policy for orphaned files during transform operations.',
1478
class TreeTransform(DiskTreeTransform):
1479
"""Represent a tree transformation.
1481
This object is designed to support incremental generation of the transform,
1484
However, it gives optimum performance when parent directories are created
1485
before their contents. The transform is then able to put child files
1486
directly in their parent directory, avoiding later renames.
1488
It is easy to produce malformed transforms, but they are generally
1489
harmless. Attempting to apply a malformed transform will cause an
1490
exception to be raised before any modifications are made to the tree.
1492
Many kinds of malformed transforms can be corrected with the
1493
resolve_conflicts function. The remaining ones indicate programming error,
1494
such as trying to create a file with no path.
1496
Two sets of file creation methods are supplied. Convenience methods are:
1501
These are composed of the low-level methods:
1503
* create_file or create_directory or create_symlink
1507
Transform/Transaction ids
1508
-------------------------
1509
trans_ids are temporary ids assigned to all files involved in a transform.
1510
It's possible, even common, that not all files in the Tree have trans_ids.
1512
trans_ids are used because filenames and file_ids are not good enough
1513
identifiers; filenames change, and not all files have file_ids. File-ids
1514
are also associated with trans-ids, so that moving a file moves its
1517
trans_ids are only valid for the TreeTransform that generated them.
1521
Limbo is a temporary directory use to hold new versions of files.
1522
Files are added to limbo by create_file, create_directory, create_symlink,
1523
and their convenience variants (new_*). Files may be removed from limbo
1524
using cancel_creation. Files are renamed from limbo into their final
1525
location as part of TreeTransform.apply
1527
Limbo must be cleaned up, by either calling TreeTransform.apply or
1528
calling TreeTransform.finalize.
1530
Files are placed into limbo inside their parent directories, where
1531
possible. This reduces subsequent renames, and makes operations involving
1532
lots of files faster. This optimization is only possible if the parent
1533
directory is created *before* creating any of its children, so avoid
1534
creating children before parents, where possible.
1538
This temporary directory is used by _FileMover for storing files that are
1539
about to be deleted. In case of rollback, the files will be restored.
1540
FileMover does not delete files until it is sure that a rollback will not
1543
def __init__(self, tree, pb=None):
1544
"""Note: a tree_write lock is taken on the tree.
1546
Use TreeTransform.finalize() to release the lock (can be omitted if
1547
TreeTransform.apply() called).
1549
tree.lock_tree_write()
1551
limbodir = urlutils.local_path_from_url(
1552
tree._transport.abspath('limbo'))
1553
osutils.ensure_empty_directory_exists(
1555
errors.ExistingLimbo)
1556
deletiondir = urlutils.local_path_from_url(
1557
tree._transport.abspath('pending-deletion'))
1558
osutils.ensure_empty_directory_exists(
1560
errors.ExistingPendingDeletion)
1565
# Cache of realpath results, to speed up canonical_path
1566
self._realpaths = {}
1567
# Cache of relpath results, to speed up canonical_path
1569
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1570
tree.case_sensitive)
1571
self._deletiondir = deletiondir
1573
def canonical_path(self, path):
1574
"""Get the canonical tree-relative path"""
1575
# don't follow final symlinks
1576
abs = self._tree.abspath(path)
1577
if abs in self._relpaths:
1578
return self._relpaths[abs]
1579
dirname, basename = os.path.split(abs)
1580
if dirname not in self._realpaths:
1581
self._realpaths[dirname] = os.path.realpath(dirname)
1582
dirname = self._realpaths[dirname]
1583
abs = pathjoin(dirname, basename)
1584
if dirname in self._relpaths:
1585
relpath = pathjoin(self._relpaths[dirname], basename)
1586
relpath = relpath.rstrip('/\\')
1588
relpath = self._tree.relpath(abs)
1589
self._relpaths[abs] = relpath
1592
def tree_kind(self, trans_id):
1593
"""Determine the file kind in the working tree.
1595
:returns: The file kind or None if the file does not exist
1597
path = self._tree_id_paths.get(trans_id)
1601
return file_kind(self._tree.abspath(path))
1602
except errors.NoSuchFile:
1605
def _set_mode(self, trans_id, mode_id, typefunc):
1606
"""Set the mode of new file contents.
1607
The mode_id is the existing file to get the mode from (often the same
1608
as trans_id). The operation is only performed if there's a mode match
1609
according to typefunc.
1614
old_path = self._tree_id_paths[mode_id]
1618
mode = os.stat(self._tree.abspath(old_path)).st_mode
1619
except OSError as e:
1620
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1621
# Either old_path doesn't exist, or the parent of the
1622
# target is not a directory (but will be one eventually)
1623
# Either way, we know it doesn't exist *right now*
1624
# See also bug #248448
1629
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1631
def iter_tree_children(self, parent_id):
1632
"""Iterate through the entry's tree children, if any"""
1634
path = self._tree_id_paths[parent_id]
1638
children = os.listdir(self._tree.abspath(path))
1639
except OSError as e:
1640
if not (osutils._is_error_enotdir(e)
1641
or e.errno in (errno.ENOENT, errno.ESRCH)):
1645
for child in children:
1646
childpath = joinpath(path, child)
1647
if self._tree.is_control_filename(childpath):
1649
yield self.trans_id_tree_path(childpath)
1651
def _generate_limbo_path(self, trans_id):
1652
"""Generate a limbo path using the final path if possible.
1654
This optimizes the performance of applying the tree transform by
1655
avoiding renames. These renames can be avoided only when the parent
1656
directory is already scheduled for creation.
1658
If the final path cannot be used, falls back to using the trans_id as
1661
parent = self._new_parent.get(trans_id)
1662
# if the parent directory is already in limbo (e.g. when building a
1663
# tree), choose a limbo name inside the parent, to reduce further
1665
use_direct_path = False
1666
if self._new_contents.get(parent) == 'directory':
1667
filename = self._new_name.get(trans_id)
1668
if filename is not None:
1669
if parent not in self._limbo_children:
1670
self._limbo_children[parent] = set()
1671
self._limbo_children_names[parent] = {}
1672
use_direct_path = True
1673
# the direct path can only be used if no other file has
1674
# already taken this pathname, i.e. if the name is unused, or
1675
# if it is already associated with this trans_id.
1676
elif self._case_sensitive_target:
1677
if (self._limbo_children_names[parent].get(filename)
1678
in (trans_id, None)):
1679
use_direct_path = True
1681
for l_filename, l_trans_id in viewitems(
1682
self._limbo_children_names[parent]):
1683
if l_trans_id == trans_id:
1685
if l_filename.lower() == filename.lower():
1688
use_direct_path = True
1690
if not use_direct_path:
1691
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1693
limbo_name = pathjoin(self._limbo_files[parent], filename)
1694
self._limbo_children[parent].add(trans_id)
1695
self._limbo_children_names[parent][filename] = trans_id
1699
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1700
"""Apply all changes to the inventory and filesystem.
1702
If filesystem or inventory conflicts are present, MalformedTransform
1705
If apply succeeds, finalize is not necessary.
1707
:param no_conflicts: if True, the caller guarantees there are no
1708
conflicts, so no check is made.
1709
:param precomputed_delta: An inventory delta to use instead of
1711
:param _mover: Supply an alternate FileMover, for testing
1713
for hook in MutableTree.hooks['pre_transform']:
1714
hook(self._tree, self)
1715
if not no_conflicts:
1716
self._check_malformed()
1717
with ui.ui_factory.nested_progress_bar() as child_pb:
1718
if precomputed_delta is None:
1719
child_pb.update(gettext('Apply phase'), 0, 2)
1720
inventory_delta = self._generate_inventory_delta()
1723
inventory_delta = precomputed_delta
1726
mover = _FileMover()
1730
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1731
self._apply_removals(mover)
1732
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1733
modified_paths = self._apply_insertions(mover)
1738
mover.apply_deletions()
1739
if self.final_file_id(self.root) is None:
1740
inventory_delta = [e for e in inventory_delta if e[0] != '']
1741
self._tree.apply_inventory_delta(inventory_delta)
1742
self._apply_observed_sha1s()
1745
return _TransformResults(modified_paths, self.rename_count)
1747
def _generate_inventory_delta(self):
1748
"""Generate an inventory delta for the current transform."""
1749
inventory_delta = []
1750
new_paths = self._inventory_altered()
1751
total_entries = len(new_paths) + len(self._removed_id)
1752
with ui.ui_factory.nested_progress_bar() as child_pb:
1753
for num, trans_id in enumerate(self._removed_id):
1755
child_pb.update(gettext('removing file'), num, total_entries)
1756
if trans_id == self._new_root:
1757
file_id = self._tree.get_root_id()
1759
file_id = self.tree_file_id(trans_id)
1760
# File-id isn't really being deleted, just moved
1761
if file_id in self._r_new_id:
1763
path = self._tree_id_paths[trans_id]
1764
inventory_delta.append((path, None, file_id, None))
1765
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1768
for num, (path, trans_id) in enumerate(new_paths):
1770
child_pb.update(gettext('adding file'),
1771
num + len(self._removed_id), total_entries)
1772
file_id = new_path_file_ids[trans_id]
1776
kind = self.final_kind(trans_id)
1778
kind = self._tree.stored_kind(
1779
self._tree.id2path(file_id), file_id)
1780
parent_trans_id = self.final_parent(trans_id)
1781
parent_file_id = new_path_file_ids.get(parent_trans_id)
1782
if parent_file_id is None:
1783
parent_file_id = self.final_file_id(parent_trans_id)
1784
if trans_id in self._new_reference_revision:
1785
new_entry = inventory.TreeReference(
1787
self._new_name[trans_id],
1788
self.final_file_id(self._new_parent[trans_id]),
1789
None, self._new_reference_revision[trans_id])
1791
new_entry = inventory.make_entry(kind,
1792
self.final_name(trans_id),
1793
parent_file_id, file_id)
1795
old_path = self._tree.id2path(new_entry.file_id)
1796
except errors.NoSuchId:
1798
new_executability = self._new_executability.get(trans_id)
1799
if new_executability is not None:
1800
new_entry.executable = new_executability
1801
inventory_delta.append(
1802
(old_path, path, new_entry.file_id, new_entry))
1803
return inventory_delta
1805
def _apply_removals(self, mover):
1806
"""Perform tree operations that remove directory/inventory names.
1808
That is, delete files that are to be deleted, and put any files that
1809
need renaming into limbo. This must be done in strict child-to-parent
1812
If inventory_delta is None, no inventory delta generation is performed.
1814
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1815
with ui.ui_factory.nested_progress_bar() as child_pb:
1816
for num, (path, trans_id) in enumerate(tree_paths):
1817
# do not attempt to move root into a subdirectory of itself.
1820
child_pb.update(gettext('removing file'), num, len(tree_paths))
1821
full_path = self._tree.abspath(path)
1822
if trans_id in self._removed_contents:
1823
delete_path = os.path.join(self._deletiondir, trans_id)
1824
mover.pre_delete(full_path, delete_path)
1825
elif (trans_id in self._new_name
1826
or trans_id in self._new_parent):
1828
mover.rename(full_path, self._limbo_name(trans_id))
1829
except errors.TransformRenameFailed as e:
1830
if e.errno != errno.ENOENT:
1833
self.rename_count += 1
1835
def _apply_insertions(self, mover):
1836
"""Perform tree operations that insert directory/inventory names.
1838
That is, create any files that need to be created, and restore from
1839
limbo any files that needed renaming. This must be done in strict
1840
parent-to-child order.
1842
If inventory_delta is None, no inventory delta is calculated, and
1843
no list of modified paths is returned.
1845
new_paths = self.new_paths(filesystem_only=True)
1847
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1849
with ui.ui_factory.nested_progress_bar() as child_pb:
1850
for num, (path, trans_id) in enumerate(new_paths):
1852
child_pb.update(gettext('adding file'), num, len(new_paths))
1853
full_path = self._tree.abspath(path)
1854
if trans_id in self._needs_rename:
1856
mover.rename(self._limbo_name(trans_id), full_path)
1857
except errors.TransformRenameFailed as e:
1858
# We may be renaming a dangling inventory id
1859
if e.errno != errno.ENOENT:
1862
self.rename_count += 1
1863
# TODO: if trans_id in self._observed_sha1s, we should
1864
# re-stat the final target, since ctime will be
1865
# updated by the change.
1866
if (trans_id in self._new_contents or
1867
self.path_changed(trans_id)):
1868
if trans_id in self._new_contents:
1869
modified_paths.append(full_path)
1870
if trans_id in self._new_executability:
1871
self._set_executability(path, trans_id)
1872
if trans_id in self._observed_sha1s:
1873
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1874
st = osutils.lstat(full_path)
1875
self._observed_sha1s[trans_id] = (o_sha1, st)
1876
for path, trans_id in new_paths:
1877
# new_paths includes stuff like workingtree conflicts. Only the
1878
# stuff in new_contents actually comes from limbo.
1879
if trans_id in self._limbo_files:
1880
del self._limbo_files[trans_id]
1881
self._new_contents.clear()
1882
return modified_paths
1884
def _apply_observed_sha1s(self):
1885
"""After we have finished renaming everything, update observed sha1s
1887
This has to be done after self._tree.apply_inventory_delta, otherwise
1888
it doesn't know anything about the files we are updating. Also, we want
1889
to do this as late as possible, so that most entries end up cached.
1891
# TODO: this doesn't update the stat information for directories. So
1892
# the first 'bzr status' will still need to rewrite
1893
# .bzr/checkout/dirstate. However, we at least don't need to
1894
# re-read all of the files.
1895
# TODO: If the operation took a while, we could do a time.sleep(3) here
1896
# to allow the clock to tick over and ensure we won't have any
1897
# problems. (we could observe start time, and finish time, and if
1898
# it is less than eg 10% overhead, add a sleep call.)
1899
paths = FinalPaths(self)
1900
for trans_id, observed in viewitems(self._observed_sha1s):
1901
path = paths.get_path(trans_id)
1902
# We could get the file_id, but dirstate prefers to use the path
1903
# anyway, and it is 'cheaper' to determine.
1904
# file_id = self._new_id[trans_id]
1905
self._tree._observed_sha1(None, path, observed)
1908
class TransformPreview(DiskTreeTransform):
1909
"""A TreeTransform for generating preview trees.
1911
Unlike TreeTransform, this version works when the input tree is a
1912
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1913
unversioned files in the input tree.
1916
def __init__(self, tree, pb=None, case_sensitive=True):
1918
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1919
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1921
def canonical_path(self, path):
1924
def tree_kind(self, trans_id):
1925
path = self._tree_id_paths.get(trans_id)
1928
kind = self._tree.path_content_summary(path)[0]
1929
if kind == 'missing':
1933
def _set_mode(self, trans_id, mode_id, typefunc):
1934
"""Set the mode of new file contents.
1935
The mode_id is the existing file to get the mode from (often the same
1936
as trans_id). The operation is only performed if there's a mode match
1937
according to typefunc.
1939
# is it ok to ignore this? probably
1942
def iter_tree_children(self, parent_id):
1943
"""Iterate through the entry's tree children, if any"""
1945
path = self._tree_id_paths[parent_id]
1948
entry = next(self._tree.iter_entries_by_dir(
1949
specific_files=[path]))[1]
1950
children = getattr(entry, 'children', {})
1951
for child in children:
1952
childpath = joinpath(path, child)
1953
yield self.trans_id_tree_path(childpath)
1955
def new_orphan(self, trans_id, parent_id):
1956
raise NotImplementedError(self.new_orphan)
1959
class _PreviewTree(inventorytree.InventoryTree):
1960
"""Partial implementation of Tree to support show_diff_trees"""
1962
def __init__(self, transform):
1963
self._transform = transform
1964
self._final_paths = FinalPaths(transform)
1965
self.__by_parent = None
1966
self._parent_ids = []
1967
self._all_children_cache = {}
1968
self._path2trans_id_cache = {}
1969
self._final_name_cache = {}
1970
self._iter_changes_cache = dict((c[0], c) for c in
1971
self._transform.iter_changes())
1973
def _content_change(self, file_id):
1974
"""Return True if the content of this file changed"""
1975
changes = self._iter_changes_cache.get(file_id)
1976
# changes[2] is true if the file content changed. See
1977
# InterTree.iter_changes.
1978
return (changes is not None and changes[2])
1980
def _get_repository(self):
1981
repo = getattr(self._transform._tree, '_repository', None)
1983
repo = self._transform._tree.branch.repository
1986
def _iter_parent_trees(self):
1987
for revision_id in self.get_parent_ids():
1989
yield self.revision_tree(revision_id)
1990
except errors.NoSuchRevisionInTree:
1991
yield self._get_repository().revision_tree(revision_id)
1993
def _get_file_revision(self, path, file_id, vf, tree_revision):
1995
(file_id, t.get_file_revision(t.id2path(file_id), file_id))
1996
for t in self._iter_parent_trees()]
1997
vf.add_lines((file_id, tree_revision), parent_keys,
1998
self.get_file_lines(path, file_id))
1999
repo = self._get_repository()
2000
base_vf = repo.texts
2001
if base_vf not in vf.fallback_versionedfiles:
2002
vf.fallback_versionedfiles.append(base_vf)
2003
return tree_revision
2005
def _stat_limbo_file(self, trans_id):
2006
name = self._transform._limbo_name(trans_id)
2007
return os.lstat(name)
2010
def _by_parent(self):
2011
if self.__by_parent is None:
2012
self.__by_parent = self._transform.by_parent()
2013
return self.__by_parent
2015
def _comparison_data(self, entry, path):
2016
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2017
if kind == 'missing':
2021
file_id = self._transform.final_file_id(self._path2trans_id(path))
2022
executable = self.is_executable(path, file_id)
2023
return kind, executable, None
2025
def is_locked(self):
2028
def lock_read(self):
2029
# Perhaps in theory, this should lock the TreeTransform?
2030
return lock.LogicalLockResult(self.unlock)
2036
def root_inventory(self):
2037
"""This Tree does not use inventory as its backing data."""
2038
raise NotImplementedError(_PreviewTree.root_inventory)
2040
def get_root_id(self):
2041
return self._transform.final_file_id(self._transform.root)
2043
def all_file_ids(self):
2044
tree_ids = set(self._transform._tree.all_file_ids())
2045
tree_ids.difference_update(self._transform.tree_file_id(t)
2046
for t in self._transform._removed_id)
2047
tree_ids.update(viewvalues(self._transform._new_id))
2050
def all_versioned_paths(self):
2051
return {self.id2path(fid) for fid in self.all_file_ids()}
2053
def _has_id(self, file_id, fallback_check):
2054
if file_id in self._transform._r_new_id:
2056
elif file_id in {self._transform.tree_file_id(trans_id) for
2057
trans_id in self._transform._removed_id}:
2060
return fallback_check(file_id)
2062
def has_id(self, file_id):
2063
return self._has_id(file_id, self._transform._tree.has_id)
2065
def has_or_had_id(self, file_id):
2066
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2068
def _path2trans_id(self, path):
2069
# We must not use None here, because that is a valid value to store.
2070
trans_id = self._path2trans_id_cache.get(path, object)
2071
if trans_id is not object:
2073
segments = splitpath(path)
2074
cur_parent = self._transform.root
2075
for cur_segment in segments:
2076
for child in self._all_children(cur_parent):
2077
final_name = self._final_name_cache.get(child)
2078
if final_name is None:
2079
final_name = self._transform.final_name(child)
2080
self._final_name_cache[child] = final_name
2081
if final_name == cur_segment:
2085
self._path2trans_id_cache[path] = None
2087
self._path2trans_id_cache[path] = cur_parent
2090
def path2id(self, path):
2091
if isinstance(path, list):
2094
path = osutils.pathjoin(*path)
2095
return self._transform.final_file_id(self._path2trans_id(path))
2097
def id2path(self, file_id):
2098
trans_id = self._transform.trans_id_file_id(file_id)
2100
return self._final_paths._determine_path(trans_id)
2102
raise errors.NoSuchId(self, file_id)
2104
def _all_children(self, trans_id):
2105
children = self._all_children_cache.get(trans_id)
2106
if children is not None:
2108
children = set(self._transform.iter_tree_children(trans_id))
2109
# children in the _new_parent set are provided by _by_parent.
2110
children.difference_update(self._transform._new_parent)
2111
children.update(self._by_parent.get(trans_id, []))
2112
self._all_children_cache[trans_id] = children
2115
def _iter_children(self, file_id):
2116
trans_id = self._transform.trans_id_file_id(file_id)
2117
for child_trans_id in self._all_children(trans_id):
2118
yield self._transform.final_file_id(child_trans_id)
2121
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2122
in self._transform._tree.extras())
2123
possible_extras.update(self._transform._new_contents)
2124
possible_extras.update(self._transform._removed_id)
2125
for trans_id in possible_extras:
2126
if self._transform.final_file_id(trans_id) is None:
2127
yield self._final_paths._determine_path(trans_id)
2129
def _make_inv_entries(self, ordered_entries, specific_files=None):
2130
for trans_id, parent_file_id in ordered_entries:
2131
file_id = self._transform.final_file_id(trans_id)
2134
if (specific_files is not None and
2135
unicode(self._final_paths.get_path(trans_id)) not in specific_files):
2137
kind = self._transform.final_kind(trans_id)
2139
kind = self._transform._tree.stored_kind(
2140
self._transform._tree.id2path(file_id),
2142
new_entry = inventory.make_entry(
2144
self._transform.final_name(trans_id),
2145
parent_file_id, file_id)
2146
yield new_entry, trans_id
2148
def _list_files_by_dir(self):
2149
todo = [ROOT_PARENT]
2151
while len(todo) > 0:
2153
parent_file_id = self._transform.final_file_id(parent)
2154
children = list(self._all_children(parent))
2155
paths = dict(zip(children, self._final_paths.get_paths(children)))
2156
children.sort(key=paths.get)
2157
todo.extend(reversed(children))
2158
for trans_id in children:
2159
ordered_ids.append((trans_id, parent_file_id))
2162
def iter_child_entries(self, path, file_id=None):
2163
trans_id = self._path2trans_id(path)
2164
if trans_id is None:
2165
raise errors.NoSuchFile(path)
2166
todo = [(child_trans_id, trans_id) for child_trans_id in
2167
self._all_children(trans_id)]
2168
for entry, trans_id in self._make_inv_entries(todo):
2171
def iter_entries_by_dir(self, specific_files=None):
2172
# This may not be a maximally efficient implementation, but it is
2173
# reasonably straightforward. An implementation that grafts the
2174
# TreeTransform changes onto the tree's iter_entries_by_dir results
2175
# might be more efficient, but requires tricky inferences about stack
2177
ordered_ids = self._list_files_by_dir()
2178
for entry, trans_id in self._make_inv_entries(ordered_ids,
2180
yield unicode(self._final_paths.get_path(trans_id)), entry
2182
def _iter_entries_for_dir(self, dir_path):
2183
"""Return path, entry for items in a directory without recursing down."""
2185
dir_trans_id = self._path2trans_id(dir_path)
2186
dir_id = self._transform.final_file_id(dir_trans_id)
2187
for child_trans_id in self._all_children(dir_trans_id):
2188
ordered_ids.append((child_trans_id, dir_id))
2189
for entry, trans_id in self._make_inv_entries(ordered_ids):
2190
yield unicode(self._final_paths.get_path(trans_id)), entry
2192
def list_files(self, include_root=False, from_dir=None, recursive=True):
2193
"""See WorkingTree.list_files."""
2194
# XXX This should behave like WorkingTree.list_files, but is really
2195
# more like RevisionTree.list_files.
2199
prefix = from_dir + '/'
2200
entries = self.iter_entries_by_dir()
2201
for path, entry in entries:
2202
if entry.name == '' and not include_root:
2205
if not path.startswith(prefix):
2207
path = path[len(prefix):]
2208
yield path, 'V', entry.kind, entry.file_id, entry
2210
if from_dir is None and include_root is True:
2211
root_entry = inventory.make_entry('directory', '',
2212
ROOT_PARENT, self.get_root_id())
2213
yield '', 'V', 'directory', root_entry.file_id, root_entry
2214
entries = self._iter_entries_for_dir(from_dir or '')
2215
for path, entry in entries:
2216
yield path, 'V', entry.kind, entry.file_id, entry
2218
def kind(self, path, file_id=None):
2219
trans_id = self._path2trans_id(path)
2220
if trans_id is None:
2221
raise errors.NoSuchFile(path)
2222
return self._transform.final_kind(trans_id)
2224
def stored_kind(self, path, file_id=None):
2225
trans_id = self._path2trans_id(path)
2226
if trans_id is None:
2227
raise errors.NoSuchFile(path)
2229
return self._transform._new_contents[trans_id]
2231
return self._transform._tree.stored_kind(path, file_id)
2233
def get_file_mtime(self, path, file_id=None):
2234
"""See Tree.get_file_mtime"""
2236
file_id = self.path2id(path)
2238
raise errors.NoSuchFile(path)
2239
if not self._content_change(file_id):
2240
return self._transform._tree.get_file_mtime(
2241
self._transform._tree.id2path(file_id), file_id)
2242
trans_id = self._path2trans_id(path)
2243
return self._stat_limbo_file(trans_id).st_mtime
2245
def get_file_size(self, path, file_id=None):
2246
"""See Tree.get_file_size"""
2247
trans_id = self._path2trans_id(path)
2248
if trans_id is None:
2249
raise errors.NoSuchFile(path)
2250
kind = self._transform.final_kind(trans_id)
2253
if trans_id in self._transform._new_contents:
2254
return self._stat_limbo_file(trans_id).st_size
2255
if self.kind(path, file_id) == 'file':
2256
return self._transform._tree.get_file_size(path, file_id)
2260
def get_file_verifier(self, path, file_id=None, stat_value=None):
2261
trans_id = self._path2trans_id(path)
2262
if trans_id is None:
2263
raise errors.NoSuchFile(path)
2264
kind = self._transform._new_contents.get(trans_id)
2266
return self._transform._tree.get_file_verifier(path, file_id)
2268
fileobj = self.get_file(path, file_id)
2270
return ("SHA1", sha_file(fileobj))
2274
def get_file_sha1(self, path, file_id=None, stat_value=None):
2275
trans_id = self._path2trans_id(path)
2276
if trans_id is None:
2277
raise errors.NoSuchFile(path)
2278
kind = self._transform._new_contents.get(trans_id)
2280
return self._transform._tree.get_file_sha1(path, file_id)
2282
fileobj = self.get_file(path, file_id)
2284
return sha_file(fileobj)
2288
def is_executable(self, path, file_id=None):
2289
trans_id = self._path2trans_id(path)
2290
if trans_id is None:
2293
return self._transform._new_executability[trans_id]
2296
return self._transform._tree.is_executable(path, file_id)
2297
except OSError as e:
2298
if e.errno == errno.ENOENT:
2301
except errors.NoSuchFile:
2304
def has_filename(self, path):
2305
trans_id = self._path2trans_id(path)
2306
if trans_id in self._transform._new_contents:
2308
elif trans_id in self._transform._removed_contents:
2311
return self._transform._tree.has_filename(path)
2313
def path_content_summary(self, path):
2314
trans_id = self._path2trans_id(path)
2315
tt = self._transform
2316
tree_path = tt._tree_id_paths.get(trans_id)
2317
kind = tt._new_contents.get(trans_id)
2319
if tree_path is None or trans_id in tt._removed_contents:
2320
return 'missing', None, None, None
2321
summary = tt._tree.path_content_summary(tree_path)
2322
kind, size, executable, link_or_sha1 = summary
2325
limbo_name = tt._limbo_name(trans_id)
2326
if trans_id in tt._new_reference_revision:
2327
kind = 'tree-reference'
2329
statval = os.lstat(limbo_name)
2330
size = statval.st_size
2331
if not tt._limbo_supports_executable():
2334
executable = statval.st_mode & S_IEXEC
2338
if kind == 'symlink':
2339
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2340
executable = tt._new_executability.get(trans_id, executable)
2341
return kind, size, executable, link_or_sha1
2343
def iter_changes(self, from_tree, include_unchanged=False,
2344
specific_files=None, pb=None, extra_trees=None,
2345
require_versioned=True, want_unversioned=False):
2346
"""See InterTree.iter_changes.
2348
This has a fast path that is only used when the from_tree matches
2349
the transform tree, and no fancy options are supplied.
2351
if (from_tree is not self._transform._tree or include_unchanged or
2352
specific_files or want_unversioned):
2353
return tree.InterTree(from_tree, self).iter_changes(
2354
include_unchanged=include_unchanged,
2355
specific_files=specific_files,
2357
extra_trees=extra_trees,
2358
require_versioned=require_versioned,
2359
want_unversioned=want_unversioned)
2360
if want_unversioned:
2361
raise ValueError('want_unversioned is not supported')
2362
return self._transform.iter_changes()
2364
def get_file(self, path, file_id=None):
2365
"""See Tree.get_file"""
2367
file_id = self.path2id(path)
2368
if not self._content_change(file_id):
2369
return self._transform._tree.get_file(path, file_id)
2370
trans_id = self._path2trans_id(path)
2371
name = self._transform._limbo_name(trans_id)
2372
return open(name, 'rb')
2374
def get_file_with_stat(self, path, file_id=None):
2375
return self.get_file(path, file_id), None
2377
def annotate_iter(self, path, file_id=None,
2378
default_revision=_mod_revision.CURRENT_REVISION):
2380
file_id = self.path2id(path)
2381
changes = self._iter_changes_cache.get(file_id)
2385
changed_content, versioned, kind = (changes[2], changes[3],
2389
get_old = (kind[0] == 'file' and versioned[0])
2391
old_annotation = self._transform._tree.annotate_iter(
2392
path, file_id=file_id, default_revision=default_revision)
2396
return old_annotation
2397
if not changed_content:
2398
return old_annotation
2399
# TODO: This is doing something similar to what WT.annotate_iter is
2400
# doing, however it fails slightly because it doesn't know what
2401
# the *other* revision_id is, so it doesn't know how to give the
2402
# other as the origin for some lines, they all get
2403
# 'default_revision'
2404
# It would be nice to be able to use the new Annotator based
2405
# approach, as well.
2406
return annotate.reannotate([old_annotation],
2407
self.get_file(path, file_id).readlines(),
2410
def get_symlink_target(self, path, file_id=None):
2411
"""See Tree.get_symlink_target"""
2413
file_id = self.path2id(path)
2414
if not self._content_change(file_id):
2415
return self._transform._tree.get_symlink_target(path)
2416
trans_id = self._path2trans_id(path)
2417
name = self._transform._limbo_name(trans_id)
2418
return osutils.readlink(name)
2420
def walkdirs(self, prefix=''):
2421
pending = [self._transform.root]
2422
while len(pending) > 0:
2423
parent_id = pending.pop()
2426
prefix = prefix.rstrip('/')
2427
parent_path = self._final_paths.get_path(parent_id)
2428
parent_file_id = self._transform.final_file_id(parent_id)
2429
for child_id in self._all_children(parent_id):
2430
path_from_root = self._final_paths.get_path(child_id)
2431
basename = self._transform.final_name(child_id)
2432
file_id = self._transform.final_file_id(child_id)
2433
kind = self._transform.final_kind(child_id)
2434
if kind is not None:
2435
versioned_kind = kind
2438
versioned_kind = self._transform._tree.stored_kind(
2439
self._transform._tree.id2path(file_id),
2441
if versioned_kind == 'directory':
2442
subdirs.append(child_id)
2443
children.append((path_from_root, basename, kind, None,
2444
file_id, versioned_kind))
2446
if parent_path.startswith(prefix):
2447
yield (parent_path, parent_file_id), children
2448
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2451
def get_parent_ids(self):
2452
return self._parent_ids
2454
def set_parent_ids(self, parent_ids):
2455
self._parent_ids = parent_ids
2457
def get_revision_tree(self, revision_id):
2458
return self._transform._tree.get_revision_tree(revision_id)
2461
def joinpath(parent, child):
2462
"""Join tree-relative paths, handling the tree root specially"""
2463
if parent is None or parent == "":
2466
return pathjoin(parent, child)
2469
class FinalPaths(object):
2470
"""Make path calculation cheap by memoizing paths.
2472
The underlying tree must not be manipulated between calls, or else
2473
the results will likely be incorrect.
2475
def __init__(self, transform):
2476
object.__init__(self)
2477
self._known_paths = {}
2478
self.transform = transform
2480
def _determine_path(self, trans_id):
2481
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2483
name = self.transform.final_name(trans_id)
2484
parent_id = self.transform.final_parent(trans_id)
2485
if parent_id == self.transform.root:
2488
return pathjoin(self.get_path(parent_id), name)
2490
def get_path(self, trans_id):
2491
"""Find the final path associated with a trans_id"""
2492
if trans_id not in self._known_paths:
2493
self._known_paths[trans_id] = self._determine_path(trans_id)
2494
return self._known_paths[trans_id]
2496
def get_paths(self, trans_ids):
2497
return [(self.get_path(t), t) for t in trans_ids]
2501
def topology_sorted_ids(tree):
2502
"""Determine the topological order of the ids in a tree"""
2503
file_ids = list(tree)
2504
file_ids.sort(key=tree.id2path)
2508
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2509
delta_from_tree=False):
2510
"""Create working tree for a branch, using a TreeTransform.
2512
This function should be used on empty trees, having a tree root at most.
2513
(see merge and revert functionality for working with existing trees)
2515
Existing files are handled like so:
2517
- Existing bzrdirs take precedence over creating new items. They are
2518
created as '%s.diverted' % name.
2519
- Otherwise, if the content on disk matches the content we are building,
2520
it is silently replaced.
2521
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2523
:param tree: The tree to convert wt into a copy of
2524
:param wt: The working tree that files will be placed into
2525
:param accelerator_tree: A tree which can be used for retrieving file
2526
contents more quickly than tree itself, i.e. a workingtree. tree
2527
will be used for cases where accelerator_tree's content is different.
2528
:param hardlink: If true, hard-link files to accelerator_tree, where
2529
possible. accelerator_tree must implement abspath, i.e. be a
2531
:param delta_from_tree: If true, build_tree may use the input Tree to
2532
generate the inventory delta.
2534
with wt.lock_tree_write(), tree.lock_read():
2535
if accelerator_tree is not None:
2536
accelerator_tree.lock_read()
2538
return _build_tree(tree, wt, accelerator_tree, hardlink,
2541
if accelerator_tree is not None:
2542
accelerator_tree.unlock()
2545
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2546
"""See build_tree."""
2547
for num, _unused in enumerate(wt.all_versioned_paths()):
2548
if num > 0: # more than just a root
2549
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2551
top_pb = ui.ui_factory.nested_progress_bar()
2552
pp = ProgressPhase("Build phase", 2, top_pb)
2553
if tree.get_root_id() is not None:
2554
# This is kind of a hack: we should be altering the root
2555
# as part of the regular tree shape diff logic.
2556
# The conditional test here is to avoid doing an
2557
# expensive operation (flush) every time the root id
2558
# is set within the tree, nor setting the root and thus
2559
# marking the tree as dirty, because we use two different
2560
# idioms here: tree interfaces and inventory interfaces.
2561
if wt.get_root_id() != tree.get_root_id():
2562
wt.set_root_id(tree.get_root_id())
2564
tt = TreeTransform(wt)
2568
file_trans_id[wt.get_root_id()] = tt.trans_id_tree_path('')
2569
with ui.ui_factory.nested_progress_bar() as pb:
2570
deferred_contents = []
2572
total = len(tree.all_versioned_paths())
2574
precomputed_delta = []
2576
precomputed_delta = None
2577
# Check if tree inventory has content. If so, we populate
2578
# existing_files with the directory content. If there are no
2579
# entries we skip populating existing_files as its not used.
2580
# This improves performance and unncessary work on large
2581
# directory trees. (#501307)
2583
existing_files = set()
2584
for dir, files in wt.walkdirs():
2585
existing_files.update(f[0] for f in files)
2586
for num, (tree_path, entry) in \
2587
enumerate(tree.iter_entries_by_dir()):
2588
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2589
if entry.parent_id is None:
2592
file_id = entry.file_id
2594
precomputed_delta.append((None, tree_path, file_id, entry))
2595
if tree_path in existing_files:
2596
target_path = wt.abspath(tree_path)
2597
kind = file_kind(target_path)
2598
if kind == "directory":
2600
controldir.ControlDir.open(target_path)
2601
except errors.NotBranchError:
2605
if (file_id not in divert and
2606
_content_match(tree, entry, tree_path, file_id, kind,
2608
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2609
if kind == 'directory':
2611
parent_id = file_trans_id[entry.parent_id]
2612
if entry.kind == 'file':
2613
# We *almost* replicate new_by_entry, so that we can defer
2614
# getting the file text, and get them all at once.
2615
trans_id = tt.create_path(entry.name, parent_id)
2616
file_trans_id[file_id] = trans_id
2617
tt.version_file(file_id, trans_id)
2618
executable = tree.is_executable(tree_path, file_id)
2620
tt.set_executability(executable, trans_id)
2621
trans_data = (trans_id, file_id, tree_path, entry.text_sha1)
2622
deferred_contents.append((tree_path, trans_data))
2624
file_trans_id[file_id] = new_by_entry(
2625
tree_path, tt, entry, parent_id, tree)
2627
new_trans_id = file_trans_id[file_id]
2628
old_parent = tt.trans_id_tree_path(tree_path)
2629
_reparent_children(tt, old_parent, new_trans_id)
2630
offset = num + 1 - len(deferred_contents)
2631
_create_files(tt, tree, deferred_contents, pb, offset,
2632
accelerator_tree, hardlink)
2634
divert_trans = set(file_trans_id[f] for f in divert)
2635
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2636
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2637
if len(raw_conflicts) > 0:
2638
precomputed_delta = None
2639
conflicts = cook_conflicts(raw_conflicts, tt)
2640
for conflict in conflicts:
2641
trace.warning(unicode(conflict))
2643
wt.add_conflicts(conflicts)
2644
except errors.UnsupportedOperation:
2646
result = tt.apply(no_conflicts=True,
2647
precomputed_delta=precomputed_delta)
2654
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2656
total = len(desired_files) + offset
2658
if accelerator_tree is None:
2659
new_desired_files = desired_files
2661
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2662
unchanged = [(p[0], p[1]) for (f, p, c, v, d, n, k, e)
2663
in iter if not (c or e[0] != e[1])]
2664
if accelerator_tree.supports_content_filtering():
2665
unchanged = [(tp, ap) for (tp, ap) in unchanged
2666
if not next(accelerator_tree.iter_search_rules([ap]))]
2667
unchanged = dict(unchanged)
2668
new_desired_files = []
2670
for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
2671
accelerator_path = unchanged.get(tree_path)
2672
if accelerator_path is None:
2673
new_desired_files.append((tree_path,
2674
(trans_id, file_id, tree_path, text_sha1)))
2676
pb.update(gettext('Adding file contents'), count + offset, total)
2678
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2681
contents = accelerator_tree.get_file(accelerator_path, file_id)
2682
if wt.supports_content_filtering():
2683
filters = wt._content_filter_stack(tree_path)
2684
contents = filtered_output_bytes(contents, filters,
2685
ContentFilterContext(tree_path, tree))
2687
tt.create_file(contents, trans_id, sha1=text_sha1)
2691
except AttributeError:
2692
# after filtering, contents may no longer be file-like
2696
for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2697
tree.iter_files_bytes(new_desired_files)):
2698
if wt.supports_content_filtering():
2699
filters = wt._content_filter_stack(tree_path)
2700
contents = filtered_output_bytes(contents, filters,
2701
ContentFilterContext(tree_path, tree))
2702
tt.create_file(contents, trans_id, sha1=text_sha1)
2703
pb.update(gettext('Adding file contents'), count + offset, total)
2706
def _reparent_children(tt, old_parent, new_parent):
2707
for child in tt.iter_tree_children(old_parent):
2708
tt.adjust_path(tt.final_name(child), new_parent, child)
2711
def _reparent_transform_children(tt, old_parent, new_parent):
2712
by_parent = tt.by_parent()
2713
for child in by_parent[old_parent]:
2714
tt.adjust_path(tt.final_name(child), new_parent, child)
2715
return by_parent[old_parent]
2718
def _content_match(tree, entry, tree_path, file_id, kind, target_path):
2719
if entry.kind != kind:
2721
if entry.kind == "directory":
2723
if entry.kind == "file":
2724
f = file(target_path, 'rb')
2726
if tree.get_file_text(tree_path, file_id) == f.read():
2730
elif entry.kind == "symlink":
2731
if tree.get_symlink_target(tree_path, file_id) == os.readlink(target_path):
2736
def resolve_checkout(tt, conflicts, divert):
2737
new_conflicts = set()
2738
for c_type, conflict in ((c[0], c) for c in conflicts):
2739
# Anything but a 'duplicate' would indicate programmer error
2740
if c_type != 'duplicate':
2741
raise AssertionError(c_type)
2742
# Now figure out which is new and which is old
2743
if tt.new_contents(conflict[1]):
2744
new_file = conflict[1]
2745
old_file = conflict[2]
2747
new_file = conflict[2]
2748
old_file = conflict[1]
2750
# We should only get here if the conflict wasn't completely
2752
final_parent = tt.final_parent(old_file)
2753
if new_file in divert:
2754
new_name = tt.final_name(old_file)+'.diverted'
2755
tt.adjust_path(new_name, final_parent, new_file)
2756
new_conflicts.add((c_type, 'Diverted to',
2757
new_file, old_file))
2759
new_name = tt.final_name(old_file)+'.moved'
2760
tt.adjust_path(new_name, final_parent, old_file)
2761
new_conflicts.add((c_type, 'Moved existing file to',
2762
old_file, new_file))
2763
return new_conflicts
2766
def new_by_entry(path, tt, entry, parent_id, tree):
2767
"""Create a new file according to its inventory entry"""
2771
contents = tree.get_file(path, entry.file_id).readlines()
2772
executable = tree.is_executable(path, entry.file_id)
2773
return tt.new_file(name, parent_id, contents, entry.file_id,
2775
elif kind in ('directory', 'tree-reference'):
2776
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2777
if kind == 'tree-reference':
2778
tt.set_tree_reference(entry.reference_revision, trans_id)
2780
elif kind == 'symlink':
2781
target = tree.get_symlink_target(path, entry.file_id)
2782
return tt.new_symlink(name, parent_id, target, entry.file_id)
2784
raise errors.BadFileKindError(name, kind)
2787
def create_from_tree(tt, trans_id, tree, path, file_id=None, bytes=None,
2788
filter_tree_path=None):
2789
"""Create new file contents according to tree contents.
2791
:param filter_tree_path: the tree path to use to lookup
2792
content filters to apply to the bytes output in the working tree.
2793
This only applies if the working tree supports content filtering.
2795
kind = tree.kind(path, file_id)
2796
if kind == 'directory':
2797
tt.create_directory(trans_id)
2798
elif kind == "file":
2800
tree_file = tree.get_file(path, file_id)
2802
bytes = tree_file.readlines()
2806
if wt.supports_content_filtering() and filter_tree_path is not None:
2807
filters = wt._content_filter_stack(filter_tree_path)
2808
bytes = filtered_output_bytes(bytes, filters,
2809
ContentFilterContext(filter_tree_path, tree))
2810
tt.create_file(bytes, trans_id)
2811
elif kind == "symlink":
2812
tt.create_symlink(tree.get_symlink_target(path, file_id), trans_id)
2814
raise AssertionError('Unknown kind %r' % kind)
2817
def create_entry_executability(tt, entry, trans_id):
2818
"""Set the executability of a trans_id according to an inventory entry"""
2819
if entry.kind == "file":
2820
tt.set_executability(entry.executable, trans_id)
2823
def revert(working_tree, target_tree, filenames, backups=False,
2824
pb=None, change_reporter=None):
2825
"""Revert a working tree's contents to those of a target tree."""
2826
pb = ui.ui_factory.nested_progress_bar()
2828
with target_tree.lock_read(), TreeTransform(working_tree, pb) as tt:
2829
pp = ProgressPhase("Revert phase", 3, pb)
2830
conflicts, merge_modified = _prepare_revert_transform(
2831
working_tree, target_tree, tt, filenames, backups, pp)
2833
change_reporter = delta._ChangeReporter(
2834
unversioned_filter=working_tree.is_ignored)
2835
delta.report_changes(tt.iter_changes(), change_reporter)
2836
for conflict in conflicts:
2837
trace.warning(unicode(conflict))
2840
if working_tree.supports_merge_modified():
2841
working_tree.set_merge_modified(merge_modified)
2847
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2848
backups, pp, basis_tree=None,
2849
merge_modified=None):
2850
with ui.ui_factory.nested_progress_bar() as child_pb:
2851
if merge_modified is None:
2852
merge_modified = working_tree.merge_modified()
2853
merge_modified = _alter_files(working_tree, target_tree, tt,
2854
child_pb, filenames, backups,
2855
merge_modified, basis_tree)
2856
with ui.ui_factory.nested_progress_bar() as child_pb:
2857
raw_conflicts = resolve_conflicts(tt, child_pb,
2858
lambda t, c: conflict_pass(t, c, target_tree))
2859
conflicts = cook_conflicts(raw_conflicts, tt)
2860
return conflicts, merge_modified
2863
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2864
backups, merge_modified, basis_tree=None):
2865
if basis_tree is not None:
2866
basis_tree.lock_read()
2867
# We ask the working_tree for its changes relative to the target, rather
2868
# than the target changes relative to the working tree. Because WT4 has an
2869
# optimizer to compare itself to a target, but no optimizer for the
2871
change_list = working_tree.iter_changes(target_tree,
2872
specific_files=specific_files, pb=pb)
2873
if not target_tree.is_versioned(u''):
2879
for id_num, (file_id, path, changed_content, versioned, parent, name,
2880
kind, executable) in enumerate(change_list):
2881
target_path, wt_path = path
2882
target_versioned, wt_versioned = versioned
2883
target_parent, wt_parent = parent
2884
target_name, wt_name = name
2885
target_kind, wt_kind = kind
2886
target_executable, wt_executable = executable
2887
if skip_root and wt_parent is None:
2889
trans_id = tt.trans_id_file_id(file_id)
2892
keep_content = False
2893
if wt_kind == 'file' and (backups or target_kind is None):
2894
wt_sha1 = working_tree.get_file_sha1(wt_path, file_id)
2895
if merge_modified.get(file_id) != wt_sha1:
2896
# acquire the basis tree lazily to prevent the
2897
# expense of accessing it when it's not needed ?
2898
# (Guessing, RBC, 200702)
2899
if basis_tree is None:
2900
basis_tree = working_tree.basis_tree()
2901
basis_tree.lock_read()
2902
basis_path = find_previous_path(working_tree, basis_tree, wt_path)
2903
if basis_path is None:
2904
if target_kind is None and not target_versioned:
2907
if wt_sha1 != basis_tree.get_file_sha1(basis_path, file_id):
2909
if wt_kind is not None:
2910
if not keep_content:
2911
tt.delete_contents(trans_id)
2912
elif target_kind is not None:
2913
parent_trans_id = tt.trans_id_file_id(wt_parent)
2914
backup_name = tt._available_backup_name(
2915
wt_name, parent_trans_id)
2916
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2917
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2918
if wt_versioned and target_versioned:
2919
tt.unversion_file(trans_id)
2920
tt.version_file(file_id, new_trans_id)
2921
# New contents should have the same unix perms as old
2924
trans_id = new_trans_id
2925
if target_kind in ('directory', 'tree-reference'):
2926
tt.create_directory(trans_id)
2927
if target_kind == 'tree-reference':
2928
revision = target_tree.get_reference_revision(
2929
target_path, file_id)
2930
tt.set_tree_reference(revision, trans_id)
2931
elif target_kind == 'symlink':
2932
tt.create_symlink(target_tree.get_symlink_target(
2933
target_path, file_id), trans_id)
2934
elif target_kind == 'file':
2935
deferred_files.append((target_path, (trans_id, mode_id, file_id)))
2936
if basis_tree is None:
2937
basis_tree = working_tree.basis_tree()
2938
basis_tree.lock_read()
2939
new_sha1 = target_tree.get_file_sha1(target_path, file_id)
2940
basis_path = find_previous_path(target_tree, basis_tree, target_path)
2941
if (basis_path is not None and
2942
new_sha1 == basis_tree.get_file_sha1(basis_path, file_id)):
2943
if file_id in merge_modified:
2944
del merge_modified[file_id]
2946
merge_modified[file_id] = new_sha1
2948
# preserve the execute bit when backing up
2949
if keep_content and wt_executable == target_executable:
2950
tt.set_executability(target_executable, trans_id)
2951
elif target_kind is not None:
2952
raise AssertionError(target_kind)
2953
if not wt_versioned and target_versioned:
2954
tt.version_file(file_id, trans_id)
2955
if wt_versioned and not target_versioned:
2956
tt.unversion_file(trans_id)
2957
if (target_name is not None and
2958
(wt_name != target_name or wt_parent != target_parent)):
2959
if target_name == '' and target_parent is None:
2960
parent_trans = ROOT_PARENT
2962
parent_trans = tt.trans_id_file_id(target_parent)
2963
if wt_parent is None and wt_versioned:
2964
tt.adjust_root_path(target_name, parent_trans)
2966
tt.adjust_path(target_name, parent_trans, trans_id)
2967
if wt_executable != target_executable and target_kind == "file":
2968
tt.set_executability(target_executable, trans_id)
2969
if working_tree.supports_content_filtering():
2970
for (trans_id, mode_id, file_id), bytes in (
2971
target_tree.iter_files_bytes(deferred_files)):
2972
# We're reverting a tree to the target tree so using the
2973
# target tree to find the file path seems the best choice
2974
# here IMO - Ian C 27/Oct/2009
2975
filter_tree_path = target_tree.id2path(file_id)
2976
filters = working_tree._content_filter_stack(filter_tree_path)
2977
bytes = filtered_output_bytes(bytes, filters,
2978
ContentFilterContext(filter_tree_path, working_tree))
2979
tt.create_file(bytes, trans_id, mode_id)
2981
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
2983
tt.create_file(bytes, trans_id, mode_id)
2984
tt.fixup_new_roots()
2986
if basis_tree is not None:
2988
return merge_modified
2991
def resolve_conflicts(tt, pb=None, pass_func=None):
2992
"""Make many conflict-resolution attempts, but die if they fail"""
2993
if pass_func is None:
2994
pass_func = conflict_pass
2995
new_conflicts = set()
2996
with ui.ui_factory.nested_progress_bar() as pb:
2998
pb.update(gettext('Resolution pass'), n+1, 10)
2999
conflicts = tt.find_conflicts()
3000
if len(conflicts) == 0:
3001
return new_conflicts
3002
new_conflicts.update(pass_func(tt, conflicts))
3003
raise MalformedTransform(conflicts=conflicts)
3006
def conflict_pass(tt, conflicts, path_tree=None):
3007
"""Resolve some classes of conflicts.
3009
:param tt: The transform to resolve conflicts in
3010
:param conflicts: The conflicts to resolve
3011
:param path_tree: A Tree to get supplemental paths from
3013
new_conflicts = set()
3014
for c_type, conflict in ((c[0], c) for c in conflicts):
3015
if c_type == 'duplicate id':
3016
tt.unversion_file(conflict[1])
3017
new_conflicts.add((c_type, 'Unversioned existing file',
3018
conflict[1], conflict[2], ))
3019
elif c_type == 'duplicate':
3020
# files that were renamed take precedence
3021
final_parent = tt.final_parent(conflict[1])
3022
if tt.path_changed(conflict[1]):
3023
existing_file, new_file = conflict[2], conflict[1]
3025
existing_file, new_file = conflict[1], conflict[2]
3026
new_name = tt.final_name(existing_file) + '.moved'
3027
tt.adjust_path(new_name, final_parent, existing_file)
3028
new_conflicts.add((c_type, 'Moved existing file to',
3029
existing_file, new_file))
3030
elif c_type == 'parent loop':
3031
# break the loop by undoing one of the ops that caused the loop
3033
while not tt.path_changed(cur):
3034
cur = tt.final_parent(cur)
3035
new_conflicts.add((c_type, 'Cancelled move', cur,
3036
tt.final_parent(cur),))
3037
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3039
elif c_type == 'missing parent':
3040
trans_id = conflict[1]
3041
if trans_id in tt._removed_contents:
3042
cancel_deletion = True
3043
orphans = tt._get_potential_orphans(trans_id)
3045
cancel_deletion = False
3046
# All children are orphans
3049
tt.new_orphan(o, trans_id)
3050
except OrphaningError:
3051
# Something bad happened so we cancel the directory
3052
# deletion which will leave it in place with a
3053
# conflict. The user can deal with it from there.
3054
# Note that this also catch the case where we don't
3055
# want to create orphans and leave the directory in
3057
cancel_deletion = True
3060
# Cancel the directory deletion
3061
tt.cancel_deletion(trans_id)
3062
new_conflicts.add(('deleting parent', 'Not deleting',
3067
tt.final_name(trans_id)
3069
if path_tree is not None:
3070
file_id = tt.final_file_id(trans_id)
3072
file_id = tt.inactive_file_id(trans_id)
3073
_, entry = next(path_tree.iter_entries_by_dir(
3074
specific_files=[path_tree.id2path(file_id)]))
3075
# special-case the other tree root (move its
3076
# children to current root)
3077
if entry.parent_id is None:
3079
moved = _reparent_transform_children(
3080
tt, trans_id, tt.root)
3082
new_conflicts.add((c_type, 'Moved to root',
3085
parent_trans_id = tt.trans_id_file_id(
3087
tt.adjust_path(entry.name, parent_trans_id,
3090
tt.create_directory(trans_id)
3091
new_conflicts.add((c_type, 'Created directory', trans_id))
3092
elif c_type == 'unversioned parent':
3093
file_id = tt.inactive_file_id(conflict[1])
3094
# special-case the other tree root (move its children instead)
3095
if path_tree and path_tree.path2id('') == file_id:
3096
# This is the root entry, skip it
3098
tt.version_file(file_id, conflict[1])
3099
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3100
elif c_type == 'non-directory parent':
3101
parent_id = conflict[1]
3102
parent_parent = tt.final_parent(parent_id)
3103
parent_name = tt.final_name(parent_id)
3104
parent_file_id = tt.final_file_id(parent_id)
3105
new_parent_id = tt.new_directory(parent_name + '.new',
3106
parent_parent, parent_file_id)
3107
_reparent_transform_children(tt, parent_id, new_parent_id)
3108
if parent_file_id is not None:
3109
tt.unversion_file(parent_id)
3110
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3111
elif c_type == 'versioning no contents':
3112
tt.cancel_versioning(conflict[1])
3113
return new_conflicts
3116
def cook_conflicts(raw_conflicts, tt):
3117
"""Generate a list of cooked conflicts, sorted by file path"""
3118
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3119
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3122
def iter_cook_conflicts(raw_conflicts, tt):
3124
for conflict in raw_conflicts:
3125
c_type = conflict[0]
3126
action = conflict[1]
3127
modified_path = fp.get_path(conflict[2])
3128
modified_id = tt.final_file_id(conflict[2])
3129
if len(conflict) == 3:
3130
yield conflicts.Conflict.factory(
3131
c_type, action=action, path=modified_path, file_id=modified_id)
3134
conflicting_path = fp.get_path(conflict[3])
3135
conflicting_id = tt.final_file_id(conflict[3])
3136
yield conflicts.Conflict.factory(
3137
c_type, action=action, path=modified_path,
3138
file_id=modified_id,
3139
conflict_path=conflicting_path,
3140
conflict_file_id=conflicting_id)
3143
class _FileMover(object):
3144
"""Moves and deletes files for TreeTransform, tracking operations"""
3147
self.past_renames = []
3148
self.pending_deletions = []
3150
def rename(self, from_, to):
3151
"""Rename a file from one path to another."""
3153
os.rename(from_, to)
3154
except OSError as e:
3155
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3156
raise errors.FileExists(to, str(e))
3157
# normal OSError doesn't include filenames so it's hard to see where
3158
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3159
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3160
self.past_renames.append((from_, to))
3162
def pre_delete(self, from_, to):
3163
"""Rename a file out of the way and mark it for deletion.
3165
Unlike os.unlink, this works equally well for files and directories.
3166
:param from_: The current file path
3167
:param to: A temporary path for the file
3169
self.rename(from_, to)
3170
self.pending_deletions.append(to)
3173
"""Reverse all renames that have been performed"""
3174
for from_, to in reversed(self.past_renames):
3176
os.rename(to, from_)
3177
except OSError as e:
3178
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3179
# after rollback, don't reuse _FileMover
3181
pending_deletions = None
3183
def apply_deletions(self):
3184
"""Apply all marked deletions"""
3185
for path in self.pending_deletions:
3187
# after apply_deletions, don't reuse _FileMover
3189
pending_deletions = None
3192
def link_tree(target_tree, source_tree):
3193
"""Where possible, hard-link files in a tree to those in another tree.
3195
:param target_tree: Tree to change
3196
:param source_tree: Tree to hard-link from
3198
tt = TreeTransform(target_tree)
3200
for (file_id, paths, changed_content, versioned, parent, name, kind,
3201
executable) in target_tree.iter_changes(source_tree,
3202
include_unchanged=True):
3205
if kind != ('file', 'file'):
3207
if executable[0] != executable[1]:
3209
trans_id = tt.trans_id_tree_path(paths[1])
3210
tt.delete_contents(trans_id)
3211
tt.create_hardlink(source_tree.abspath(paths[0]), trans_id)
added
removed
breezy/transform.py
