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
31
lazy_import.lazy_import(globals(), """
42
revision as _mod_revision,
46
from bzrlib.i18n import gettext
48
from bzrlib.errors import (DuplicateKey, MalformedTransform,
49
ReusingTransform, CantMoveRoot,
50
ImmortalLimbo, NoFinalPath,
52
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
53
from bzrlib.mutabletree import MutableTree
54
from bzrlib.osutils import (
62
from bzrlib.progress import ProgressPhase
63
from bzrlib.symbol_versioning import (
70
ROOT_PARENT = "root-parent"
72
def unique_add(map, key, value):
74
raise DuplicateKey(key=key)
79
class _TransformResults(object):
80
def __init__(self, modified_paths, rename_count):
82
self.modified_paths = modified_paths
83
self.rename_count = rename_count
86
class TreeTransformBase(object):
87
"""The base class for TreeTransform and its kin."""
89
def __init__(self, tree, pb=None,
93
:param tree: The tree that will be transformed, but not necessarily
96
:param case_sensitive: If True, the target of the transform is
97
case sensitive, not just case preserving.
102
# mapping of trans_id -> new basename
104
# mapping of trans_id -> new parent trans_id
105
self._new_parent = {}
106
# mapping of trans_id with new contents -> new file_kind
107
self._new_contents = {}
108
# mapping of trans_id => (sha1 of content, stat_value)
109
self._observed_sha1s = {}
110
# Set of trans_ids whose contents will be removed
111
self._removed_contents = set()
112
# Mapping of trans_id -> new execute-bit value
113
self._new_executability = {}
114
# Mapping of trans_id -> new tree-reference value
115
self._new_reference_revision = {}
116
# Mapping of trans_id -> new file_id
118
# Mapping of old file-id -> trans_id
119
self._non_present_ids = {}
120
# Mapping of new file_id -> trans_id
122
# Set of trans_ids that will be removed
123
self._removed_id = set()
124
# Mapping of path in old tree -> trans_id
125
self._tree_path_ids = {}
126
# Mapping trans_id -> path in old tree
127
self._tree_id_paths = {}
128
# The trans_id that will be used as the tree root
129
root_id = tree.get_root_id()
130
if root_id is not None:
131
self._new_root = self.trans_id_tree_file_id(root_id)
133
self._new_root = None
134
# Indicator of whether the transform has been applied
138
# Whether the target is case sensitive
139
self._case_sensitive_target = case_sensitive
140
# A counter of how many files have been renamed
141
self.rename_count = 0
144
"""Support Context Manager API."""
147
def __exit__(self, exc_type, exc_val, exc_tb):
148
"""Support Context Manager API."""
152
"""Release the working tree lock, if held.
154
This is required if apply has not been invoked, but can be invoked
157
if self._tree is None:
159
for hook in MutableTree.hooks['post_transform']:
160
hook(self._tree, self)
164
def __get_root(self):
165
return self._new_root
167
root = property(__get_root)
169
def _assign_id(self):
170
"""Produce a new tranform id"""
171
new_id = "new-%s" % self._id_number
175
def create_path(self, name, parent):
176
"""Assign a transaction id to a new path"""
177
trans_id = self._assign_id()
178
unique_add(self._new_name, trans_id, name)
179
unique_add(self._new_parent, trans_id, parent)
182
def adjust_path(self, name, parent, trans_id):
183
"""Change the path that is assigned to a transaction id."""
185
raise ValueError("Parent trans-id may not be None")
186
if trans_id == self._new_root:
188
self._new_name[trans_id] = name
189
self._new_parent[trans_id] = parent
191
def adjust_root_path(self, name, parent):
192
"""Emulate moving the root by moving all children, instead.
194
We do this by undoing the association of root's transaction id with the
195
current tree. This allows us to create a new directory with that
196
transaction id. We unversion the root directory and version the
197
physically new directory, and hope someone versions the tree root
200
old_root = self._new_root
201
old_root_file_id = self.final_file_id(old_root)
202
# force moving all children of root
203
for child_id in self.iter_tree_children(old_root):
204
if child_id != parent:
205
self.adjust_path(self.final_name(child_id),
206
self.final_parent(child_id), child_id)
207
file_id = self.final_file_id(child_id)
208
if file_id is not None:
209
self.unversion_file(child_id)
210
self.version_file(file_id, child_id)
212
# the physical root needs a new transaction id
213
self._tree_path_ids.pop("")
214
self._tree_id_paths.pop(old_root)
215
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
216
if parent == old_root:
217
parent = self._new_root
218
self.adjust_path(name, parent, old_root)
219
self.create_directory(old_root)
220
self.version_file(old_root_file_id, old_root)
221
self.unversion_file(self._new_root)
223
def fixup_new_roots(self):
224
"""Reinterpret requests to change the root directory
226
Instead of creating a root directory, or moving an existing directory,
227
all the attributes and children of the new root are applied to the
228
existing root directory.
230
This means that the old root trans-id becomes obsolete, so it is
231
recommended only to invoke this after the root trans-id has become
235
new_roots = [k for k, v in self._new_parent.iteritems() if v ==
237
if len(new_roots) < 1:
239
if len(new_roots) != 1:
240
raise ValueError('A tree cannot have two roots!')
241
if self._new_root is None:
242
self._new_root = new_roots[0]
244
old_new_root = new_roots[0]
245
# unversion the new root's directory.
246
if self.final_kind(self._new_root) is None:
247
file_id = self.final_file_id(old_new_root)
249
file_id = self.final_file_id(self._new_root)
250
if old_new_root in self._new_id:
251
self.cancel_versioning(old_new_root)
253
self.unversion_file(old_new_root)
254
# if, at this stage, root still has an old file_id, zap it so we can
255
# stick a new one in.
256
if (self.tree_file_id(self._new_root) is not None and
257
self._new_root not in self._removed_id):
258
self.unversion_file(self._new_root)
259
if file_id is not None:
260
self.version_file(file_id, self._new_root)
262
# Now move children of new root into old root directory.
263
# Ensure all children are registered with the transaction, but don't
264
# use directly-- some tree children have new parents
265
list(self.iter_tree_children(old_new_root))
266
# Move all children of new root into old root directory.
267
for child in self.by_parent().get(old_new_root, []):
268
self.adjust_path(self.final_name(child), self._new_root, child)
270
# Ensure old_new_root has no directory.
271
if old_new_root in self._new_contents:
272
self.cancel_creation(old_new_root)
274
self.delete_contents(old_new_root)
276
# prevent deletion of root directory.
277
if self._new_root in self._removed_contents:
278
self.cancel_deletion(self._new_root)
280
# destroy path info for old_new_root.
281
del self._new_parent[old_new_root]
282
del self._new_name[old_new_root]
284
def trans_id_tree_file_id(self, inventory_id):
285
"""Determine the transaction id of a working tree file.
287
This reflects only files that already exist, not ones that will be
288
added by transactions.
290
if inventory_id is None:
291
raise ValueError('None is not a valid file id')
292
path = self._tree.id2path(inventory_id)
293
return self.trans_id_tree_path(path)
295
def trans_id_file_id(self, file_id):
296
"""Determine or set the transaction id associated with a file ID.
297
A new id is only created for file_ids that were never present. If
298
a transaction has been unversioned, it is deliberately still returned.
299
(this will likely lead to an unversioned parent conflict.)
302
raise ValueError('None is not a valid file id')
303
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
304
return self._r_new_id[file_id]
307
self._tree.iter_entries_by_dir([file_id]).next()
308
except StopIteration:
309
if file_id in self._non_present_ids:
310
return self._non_present_ids[file_id]
312
trans_id = self._assign_id()
313
self._non_present_ids[file_id] = trans_id
316
return self.trans_id_tree_file_id(file_id)
318
def trans_id_tree_path(self, path):
319
"""Determine (and maybe set) the transaction ID for a tree path."""
320
path = self.canonical_path(path)
321
if path not in self._tree_path_ids:
322
self._tree_path_ids[path] = self._assign_id()
323
self._tree_id_paths[self._tree_path_ids[path]] = path
324
return self._tree_path_ids[path]
326
def get_tree_parent(self, trans_id):
327
"""Determine id of the parent in the tree."""
328
path = self._tree_id_paths[trans_id]
331
return self.trans_id_tree_path(os.path.dirname(path))
333
def delete_contents(self, trans_id):
334
"""Schedule the contents of a path entry for deletion"""
335
kind = self.tree_kind(trans_id)
337
self._removed_contents.add(trans_id)
339
def cancel_deletion(self, trans_id):
340
"""Cancel a scheduled deletion"""
341
self._removed_contents.remove(trans_id)
343
def unversion_file(self, trans_id):
344
"""Schedule a path entry to become unversioned"""
345
self._removed_id.add(trans_id)
347
def delete_versioned(self, trans_id):
348
"""Delete and unversion a versioned file"""
349
self.delete_contents(trans_id)
350
self.unversion_file(trans_id)
352
def set_executability(self, executability, trans_id):
353
"""Schedule setting of the 'execute' bit
354
To unschedule, set to None
356
if executability is None:
357
del self._new_executability[trans_id]
359
unique_add(self._new_executability, trans_id, executability)
361
def set_tree_reference(self, revision_id, trans_id):
362
"""Set the reference associated with a directory"""
363
unique_add(self._new_reference_revision, trans_id, revision_id)
365
def version_file(self, file_id, trans_id):
366
"""Schedule a file to become versioned."""
369
unique_add(self._new_id, trans_id, file_id)
370
unique_add(self._r_new_id, file_id, trans_id)
372
def cancel_versioning(self, trans_id):
373
"""Undo a previous versioning of a file"""
374
file_id = self._new_id[trans_id]
375
del self._new_id[trans_id]
376
del self._r_new_id[file_id]
378
def new_paths(self, filesystem_only=False):
379
"""Determine the paths of all new and changed files.
381
:param filesystem_only: if True, only calculate values for files
382
that require renames or execute bit changes.
386
stale_ids = self._needs_rename.difference(self._new_name)
387
stale_ids.difference_update(self._new_parent)
388
stale_ids.difference_update(self._new_contents)
389
stale_ids.difference_update(self._new_id)
390
needs_rename = self._needs_rename.difference(stale_ids)
391
id_sets = (needs_rename, self._new_executability)
393
id_sets = (self._new_name, self._new_parent, self._new_contents,
394
self._new_id, self._new_executability)
395
for id_set in id_sets:
396
new_ids.update(id_set)
397
return sorted(FinalPaths(self).get_paths(new_ids))
399
def _inventory_altered(self):
400
"""Determine which trans_ids need new Inventory entries.
402
An new entry is needed when anything that would be reflected by an
403
inventory entry changes, including file name, file_id, parent file_id,
404
file kind, and the execute bit.
406
Some care is taken to return entries with real changes, not cases
407
where the value is deleted and then restored to its original value,
408
but some actually unchanged values may be returned.
410
:returns: A list of (path, trans_id) for all items requiring an
411
inventory change. Ordered by path.
414
# Find entries whose file_ids are new (or changed).
415
new_file_id = set(t for t in self._new_id
416
if self._new_id[t] != self.tree_file_id(t))
417
for id_set in [self._new_name, self._new_parent, new_file_id,
418
self._new_executability]:
419
changed_ids.update(id_set)
420
# removing implies a kind change
421
changed_kind = set(self._removed_contents)
423
changed_kind.intersection_update(self._new_contents)
424
# Ignore entries that are already known to have changed.
425
changed_kind.difference_update(changed_ids)
426
# to keep only the truly changed ones
427
changed_kind = (t for t in changed_kind
428
if self.tree_kind(t) != self.final_kind(t))
429
# all kind changes will alter the inventory
430
changed_ids.update(changed_kind)
431
# To find entries with changed parent_ids, find parents which existed,
432
# but changed file_id.
433
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
434
# Now add all their children to the set.
435
for parent_trans_id in new_file_id:
436
changed_ids.update(self.iter_tree_children(parent_trans_id))
437
return sorted(FinalPaths(self).get_paths(changed_ids))
439
def final_kind(self, trans_id):
440
"""Determine the final file kind, after any changes applied.
442
:return: None if the file does not exist/has no contents. (It is
443
conceivable that a path would be created without the corresponding
444
contents insertion command)
446
if trans_id in self._new_contents:
447
return self._new_contents[trans_id]
448
elif trans_id in self._removed_contents:
451
return self.tree_kind(trans_id)
453
def tree_file_id(self, trans_id):
454
"""Determine the file id associated with the trans_id in the tree"""
456
path = self._tree_id_paths[trans_id]
458
# the file is a new, unversioned file, or invalid trans_id
460
# the file is old; the old id is still valid
461
if self._new_root == trans_id:
462
return self._tree.get_root_id()
463
return self._tree.path2id(path)
465
def final_file_id(self, trans_id):
466
"""Determine the file id after any changes are applied, or None.
468
None indicates that the file will not be versioned after changes are
472
return self._new_id[trans_id]
474
if trans_id in self._removed_id:
476
return self.tree_file_id(trans_id)
478
def inactive_file_id(self, trans_id):
479
"""Return the inactive file_id associated with a transaction id.
480
That is, the one in the tree or in non_present_ids.
481
The file_id may actually be active, too.
483
file_id = self.tree_file_id(trans_id)
484
if file_id is not None:
486
for key, value in self._non_present_ids.iteritems():
487
if value == trans_id:
490
def final_parent(self, trans_id):
491
"""Determine the parent file_id, after any changes are applied.
493
ROOT_PARENT is returned for the tree root.
496
return self._new_parent[trans_id]
498
return self.get_tree_parent(trans_id)
500
def final_name(self, trans_id):
501
"""Determine the final filename, after all changes are applied."""
503
return self._new_name[trans_id]
506
return os.path.basename(self._tree_id_paths[trans_id])
508
raise NoFinalPath(trans_id, self)
511
"""Return a map of parent: children for known parents.
513
Only new paths and parents of tree files with assigned ids are used.
516
items = list(self._new_parent.iteritems())
517
items.extend((t, self.final_parent(t)) for t in
518
self._tree_id_paths.keys())
519
for trans_id, parent_id in items:
520
if parent_id not in by_parent:
521
by_parent[parent_id] = set()
522
by_parent[parent_id].add(trans_id)
525
def path_changed(self, trans_id):
526
"""Return True if a trans_id's path has changed."""
527
return (trans_id in self._new_name) or (trans_id in self._new_parent)
529
def new_contents(self, trans_id):
530
return (trans_id in self._new_contents)
532
def find_conflicts(self):
533
"""Find any violations of inventory or filesystem invariants"""
534
if self._done is True:
535
raise ReusingTransform()
537
# ensure all children of all existent parents are known
538
# all children of non-existent parents are known, by definition.
539
self._add_tree_children()
540
by_parent = self.by_parent()
541
conflicts.extend(self._unversioned_parents(by_parent))
542
conflicts.extend(self._parent_loops())
543
conflicts.extend(self._duplicate_entries(by_parent))
544
conflicts.extend(self._duplicate_ids())
545
conflicts.extend(self._parent_type_conflicts(by_parent))
546
conflicts.extend(self._improper_versioning())
547
conflicts.extend(self._executability_conflicts())
548
conflicts.extend(self._overwrite_conflicts())
551
def _check_malformed(self):
552
conflicts = self.find_conflicts()
553
if len(conflicts) != 0:
554
raise MalformedTransform(conflicts=conflicts)
556
def _add_tree_children(self):
557
"""Add all the children of all active parents to the known paths.
559
Active parents are those which gain children, and those which are
560
removed. This is a necessary first step in detecting conflicts.
562
parents = self.by_parent().keys()
563
parents.extend([t for t in self._removed_contents if
564
self.tree_kind(t) == 'directory'])
565
for trans_id in self._removed_id:
566
file_id = self.tree_file_id(trans_id)
567
if file_id is not None:
568
if self._tree.stored_kind(file_id) == 'directory':
569
parents.append(trans_id)
570
elif self.tree_kind(trans_id) == 'directory':
571
parents.append(trans_id)
573
for parent_id in parents:
574
# ensure that all children are registered with the transaction
575
list(self.iter_tree_children(parent_id))
577
@deprecated_method(deprecated_in((2, 3, 0)))
578
def has_named_child(self, by_parent, parent_id, name):
579
return self._has_named_child(
580
name, parent_id, known_children=by_parent.get(parent_id, []))
582
def _has_named_child(self, name, parent_id, known_children):
583
"""Does a parent already have a name child.
585
:param name: The searched for name.
587
:param parent_id: The parent for which the check is made.
589
:param known_children: The already known children. This should have
590
been recently obtained from `self.by_parent.get(parent_id)`
591
(or will be if None is passed).
593
if known_children is None:
594
known_children = self.by_parent().get(parent_id, [])
595
for child in known_children:
596
if self.final_name(child) == name:
598
parent_path = self._tree_id_paths.get(parent_id, None)
599
if parent_path is None:
600
# No parent... no children
602
child_path = joinpath(parent_path, name)
603
child_id = self._tree_path_ids.get(child_path, None)
605
# Not known by the tree transform yet, check the filesystem
606
return osutils.lexists(self._tree.abspath(child_path))
608
raise AssertionError('child_id is missing: %s, %s, %s'
609
% (name, parent_id, child_id))
611
def _available_backup_name(self, name, target_id):
612
"""Find an available backup name.
614
:param name: The basename of the file.
616
:param target_id: The directory trans_id where the backup should
619
known_children = self.by_parent().get(target_id, [])
620
return osutils.available_backup_name(
622
lambda base: self._has_named_child(
623
base, target_id, known_children))
625
def _parent_loops(self):
626
"""No entry should be its own ancestor"""
628
for trans_id in self._new_parent:
631
while parent_id != ROOT_PARENT:
634
parent_id = self.final_parent(parent_id)
637
if parent_id == trans_id:
638
conflicts.append(('parent loop', trans_id))
639
if parent_id in seen:
643
def _unversioned_parents(self, by_parent):
644
"""If parent directories are versioned, children must be versioned."""
646
for parent_id, children in by_parent.iteritems():
647
if parent_id == ROOT_PARENT:
649
if self.final_file_id(parent_id) is not None:
651
for child_id in children:
652
if self.final_file_id(child_id) is not None:
653
conflicts.append(('unversioned parent', parent_id))
657
def _improper_versioning(self):
658
"""Cannot version a file with no contents, or a bad type.
660
However, existing entries with no contents are okay.
663
for trans_id in self._new_id.iterkeys():
664
kind = self.final_kind(trans_id)
666
conflicts.append(('versioning no contents', trans_id))
668
if not inventory.InventoryEntry.versionable_kind(kind):
669
conflicts.append(('versioning bad kind', trans_id, kind))
672
def _executability_conflicts(self):
673
"""Check for bad executability changes.
675
Only versioned files may have their executability set, because
676
1. only versioned entries can have executability under windows
677
2. only files can be executable. (The execute bit on a directory
678
does not indicate searchability)
681
for trans_id in self._new_executability:
682
if self.final_file_id(trans_id) is None:
683
conflicts.append(('unversioned executability', trans_id))
685
if self.final_kind(trans_id) != "file":
686
conflicts.append(('non-file executability', trans_id))
689
def _overwrite_conflicts(self):
690
"""Check for overwrites (not permitted on Win32)"""
692
for trans_id in self._new_contents:
693
if self.tree_kind(trans_id) is None:
695
if trans_id not in self._removed_contents:
696
conflicts.append(('overwrite', trans_id,
697
self.final_name(trans_id)))
700
def _duplicate_entries(self, by_parent):
701
"""No directory may have two entries with the same name."""
703
if (self._new_name, self._new_parent) == ({}, {}):
705
for children in by_parent.itervalues():
707
for child_tid in children:
708
name = self.final_name(child_tid)
710
# Keep children only if they still exist in the end
711
if not self._case_sensitive_target:
713
name_ids.append((name, child_tid))
717
for name, trans_id in name_ids:
718
kind = self.final_kind(trans_id)
719
file_id = self.final_file_id(trans_id)
720
if kind is None and file_id is None:
722
if name == last_name:
723
conflicts.append(('duplicate', last_trans_id, trans_id,
726
last_trans_id = trans_id
729
def _duplicate_ids(self):
730
"""Each inventory id may only be used once"""
732
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
734
all_ids = self._tree.all_file_ids()
735
active_tree_ids = all_ids.difference(removed_tree_ids)
736
for trans_id, file_id in self._new_id.iteritems():
737
if file_id in active_tree_ids:
738
old_trans_id = self.trans_id_tree_file_id(file_id)
739
conflicts.append(('duplicate id', old_trans_id, trans_id))
742
def _parent_type_conflicts(self, by_parent):
743
"""Children must have a directory parent"""
745
for parent_id, children in by_parent.iteritems():
746
if parent_id == ROOT_PARENT:
749
for child_id in children:
750
if self.final_kind(child_id) is not None:
755
# There is at least a child, so we need an existing directory to
757
kind = self.final_kind(parent_id)
759
# The directory will be deleted
760
conflicts.append(('missing parent', parent_id))
761
elif kind != "directory":
762
# Meh, we need a *directory* to put something in it
763
conflicts.append(('non-directory parent', parent_id))
766
def _set_executability(self, path, trans_id):
767
"""Set the executability of versioned files """
768
if self._tree._supports_executable():
769
new_executability = self._new_executability[trans_id]
770
abspath = self._tree.abspath(path)
771
current_mode = os.stat(abspath).st_mode
772
if new_executability:
775
to_mode = current_mode | (0100 & ~umask)
776
# Enable x-bit for others only if they can read it.
777
if current_mode & 0004:
778
to_mode |= 0001 & ~umask
779
if current_mode & 0040:
780
to_mode |= 0010 & ~umask
782
to_mode = current_mode & ~0111
783
osutils.chmod_if_possible(abspath, to_mode)
785
def _new_entry(self, name, parent_id, file_id):
786
"""Helper function to create a new filesystem entry."""
787
trans_id = self.create_path(name, parent_id)
788
if file_id is not None:
789
self.version_file(file_id, trans_id)
792
def new_file(self, name, parent_id, contents, file_id=None,
793
executable=None, sha1=None):
794
"""Convenience method to create files.
796
name is the name of the file to create.
797
parent_id is the transaction id of the parent directory of the file.
798
contents is an iterator of bytestrings, which will be used to produce
800
:param file_id: The inventory ID of the file, if it is to be versioned.
801
:param executable: Only valid when a file_id has been supplied.
803
trans_id = self._new_entry(name, parent_id, file_id)
804
# TODO: rather than scheduling a set_executable call,
805
# have create_file create the file with the right mode.
806
self.create_file(contents, trans_id, sha1=sha1)
807
if executable is not None:
808
self.set_executability(executable, trans_id)
811
def new_directory(self, name, parent_id, file_id=None):
812
"""Convenience method to create directories.
814
name is the name of the directory to create.
815
parent_id is the transaction id of the parent directory of the
817
file_id is the inventory ID of the directory, if it is to be versioned.
819
trans_id = self._new_entry(name, parent_id, file_id)
820
self.create_directory(trans_id)
823
def new_symlink(self, name, parent_id, target, file_id=None):
824
"""Convenience method to create symbolic link.
826
name is the name of the symlink to create.
827
parent_id is the transaction id of the parent directory of the symlink.
828
target is a bytestring of the target of the symlink.
829
file_id is the inventory ID of the file, if it is to be versioned.
831
trans_id = self._new_entry(name, parent_id, file_id)
832
self.create_symlink(target, trans_id)
835
def new_orphan(self, trans_id, parent_id):
836
"""Schedule an item to be orphaned.
838
When a directory is about to be removed, its children, if they are not
839
versioned are moved out of the way: they don't have a parent anymore.
841
:param trans_id: The trans_id of the existing item.
842
:param parent_id: The parent trans_id of the item.
844
raise NotImplementedError(self.new_orphan)
846
def _get_potential_orphans(self, dir_id):
847
"""Find the potential orphans in a directory.
849
A directory can't be safely deleted if there are versioned files in it.
850
If all the contained files are unversioned then they can be orphaned.
852
The 'None' return value means that the directory contains at least one
853
versioned file and should not be deleted.
855
:param dir_id: The directory trans id.
857
:return: A list of the orphan trans ids or None if at least one
858
versioned file is present.
861
# Find the potential orphans, stop if one item should be kept
862
for child_tid in self.by_parent()[dir_id]:
863
if child_tid in self._removed_contents:
864
# The child is removed as part of the transform. Since it was
865
# versioned before, it's not an orphan
867
elif self.final_file_id(child_tid) is None:
868
# The child is not versioned
869
orphans.append(child_tid)
871
# We have a versioned file here, searching for orphans is
877
def _affected_ids(self):
878
"""Return the set of transform ids affected by the transform"""
879
trans_ids = set(self._removed_id)
880
trans_ids.update(self._new_id.keys())
881
trans_ids.update(self._removed_contents)
882
trans_ids.update(self._new_contents.keys())
883
trans_ids.update(self._new_executability.keys())
884
trans_ids.update(self._new_name.keys())
885
trans_ids.update(self._new_parent.keys())
888
def _get_file_id_maps(self):
889
"""Return mapping of file_ids to trans_ids in the to and from states"""
890
trans_ids = self._affected_ids()
893
# Build up two dicts: trans_ids associated with file ids in the
894
# FROM state, vs the TO state.
895
for trans_id in trans_ids:
896
from_file_id = self.tree_file_id(trans_id)
897
if from_file_id is not None:
898
from_trans_ids[from_file_id] = trans_id
899
to_file_id = self.final_file_id(trans_id)
900
if to_file_id is not None:
901
to_trans_ids[to_file_id] = trans_id
902
return from_trans_ids, to_trans_ids
904
def _from_file_data(self, from_trans_id, from_versioned, file_id):
905
"""Get data about a file in the from (tree) state
907
Return a (name, parent, kind, executable) tuple
909
from_path = self._tree_id_paths.get(from_trans_id)
911
# get data from working tree if versioned
912
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
913
from_name = from_entry.name
914
from_parent = from_entry.parent_id
917
if from_path is None:
918
# File does not exist in FROM state
922
# File exists, but is not versioned. Have to use path-
924
from_name = os.path.basename(from_path)
925
tree_parent = self.get_tree_parent(from_trans_id)
926
from_parent = self.tree_file_id(tree_parent)
927
if from_path is not None:
928
from_kind, from_executable, from_stats = \
929
self._tree._comparison_data(from_entry, from_path)
932
from_executable = False
933
return from_name, from_parent, from_kind, from_executable
935
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
936
"""Get data about a file in the to (target) state
938
Return a (name, parent, kind, executable) tuple
940
to_name = self.final_name(to_trans_id)
941
to_kind = self.final_kind(to_trans_id)
942
to_parent = self.final_file_id(self.final_parent(to_trans_id))
943
if to_trans_id in self._new_executability:
944
to_executable = self._new_executability[to_trans_id]
945
elif to_trans_id == from_trans_id:
946
to_executable = from_executable
948
to_executable = False
949
return to_name, to_parent, to_kind, to_executable
951
def iter_changes(self):
952
"""Produce output in the same format as Tree.iter_changes.
954
Will produce nonsensical results if invoked while inventory/filesystem
955
conflicts (as reported by TreeTransform.find_conflicts()) are present.
957
This reads the Transform, but only reproduces changes involving a
958
file_id. Files that are not versioned in either of the FROM or TO
959
states are not reflected.
961
final_paths = FinalPaths(self)
962
from_trans_ids, to_trans_ids = self._get_file_id_maps()
964
# Now iterate through all active file_ids
965
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
967
from_trans_id = from_trans_ids.get(file_id)
968
# find file ids, and determine versioning state
969
if from_trans_id is None:
970
from_versioned = False
971
from_trans_id = to_trans_ids[file_id]
973
from_versioned = True
974
to_trans_id = to_trans_ids.get(file_id)
975
if to_trans_id is None:
977
to_trans_id = from_trans_id
981
from_name, from_parent, from_kind, from_executable = \
982
self._from_file_data(from_trans_id, from_versioned, file_id)
984
to_name, to_parent, to_kind, to_executable = \
985
self._to_file_data(to_trans_id, from_trans_id, from_executable)
987
if not from_versioned:
990
from_path = self._tree_id_paths.get(from_trans_id)
994
to_path = final_paths.get_path(to_trans_id)
995
if from_kind != to_kind:
997
elif to_kind in ('file', 'symlink') and (
998
to_trans_id != from_trans_id or
999
to_trans_id in self._new_contents):
1001
if (not modified and from_versioned == to_versioned and
1002
from_parent==to_parent and from_name == to_name and
1003
from_executable == to_executable):
1005
results.append((file_id, (from_path, to_path), modified,
1006
(from_versioned, to_versioned),
1007
(from_parent, to_parent),
1008
(from_name, to_name),
1009
(from_kind, to_kind),
1010
(from_executable, to_executable)))
1011
return iter(sorted(results, key=lambda x:x[1]))
1013
def get_preview_tree(self):
1014
"""Return a tree representing the result of the transform.
1016
The tree is a snapshot, and altering the TreeTransform will invalidate
1019
return _PreviewTree(self)
1021
def commit(self, branch, message, merge_parents=None, strict=False,
1022
timestamp=None, timezone=None, committer=None, authors=None,
1023
revprops=None, revision_id=None):
1024
"""Commit the result of this TreeTransform to a branch.
1026
:param branch: The branch to commit to.
1027
:param message: The message to attach to the commit.
1028
:param merge_parents: Additional parent revision-ids specified by
1030
:param strict: If True, abort the commit if there are unversioned
1032
:param timestamp: if not None, seconds-since-epoch for the time and
1033
date. (May be a float.)
1034
:param timezone: Optional timezone for timestamp, as an offset in
1036
:param committer: Optional committer in email-id format.
1037
(e.g. "J Random Hacker <jrandom@example.com>")
1038
:param authors: Optional list of authors in email-id format.
1039
:param revprops: Optional dictionary of revision properties.
1040
:param revision_id: Optional revision id. (Specifying a revision-id
1041
may reduce performance for some non-native formats.)
1042
:return: The revision_id of the revision committed.
1044
self._check_malformed()
1046
unversioned = set(self._new_contents).difference(set(self._new_id))
1047
for trans_id in unversioned:
1048
if self.final_file_id(trans_id) is None:
1049
raise errors.StrictCommitFailed()
1051
revno, last_rev_id = branch.last_revision_info()
1052
if last_rev_id == _mod_revision.NULL_REVISION:
1053
if merge_parents is not None:
1054
raise ValueError('Cannot supply merge parents for first'
1058
parent_ids = [last_rev_id]
1059
if merge_parents is not None:
1060
parent_ids.extend(merge_parents)
1061
if self._tree.get_revision_id() != last_rev_id:
1062
raise ValueError('TreeTransform not based on branch basis: %s' %
1063
self._tree.get_revision_id())
1064
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1065
builder = branch.get_commit_builder(parent_ids,
1066
timestamp=timestamp,
1068
committer=committer,
1070
revision_id=revision_id)
1071
preview = self.get_preview_tree()
1072
list(builder.record_iter_changes(preview, last_rev_id,
1073
self.iter_changes()))
1074
builder.finish_inventory()
1075
revision_id = builder.commit(message)
1076
branch.set_last_revision_info(revno + 1, revision_id)
1079
def _text_parent(self, trans_id):
1080
file_id = self.tree_file_id(trans_id)
1082
if file_id is None or self._tree.kind(file_id) != 'file':
1084
except errors.NoSuchFile:
1088
def _get_parents_texts(self, trans_id):
1089
"""Get texts for compression parents of this file."""
1090
file_id = self._text_parent(trans_id)
1093
return (self._tree.get_file_text(file_id),)
1095
def _get_parents_lines(self, trans_id):
1096
"""Get lines for compression parents of this file."""
1097
file_id = self._text_parent(trans_id)
1100
return (self._tree.get_file_lines(file_id),)
1102
def serialize(self, serializer):
1103
"""Serialize this TreeTransform.
1105
:param serializer: A Serialiser like pack.ContainerSerializer.
1107
new_name = dict((k, v.encode('utf-8')) for k, v in
1108
self._new_name.items())
1109
new_executability = dict((k, int(v)) for k, v in
1110
self._new_executability.items())
1111
tree_path_ids = dict((k.encode('utf-8'), v)
1112
for k, v in self._tree_path_ids.items())
1114
'_id_number': self._id_number,
1115
'_new_name': new_name,
1116
'_new_parent': self._new_parent,
1117
'_new_executability': new_executability,
1118
'_new_id': self._new_id,
1119
'_tree_path_ids': tree_path_ids,
1120
'_removed_id': list(self._removed_id),
1121
'_removed_contents': list(self._removed_contents),
1122
'_non_present_ids': self._non_present_ids,
1124
yield serializer.bytes_record(bencode.bencode(attribs),
1126
for trans_id, kind in self._new_contents.items():
1128
lines = osutils.chunks_to_lines(
1129
self._read_file_chunks(trans_id))
1130
parents = self._get_parents_lines(trans_id)
1131
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1132
content = ''.join(mpdiff.to_patch())
1133
if kind == 'directory':
1135
if kind == 'symlink':
1136
content = self._read_symlink_target(trans_id)
1137
yield serializer.bytes_record(content, ((trans_id, kind),))
1139
def deserialize(self, records):
1140
"""Deserialize a stored TreeTransform.
1142
:param records: An iterable of (names, content) tuples, as per
1143
pack.ContainerPushParser.
1145
names, content = records.next()
1146
attribs = bencode.bdecode(content)
1147
self._id_number = attribs['_id_number']
1148
self._new_name = dict((k, v.decode('utf-8'))
1149
for k, v in attribs['_new_name'].items())
1150
self._new_parent = attribs['_new_parent']
1151
self._new_executability = dict((k, bool(v)) for k, v in
1152
attribs['_new_executability'].items())
1153
self._new_id = attribs['_new_id']
1154
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1155
self._tree_path_ids = {}
1156
self._tree_id_paths = {}
1157
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1158
path = bytepath.decode('utf-8')
1159
self._tree_path_ids[path] = trans_id
1160
self._tree_id_paths[trans_id] = path
1161
self._removed_id = set(attribs['_removed_id'])
1162
self._removed_contents = set(attribs['_removed_contents'])
1163
self._non_present_ids = attribs['_non_present_ids']
1164
for ((trans_id, kind),), content in records:
1166
mpdiff = multiparent.MultiParent.from_patch(content)
1167
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1168
self.create_file(lines, trans_id)
1169
if kind == 'directory':
1170
self.create_directory(trans_id)
1171
if kind == 'symlink':
1172
self.create_symlink(content.decode('utf-8'), trans_id)
1175
class DiskTreeTransform(TreeTransformBase):
1176
"""Tree transform storing its contents on disk."""
1178
def __init__(self, tree, limbodir, pb=None,
1179
case_sensitive=True):
1181
:param tree: The tree that will be transformed, but not necessarily
1183
:param limbodir: A directory where new files can be stored until
1184
they are installed in their proper places
1186
:param case_sensitive: If True, the target of the transform is
1187
case sensitive, not just case preserving.
1189
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1190
self._limbodir = limbodir
1191
self._deletiondir = None
1192
# A mapping of transform ids to their limbo filename
1193
self._limbo_files = {}
1194
self._possibly_stale_limbo_files = set()
1195
# A mapping of transform ids to a set of the transform ids of children
1196
# that their limbo directory has
1197
self._limbo_children = {}
1198
# Map transform ids to maps of child filename to child transform id
1199
self._limbo_children_names = {}
1200
# List of transform ids that need to be renamed from limbo into place
1201
self._needs_rename = set()
1202
self._creation_mtime = None
1205
"""Release the working tree lock, if held, clean up limbo dir.
1207
This is required if apply has not been invoked, but can be invoked
1210
if self._tree is None:
1213
limbo_paths = self._limbo_files.values() + list(
1214
self._possibly_stale_limbo_files)
1215
limbo_paths = sorted(limbo_paths, reverse=True)
1216
for path in limbo_paths:
1220
if e.errno != errno.ENOENT:
1222
# XXX: warn? perhaps we just got interrupted at an
1223
# inconvenient moment, but perhaps files are disappearing
1226
delete_any(self._limbodir)
1228
# We don't especially care *why* the dir is immortal.
1229
raise ImmortalLimbo(self._limbodir)
1231
if self._deletiondir is not None:
1232
delete_any(self._deletiondir)
1234
raise errors.ImmortalPendingDeletion(self._deletiondir)
1236
TreeTransformBase.finalize(self)
1238
def _limbo_supports_executable(self):
1239
"""Check if the limbo path supports the executable bit."""
1240
# FIXME: Check actual file system capabilities of limbodir
1241
return osutils.supports_executable()
1243
def _limbo_name(self, trans_id):
1244
"""Generate the limbo name of a file"""
1245
limbo_name = self._limbo_files.get(trans_id)
1246
if limbo_name is None:
1247
limbo_name = self._generate_limbo_path(trans_id)
1248
self._limbo_files[trans_id] = limbo_name
1251
def _generate_limbo_path(self, trans_id):
1252
"""Generate a limbo path using the trans_id as the relative path.
1254
This is suitable as a fallback, and when the transform should not be
1255
sensitive to the path encoding of the limbo directory.
1257
self._needs_rename.add(trans_id)
1258
return pathjoin(self._limbodir, trans_id)
1260
def adjust_path(self, name, parent, trans_id):
1261
previous_parent = self._new_parent.get(trans_id)
1262
previous_name = self._new_name.get(trans_id)
1263
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1264
if (trans_id in self._limbo_files and
1265
trans_id not in self._needs_rename):
1266
self._rename_in_limbo([trans_id])
1267
if previous_parent != parent:
1268
self._limbo_children[previous_parent].remove(trans_id)
1269
if previous_parent != parent or previous_name != name:
1270
del self._limbo_children_names[previous_parent][previous_name]
1272
def _rename_in_limbo(self, trans_ids):
1273
"""Fix limbo names so that the right final path is produced.
1275
This means we outsmarted ourselves-- we tried to avoid renaming
1276
these files later by creating them with their final names in their
1277
final parents. But now the previous name or parent is no longer
1278
suitable, so we have to rename them.
1280
Even for trans_ids that have no new contents, we must remove their
1281
entries from _limbo_files, because they are now stale.
1283
for trans_id in trans_ids:
1284
old_path = self._limbo_files[trans_id]
1285
self._possibly_stale_limbo_files.add(old_path)
1286
del self._limbo_files[trans_id]
1287
if trans_id not in self._new_contents:
1289
new_path = self._limbo_name(trans_id)
1290
os.rename(old_path, new_path)
1291
self._possibly_stale_limbo_files.remove(old_path)
1292
for descendant in self._limbo_descendants(trans_id):
1293
desc_path = self._limbo_files[descendant]
1294
desc_path = new_path + desc_path[len(old_path):]
1295
self._limbo_files[descendant] = desc_path
1297
def _limbo_descendants(self, trans_id):
1298
"""Return the set of trans_ids whose limbo paths descend from this."""
1299
descendants = set(self._limbo_children.get(trans_id, []))
1300
for descendant in list(descendants):
1301
descendants.update(self._limbo_descendants(descendant))
1304
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1305
"""Schedule creation of a new file.
1309
:param contents: an iterator of strings, all of which will be written
1310
to the target destination.
1311
:param trans_id: TreeTransform handle
1312
:param mode_id: If not None, force the mode of the target file to match
1313
the mode of the object referenced by mode_id.
1314
Otherwise, we will try to preserve mode bits of an existing file.
1315
:param sha1: If the sha1 of this content is already known, pass it in.
1316
We can use it to prevent future sha1 computations.
1318
name = self._limbo_name(trans_id)
1319
f = open(name, 'wb')
1321
unique_add(self._new_contents, trans_id, 'file')
1322
f.writelines(contents)
1325
self._set_mtime(name)
1326
self._set_mode(trans_id, mode_id, S_ISREG)
1327
# It is unfortunate we have to use lstat instead of fstat, but we just
1328
# used utime and chmod on the file, so we need the accurate final
1330
if sha1 is not None:
1331
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1333
def _read_file_chunks(self, trans_id):
1334
cur_file = open(self._limbo_name(trans_id), 'rb')
1336
return cur_file.readlines()
1340
def _read_symlink_target(self, trans_id):
1341
return os.readlink(self._limbo_name(trans_id))
1343
def _set_mtime(self, path):
1344
"""All files that are created get the same mtime.
1346
This time is set by the first object to be created.
1348
if self._creation_mtime is None:
1349
self._creation_mtime = time.time()
1350
os.utime(path, (self._creation_mtime, self._creation_mtime))
1352
def create_hardlink(self, path, trans_id):
1353
"""Schedule creation of a hard link"""
1354
name = self._limbo_name(trans_id)
1358
if e.errno != errno.EPERM:
1360
raise errors.HardLinkNotSupported(path)
1362
unique_add(self._new_contents, trans_id, 'file')
1364
# Clean up the file, it never got registered so
1365
# TreeTransform.finalize() won't clean it up.
1369
def create_directory(self, trans_id):
1370
"""Schedule creation of a new directory.
1372
See also new_directory.
1374
os.mkdir(self._limbo_name(trans_id))
1375
unique_add(self._new_contents, trans_id, 'directory')
1377
def create_symlink(self, target, trans_id):
1378
"""Schedule creation of a new symbolic link.
1380
target is a bytestring.
1381
See also new_symlink.
1384
os.symlink(target, self._limbo_name(trans_id))
1385
unique_add(self._new_contents, trans_id, 'symlink')
1388
path = FinalPaths(self).get_path(trans_id)
1391
raise UnableCreateSymlink(path=path)
1393
def cancel_creation(self, trans_id):
1394
"""Cancel the creation of new file contents."""
1395
del self._new_contents[trans_id]
1396
if trans_id in self._observed_sha1s:
1397
del self._observed_sha1s[trans_id]
1398
children = self._limbo_children.get(trans_id)
1399
# if this is a limbo directory with children, move them before removing
1401
if children is not None:
1402
self._rename_in_limbo(children)
1403
del self._limbo_children[trans_id]
1404
del self._limbo_children_names[trans_id]
1405
delete_any(self._limbo_name(trans_id))
1407
def new_orphan(self, trans_id, parent_id):
1408
# FIXME: There is no tree config, so we use the branch one (it's weird
1409
# to define it this way as orphaning can only occur in a working tree,
1410
# but that's all we have (for now). It will find the option in
1411
# locations.conf or bazaar.conf though) -- vila 20100916
1412
conf = self._tree.branch.get_config()
1413
conf_var_name = 'bzr.transform.orphan_policy'
1414
orphan_policy = conf.get_user_option(conf_var_name)
1415
default_policy = orphaning_registry.default_key
1416
if orphan_policy is None:
1417
orphan_policy = default_policy
1418
if orphan_policy not in orphaning_registry:
1419
trace.warning('%s (from %s) is not a known policy, defaulting '
1420
'to %s' % (orphan_policy, conf_var_name, default_policy))
1421
orphan_policy = default_policy
1422
handle_orphan = orphaning_registry.get(orphan_policy)
1423
handle_orphan(self, trans_id, parent_id)
1426
class OrphaningError(errors.BzrError):
1428
# Only bugs could lead to such exception being seen by the user
1429
internal_error = True
1430
_fmt = "Error while orphaning %s in %s directory"
1432
def __init__(self, orphan, parent):
1433
errors.BzrError.__init__(self)
1434
self.orphan = orphan
1435
self.parent = parent
1438
class OrphaningForbidden(OrphaningError):
1440
_fmt = "Policy: %s doesn't allow creating orphans."
1442
def __init__(self, policy):
1443
errors.BzrError.__init__(self)
1444
self.policy = policy
1447
def move_orphan(tt, orphan_id, parent_id):
1448
"""See TreeTransformBase.new_orphan.
1450
This creates a new orphan in the `bzr-orphans` dir at the root of the
1453
:param tt: The TreeTransform orphaning `trans_id`.
1455
:param orphan_id: The trans id that should be orphaned.
1457
:param parent_id: The orphan parent trans id.
1459
# Add the orphan dir if it doesn't exist
1460
orphan_dir_basename = 'bzr-orphans'
1461
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1462
if tt.final_kind(od_id) is None:
1463
tt.create_directory(od_id)
1464
parent_path = tt._tree_id_paths[parent_id]
1465
# Find a name that doesn't exist yet in the orphan dir
1466
actual_name = tt.final_name(orphan_id)
1467
new_name = tt._available_backup_name(actual_name, od_id)
1468
tt.adjust_path(new_name, od_id, orphan_id)
1469
trace.warning('%s has been orphaned in %s'
1470
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1473
def refuse_orphan(tt, orphan_id, parent_id):
1474
"""See TreeTransformBase.new_orphan.
1476
This refuses to create orphan, letting the caller handle the conflict.
1478
raise OrphaningForbidden('never')
1481
orphaning_registry = registry.Registry()
1482
orphaning_registry.register(
1483
'conflict', refuse_orphan,
1484
'Leave orphans in place and create a conflict on the directory.')
1485
orphaning_registry.register(
1486
'move', move_orphan,
1487
'Move orphans into the bzr-orphans directory.')
1488
orphaning_registry._set_default_key('conflict')
1491
class TreeTransform(DiskTreeTransform):
1492
"""Represent a tree transformation.
1494
This object is designed to support incremental generation of the transform,
1497
However, it gives optimum performance when parent directories are created
1498
before their contents. The transform is then able to put child files
1499
directly in their parent directory, avoiding later renames.
1501
It is easy to produce malformed transforms, but they are generally
1502
harmless. Attempting to apply a malformed transform will cause an
1503
exception to be raised before any modifications are made to the tree.
1505
Many kinds of malformed transforms can be corrected with the
1506
resolve_conflicts function. The remaining ones indicate programming error,
1507
such as trying to create a file with no path.
1509
Two sets of file creation methods are supplied. Convenience methods are:
1514
These are composed of the low-level methods:
1516
* create_file or create_directory or create_symlink
1520
Transform/Transaction ids
1521
-------------------------
1522
trans_ids are temporary ids assigned to all files involved in a transform.
1523
It's possible, even common, that not all files in the Tree have trans_ids.
1525
trans_ids are used because filenames and file_ids are not good enough
1526
identifiers; filenames change, and not all files have file_ids. File-ids
1527
are also associated with trans-ids, so that moving a file moves its
1530
trans_ids are only valid for the TreeTransform that generated them.
1534
Limbo is a temporary directory use to hold new versions of files.
1535
Files are added to limbo by create_file, create_directory, create_symlink,
1536
and their convenience variants (new_*). Files may be removed from limbo
1537
using cancel_creation. Files are renamed from limbo into their final
1538
location as part of TreeTransform.apply
1540
Limbo must be cleaned up, by either calling TreeTransform.apply or
1541
calling TreeTransform.finalize.
1543
Files are placed into limbo inside their parent directories, where
1544
possible. This reduces subsequent renames, and makes operations involving
1545
lots of files faster. This optimization is only possible if the parent
1546
directory is created *before* creating any of its children, so avoid
1547
creating children before parents, where possible.
1551
This temporary directory is used by _FileMover for storing files that are
1552
about to be deleted. In case of rollback, the files will be restored.
1553
FileMover does not delete files until it is sure that a rollback will not
1556
def __init__(self, tree, pb=None):
1557
"""Note: a tree_write lock is taken on the tree.
1559
Use TreeTransform.finalize() to release the lock (can be omitted if
1560
TreeTransform.apply() called).
1562
tree.lock_tree_write()
1565
limbodir = urlutils.local_path_from_url(
1566
tree._transport.abspath('limbo'))
1567
osutils.ensure_empty_directory_exists(
1569
errors.ExistingLimbo)
1570
deletiondir = urlutils.local_path_from_url(
1571
tree._transport.abspath('pending-deletion'))
1572
osutils.ensure_empty_directory_exists(
1574
errors.ExistingPendingDeletion)
1579
# Cache of realpath results, to speed up canonical_path
1580
self._realpaths = {}
1581
# Cache of relpath results, to speed up canonical_path
1583
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1584
tree.case_sensitive)
1585
self._deletiondir = deletiondir
1587
def canonical_path(self, path):
1588
"""Get the canonical tree-relative path"""
1589
# don't follow final symlinks
1590
abs = self._tree.abspath(path)
1591
if abs in self._relpaths:
1592
return self._relpaths[abs]
1593
dirname, basename = os.path.split(abs)
1594
if dirname not in self._realpaths:
1595
self._realpaths[dirname] = os.path.realpath(dirname)
1596
dirname = self._realpaths[dirname]
1597
abs = pathjoin(dirname, basename)
1598
if dirname in self._relpaths:
1599
relpath = pathjoin(self._relpaths[dirname], basename)
1600
relpath = relpath.rstrip('/\\')
1602
relpath = self._tree.relpath(abs)
1603
self._relpaths[abs] = relpath
1606
def tree_kind(self, trans_id):
1607
"""Determine the file kind in the working tree.
1609
:returns: The file kind or None if the file does not exist
1611
path = self._tree_id_paths.get(trans_id)
1615
return file_kind(self._tree.abspath(path))
1616
except errors.NoSuchFile:
1619
def _set_mode(self, trans_id, mode_id, typefunc):
1620
"""Set the mode of new file contents.
1621
The mode_id is the existing file to get the mode from (often the same
1622
as trans_id). The operation is only performed if there's a mode match
1623
according to typefunc.
1628
old_path = self._tree_id_paths[mode_id]
1632
mode = os.stat(self._tree.abspath(old_path)).st_mode
1634
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1635
# Either old_path doesn't exist, or the parent of the
1636
# target is not a directory (but will be one eventually)
1637
# Either way, we know it doesn't exist *right now*
1638
# See also bug #248448
1643
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1645
def iter_tree_children(self, parent_id):
1646
"""Iterate through the entry's tree children, if any"""
1648
path = self._tree_id_paths[parent_id]
1652
children = os.listdir(self._tree.abspath(path))
1654
if not (osutils._is_error_enotdir(e)
1655
or e.errno in (errno.ENOENT, errno.ESRCH)):
1659
for child in children:
1660
childpath = joinpath(path, child)
1661
if self._tree.is_control_filename(childpath):
1663
yield self.trans_id_tree_path(childpath)
1665
def _generate_limbo_path(self, trans_id):
1666
"""Generate a limbo path using the final path if possible.
1668
This optimizes the performance of applying the tree transform by
1669
avoiding renames. These renames can be avoided only when the parent
1670
directory is already scheduled for creation.
1672
If the final path cannot be used, falls back to using the trans_id as
1675
parent = self._new_parent.get(trans_id)
1676
# if the parent directory is already in limbo (e.g. when building a
1677
# tree), choose a limbo name inside the parent, to reduce further
1679
use_direct_path = False
1680
if self._new_contents.get(parent) == 'directory':
1681
filename = self._new_name.get(trans_id)
1682
if filename is not None:
1683
if parent not in self._limbo_children:
1684
self._limbo_children[parent] = set()
1685
self._limbo_children_names[parent] = {}
1686
use_direct_path = True
1687
# the direct path can only be used if no other file has
1688
# already taken this pathname, i.e. if the name is unused, or
1689
# if it is already associated with this trans_id.
1690
elif self._case_sensitive_target:
1691
if (self._limbo_children_names[parent].get(filename)
1692
in (trans_id, None)):
1693
use_direct_path = True
1695
for l_filename, l_trans_id in\
1696
self._limbo_children_names[parent].iteritems():
1697
if l_trans_id == trans_id:
1699
if l_filename.lower() == filename.lower():
1702
use_direct_path = True
1704
if not use_direct_path:
1705
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1707
limbo_name = pathjoin(self._limbo_files[parent], filename)
1708
self._limbo_children[parent].add(trans_id)
1709
self._limbo_children_names[parent][filename] = trans_id
1713
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1714
"""Apply all changes to the inventory and filesystem.
1716
If filesystem or inventory conflicts are present, MalformedTransform
1719
If apply succeeds, finalize is not necessary.
1721
:param no_conflicts: if True, the caller guarantees there are no
1722
conflicts, so no check is made.
1723
:param precomputed_delta: An inventory delta to use instead of
1725
:param _mover: Supply an alternate FileMover, for testing
1727
for hook in MutableTree.hooks['pre_transform']:
1728
hook(self._tree, self)
1729
if not no_conflicts:
1730
self._check_malformed()
1731
child_pb = ui.ui_factory.nested_progress_bar()
1733
if precomputed_delta is None:
1734
child_pb.update(gettext('Apply phase'), 0, 2)
1735
inventory_delta = self._generate_inventory_delta()
1738
inventory_delta = precomputed_delta
1741
mover = _FileMover()
1745
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1746
self._apply_removals(mover)
1747
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1748
modified_paths = self._apply_insertions(mover)
1753
mover.apply_deletions()
1756
if self.final_file_id(self.root) is None:
1757
inventory_delta = [e for e in inventory_delta if e[0] != '']
1758
self._tree.apply_inventory_delta(inventory_delta)
1759
self._apply_observed_sha1s()
1762
return _TransformResults(modified_paths, self.rename_count)
1764
def _generate_inventory_delta(self):
1765
"""Generate an inventory delta for the current transform."""
1766
inventory_delta = []
1767
child_pb = ui.ui_factory.nested_progress_bar()
1768
new_paths = self._inventory_altered()
1769
total_entries = len(new_paths) + len(self._removed_id)
1771
for num, trans_id in enumerate(self._removed_id):
1773
child_pb.update(gettext('removing file'), num, total_entries)
1774
if trans_id == self._new_root:
1775
file_id = self._tree.get_root_id()
1777
file_id = self.tree_file_id(trans_id)
1778
# File-id isn't really being deleted, just moved
1779
if file_id in self._r_new_id:
1781
path = self._tree_id_paths[trans_id]
1782
inventory_delta.append((path, None, file_id, None))
1783
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1785
entries = self._tree.iter_entries_by_dir(
1786
new_path_file_ids.values())
1787
old_paths = dict((e.file_id, p) for p, e in entries)
1789
for num, (path, trans_id) in enumerate(new_paths):
1791
child_pb.update(gettext('adding file'),
1792
num + len(self._removed_id), total_entries)
1793
file_id = new_path_file_ids[trans_id]
1797
kind = self.final_kind(trans_id)
1799
kind = self._tree.stored_kind(file_id)
1800
parent_trans_id = self.final_parent(trans_id)
1801
parent_file_id = new_path_file_ids.get(parent_trans_id)
1802
if parent_file_id is None:
1803
parent_file_id = self.final_file_id(parent_trans_id)
1804
if trans_id in self._new_reference_revision:
1805
new_entry = inventory.TreeReference(
1807
self._new_name[trans_id],
1808
self.final_file_id(self._new_parent[trans_id]),
1809
None, self._new_reference_revision[trans_id])
1811
new_entry = inventory.make_entry(kind,
1812
self.final_name(trans_id),
1813
parent_file_id, file_id)
1814
old_path = old_paths.get(new_entry.file_id)
1815
new_executability = self._new_executability.get(trans_id)
1816
if new_executability is not None:
1817
new_entry.executable = new_executability
1818
inventory_delta.append(
1819
(old_path, path, new_entry.file_id, new_entry))
1822
return inventory_delta
1824
def _apply_removals(self, mover):
1825
"""Perform tree operations that remove directory/inventory names.
1827
That is, delete files that are to be deleted, and put any files that
1828
need renaming into limbo. This must be done in strict child-to-parent
1831
If inventory_delta is None, no inventory delta generation is performed.
1833
tree_paths = list(self._tree_path_ids.iteritems())
1834
tree_paths.sort(reverse=True)
1835
child_pb = ui.ui_factory.nested_progress_bar()
1837
for num, (path, trans_id) in enumerate(tree_paths):
1838
# do not attempt to move root into a subdirectory of itself.
1841
child_pb.update(gettext('removing file'), num, len(tree_paths))
1842
full_path = self._tree.abspath(path)
1843
if trans_id in self._removed_contents:
1844
delete_path = os.path.join(self._deletiondir, trans_id)
1845
mover.pre_delete(full_path, delete_path)
1846
elif (trans_id in self._new_name
1847
or trans_id in self._new_parent):
1849
mover.rename(full_path, self._limbo_name(trans_id))
1850
except errors.TransformRenameFailed, e:
1851
if e.errno != errno.ENOENT:
1854
self.rename_count += 1
1858
def _apply_insertions(self, mover):
1859
"""Perform tree operations that insert directory/inventory names.
1861
That is, create any files that need to be created, and restore from
1862
limbo any files that needed renaming. This must be done in strict
1863
parent-to-child order.
1865
If inventory_delta is None, no inventory delta is calculated, and
1866
no list of modified paths is returned.
1868
new_paths = self.new_paths(filesystem_only=True)
1870
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1872
child_pb = ui.ui_factory.nested_progress_bar()
1874
for num, (path, trans_id) in enumerate(new_paths):
1876
child_pb.update(gettext('adding file'), num, len(new_paths))
1877
full_path = self._tree.abspath(path)
1878
if trans_id in self._needs_rename:
1880
mover.rename(self._limbo_name(trans_id), full_path)
1881
except errors.TransformRenameFailed, e:
1882
# We may be renaming a dangling inventory id
1883
if e.errno != errno.ENOENT:
1886
self.rename_count += 1
1887
# TODO: if trans_id in self._observed_sha1s, we should
1888
# re-stat the final target, since ctime will be
1889
# updated by the change.
1890
if (trans_id in self._new_contents or
1891
self.path_changed(trans_id)):
1892
if trans_id in self._new_contents:
1893
modified_paths.append(full_path)
1894
if trans_id in self._new_executability:
1895
self._set_executability(path, trans_id)
1896
if trans_id in self._observed_sha1s:
1897
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1898
st = osutils.lstat(full_path)
1899
self._observed_sha1s[trans_id] = (o_sha1, st)
1902
for path, trans_id in new_paths:
1903
# new_paths includes stuff like workingtree conflicts. Only the
1904
# stuff in new_contents actually comes from limbo.
1905
if trans_id in self._limbo_files:
1906
del self._limbo_files[trans_id]
1907
self._new_contents.clear()
1908
return modified_paths
1910
def _apply_observed_sha1s(self):
1911
"""After we have finished renaming everything, update observed sha1s
1913
This has to be done after self._tree.apply_inventory_delta, otherwise
1914
it doesn't know anything about the files we are updating. Also, we want
1915
to do this as late as possible, so that most entries end up cached.
1917
# TODO: this doesn't update the stat information for directories. So
1918
# the first 'bzr status' will still need to rewrite
1919
# .bzr/checkout/dirstate. However, we at least don't need to
1920
# re-read all of the files.
1921
# TODO: If the operation took a while, we could do a time.sleep(3) here
1922
# to allow the clock to tick over and ensure we won't have any
1923
# problems. (we could observe start time, and finish time, and if
1924
# it is less than eg 10% overhead, add a sleep call.)
1925
paths = FinalPaths(self)
1926
for trans_id, observed in self._observed_sha1s.iteritems():
1927
path = paths.get_path(trans_id)
1928
# We could get the file_id, but dirstate prefers to use the path
1929
# anyway, and it is 'cheaper' to determine.
1930
# file_id = self._new_id[trans_id]
1931
self._tree._observed_sha1(None, path, observed)
1934
class TransformPreview(DiskTreeTransform):
1935
"""A TreeTransform for generating preview trees.
1937
Unlike TreeTransform, this version works when the input tree is a
1938
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1939
unversioned files in the input tree.
1942
def __init__(self, tree, pb=None, case_sensitive=True):
1944
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1945
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1947
def canonical_path(self, path):
1950
def tree_kind(self, trans_id):
1951
path = self._tree_id_paths.get(trans_id)
1954
kind = self._tree.path_content_summary(path)[0]
1955
if kind == 'missing':
1959
def _set_mode(self, trans_id, mode_id, typefunc):
1960
"""Set the mode of new file contents.
1961
The mode_id is the existing file to get the mode from (often the same
1962
as trans_id). The operation is only performed if there's a mode match
1963
according to typefunc.
1965
# is it ok to ignore this? probably
1968
def iter_tree_children(self, parent_id):
1969
"""Iterate through the entry's tree children, if any"""
1971
path = self._tree_id_paths[parent_id]
1974
file_id = self.tree_file_id(parent_id)
1977
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1978
children = getattr(entry, 'children', {})
1979
for child in children:
1980
childpath = joinpath(path, child)
1981
yield self.trans_id_tree_path(childpath)
1983
def new_orphan(self, trans_id, parent_id):
1984
raise NotImplementedError(self.new_orphan)
1987
class _PreviewTree(tree.InventoryTree):
1988
"""Partial implementation of Tree to support show_diff_trees"""
1990
def __init__(self, transform):
1991
self._transform = transform
1992
self._final_paths = FinalPaths(transform)
1993
self.__by_parent = None
1994
self._parent_ids = []
1995
self._all_children_cache = {}
1996
self._path2trans_id_cache = {}
1997
self._final_name_cache = {}
1998
self._iter_changes_cache = dict((c[0], c) for c in
1999
self._transform.iter_changes())
2001
def _content_change(self, file_id):
2002
"""Return True if the content of this file changed"""
2003
changes = self._iter_changes_cache.get(file_id)
2004
# changes[2] is true if the file content changed. See
2005
# InterTree.iter_changes.
2006
return (changes is not None and changes[2])
2008
def _get_repository(self):
2009
repo = getattr(self._transform._tree, '_repository', None)
2011
repo = self._transform._tree.branch.repository
2014
def _iter_parent_trees(self):
2015
for revision_id in self.get_parent_ids():
2017
yield self.revision_tree(revision_id)
2018
except errors.NoSuchRevisionInTree:
2019
yield self._get_repository().revision_tree(revision_id)
2021
def _get_file_revision(self, file_id, vf, tree_revision):
2022
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2023
self._iter_parent_trees()]
2024
vf.add_lines((file_id, tree_revision), parent_keys,
2025
self.get_file_lines(file_id))
2026
repo = self._get_repository()
2027
base_vf = repo.texts
2028
if base_vf not in vf.fallback_versionedfiles:
2029
vf.fallback_versionedfiles.append(base_vf)
2030
return tree_revision
2032
def _stat_limbo_file(self, file_id=None, trans_id=None):
2033
if trans_id is None:
2034
trans_id = self._transform.trans_id_file_id(file_id)
2035
name = self._transform._limbo_name(trans_id)
2036
return os.lstat(name)
2039
def _by_parent(self):
2040
if self.__by_parent is None:
2041
self.__by_parent = self._transform.by_parent()
2042
return self.__by_parent
2044
def _comparison_data(self, entry, path):
2045
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2046
if kind == 'missing':
2050
file_id = self._transform.final_file_id(self._path2trans_id(path))
2051
executable = self.is_executable(file_id, path)
2052
return kind, executable, None
2054
def is_locked(self):
2057
def lock_read(self):
2058
# Perhaps in theory, this should lock the TreeTransform?
2065
def inventory(self):
2066
"""This Tree does not use inventory as its backing data."""
2067
raise NotImplementedError(_PreviewTree.inventory)
2069
def get_root_id(self):
2070
return self._transform.final_file_id(self._transform.root)
2072
def all_file_ids(self):
2073
tree_ids = set(self._transform._tree.all_file_ids())
2074
tree_ids.difference_update(self._transform.tree_file_id(t)
2075
for t in self._transform._removed_id)
2076
tree_ids.update(self._transform._new_id.values())
2080
return iter(self.all_file_ids())
2082
def _has_id(self, file_id, fallback_check):
2083
if file_id in self._transform._r_new_id:
2085
elif file_id in set([self._transform.tree_file_id(trans_id) for
2086
trans_id in self._transform._removed_id]):
2089
return fallback_check(file_id)
2091
def has_id(self, file_id):
2092
return self._has_id(file_id, self._transform._tree.has_id)
2094
def has_or_had_id(self, file_id):
2095
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2097
def _path2trans_id(self, path):
2098
# We must not use None here, because that is a valid value to store.
2099
trans_id = self._path2trans_id_cache.get(path, object)
2100
if trans_id is not object:
2102
segments = splitpath(path)
2103
cur_parent = self._transform.root
2104
for cur_segment in segments:
2105
for child in self._all_children(cur_parent):
2106
final_name = self._final_name_cache.get(child)
2107
if final_name is None:
2108
final_name = self._transform.final_name(child)
2109
self._final_name_cache[child] = final_name
2110
if final_name == cur_segment:
2114
self._path2trans_id_cache[path] = None
2116
self._path2trans_id_cache[path] = cur_parent
2119
def path2id(self, path):
2120
return self._transform.final_file_id(self._path2trans_id(path))
2122
def id2path(self, file_id):
2123
trans_id = self._transform.trans_id_file_id(file_id)
2125
return self._final_paths._determine_path(trans_id)
2127
raise errors.NoSuchId(self, file_id)
2129
def _all_children(self, trans_id):
2130
children = self._all_children_cache.get(trans_id)
2131
if children is not None:
2133
children = set(self._transform.iter_tree_children(trans_id))
2134
# children in the _new_parent set are provided by _by_parent.
2135
children.difference_update(self._transform._new_parent.keys())
2136
children.update(self._by_parent.get(trans_id, []))
2137
self._all_children_cache[trans_id] = children
2140
def iter_children(self, file_id):
2141
trans_id = self._transform.trans_id_file_id(file_id)
2142
for child_trans_id in self._all_children(trans_id):
2143
yield self._transform.final_file_id(child_trans_id)
2146
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2147
in self._transform._tree.extras())
2148
possible_extras.update(self._transform._new_contents)
2149
possible_extras.update(self._transform._removed_id)
2150
for trans_id in possible_extras:
2151
if self._transform.final_file_id(trans_id) is None:
2152
yield self._final_paths._determine_path(trans_id)
2154
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2155
yield_parents=False):
2156
for trans_id, parent_file_id in ordered_entries:
2157
file_id = self._transform.final_file_id(trans_id)
2160
if (specific_file_ids is not None
2161
and file_id not in specific_file_ids):
2163
kind = self._transform.final_kind(trans_id)
2165
kind = self._transform._tree.stored_kind(file_id)
2166
new_entry = inventory.make_entry(
2168
self._transform.final_name(trans_id),
2169
parent_file_id, file_id)
2170
yield new_entry, trans_id
2172
def _list_files_by_dir(self):
2173
todo = [ROOT_PARENT]
2175
while len(todo) > 0:
2177
parent_file_id = self._transform.final_file_id(parent)
2178
children = list(self._all_children(parent))
2179
paths = dict(zip(children, self._final_paths.get_paths(children)))
2180
children.sort(key=paths.get)
2181
todo.extend(reversed(children))
2182
for trans_id in children:
2183
ordered_ids.append((trans_id, parent_file_id))
2186
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2187
# This may not be a maximally efficient implementation, but it is
2188
# reasonably straightforward. An implementation that grafts the
2189
# TreeTransform changes onto the tree's iter_entries_by_dir results
2190
# might be more efficient, but requires tricky inferences about stack
2192
ordered_ids = self._list_files_by_dir()
2193
for entry, trans_id in self._make_inv_entries(ordered_ids,
2194
specific_file_ids, yield_parents=yield_parents):
2195
yield unicode(self._final_paths.get_path(trans_id)), entry
2197
def _iter_entries_for_dir(self, dir_path):
2198
"""Return path, entry for items in a directory without recursing down."""
2199
dir_file_id = self.path2id(dir_path)
2201
for file_id in self.iter_children(dir_file_id):
2202
trans_id = self._transform.trans_id_file_id(file_id)
2203
ordered_ids.append((trans_id, file_id))
2204
for entry, trans_id in self._make_inv_entries(ordered_ids):
2205
yield unicode(self._final_paths.get_path(trans_id)), entry
2207
def list_files(self, include_root=False, from_dir=None, recursive=True):
2208
"""See WorkingTree.list_files."""
2209
# XXX This should behave like WorkingTree.list_files, but is really
2210
# more like RevisionTree.list_files.
2214
prefix = from_dir + '/'
2215
entries = self.iter_entries_by_dir()
2216
for path, entry in entries:
2217
if entry.name == '' and not include_root:
2220
if not path.startswith(prefix):
2222
path = path[len(prefix):]
2223
yield path, 'V', entry.kind, entry.file_id, entry
2225
if from_dir is None and include_root is True:
2226
root_entry = inventory.make_entry('directory', '',
2227
ROOT_PARENT, self.get_root_id())
2228
yield '', 'V', 'directory', root_entry.file_id, root_entry
2229
entries = self._iter_entries_for_dir(from_dir or '')
2230
for path, entry in entries:
2231
yield path, 'V', entry.kind, entry.file_id, entry
2233
def kind(self, file_id):
2234
trans_id = self._transform.trans_id_file_id(file_id)
2235
return self._transform.final_kind(trans_id)
2237
def stored_kind(self, file_id):
2238
trans_id = self._transform.trans_id_file_id(file_id)
2240
return self._transform._new_contents[trans_id]
2242
return self._transform._tree.stored_kind(file_id)
2244
def get_file_mtime(self, file_id, path=None):
2245
"""See Tree.get_file_mtime"""
2246
if not self._content_change(file_id):
2247
return self._transform._tree.get_file_mtime(file_id)
2248
return self._stat_limbo_file(file_id).st_mtime
2250
def _file_size(self, entry, stat_value):
2251
return self.get_file_size(entry.file_id)
2253
def get_file_size(self, file_id):
2254
"""See Tree.get_file_size"""
2255
trans_id = self._transform.trans_id_file_id(file_id)
2256
kind = self._transform.final_kind(trans_id)
2259
if trans_id in self._transform._new_contents:
2260
return self._stat_limbo_file(trans_id=trans_id).st_size
2261
if self.kind(file_id) == 'file':
2262
return self._transform._tree.get_file_size(file_id)
2266
def get_file_verifier(self, file_id, path=None, stat_value=None):
2267
trans_id = self._transform.trans_id_file_id(file_id)
2268
kind = self._transform._new_contents.get(trans_id)
2270
return self._transform._tree.get_file_verifier(file_id)
2272
fileobj = self.get_file(file_id)
2274
return ("SHA1", sha_file(fileobj))
2278
def get_file_sha1(self, file_id, path=None, stat_value=None):
2279
trans_id = self._transform.trans_id_file_id(file_id)
2280
kind = self._transform._new_contents.get(trans_id)
2282
return self._transform._tree.get_file_sha1(file_id)
2284
fileobj = self.get_file(file_id)
2286
return sha_file(fileobj)
2290
def is_executable(self, file_id, path=None):
2293
trans_id = self._transform.trans_id_file_id(file_id)
2295
return self._transform._new_executability[trans_id]
2298
return self._transform._tree.is_executable(file_id, path)
2300
if e.errno == errno.ENOENT:
2303
except errors.NoSuchId:
2306
def has_filename(self, path):
2307
trans_id = self._path2trans_id(path)
2308
if trans_id in self._transform._new_contents:
2310
elif trans_id in self._transform._removed_contents:
2313
return self._transform._tree.has_filename(path)
2315
def path_content_summary(self, path):
2316
trans_id = self._path2trans_id(path)
2317
tt = self._transform
2318
tree_path = tt._tree_id_paths.get(trans_id)
2319
kind = tt._new_contents.get(trans_id)
2321
if tree_path is None or trans_id in tt._removed_contents:
2322
return 'missing', None, None, None
2323
summary = tt._tree.path_content_summary(tree_path)
2324
kind, size, executable, link_or_sha1 = summary
2327
limbo_name = tt._limbo_name(trans_id)
2328
if trans_id in tt._new_reference_revision:
2329
kind = 'tree-reference'
2331
statval = os.lstat(limbo_name)
2332
size = statval.st_size
2333
if not tt._limbo_supports_executable():
2336
executable = statval.st_mode & S_IEXEC
2340
if kind == 'symlink':
2341
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2342
executable = tt._new_executability.get(trans_id, executable)
2343
return kind, size, executable, link_or_sha1
2345
def iter_changes(self, from_tree, include_unchanged=False,
2346
specific_files=None, pb=None, extra_trees=None,
2347
require_versioned=True, want_unversioned=False):
2348
"""See InterTree.iter_changes.
2350
This has a fast path that is only used when the from_tree matches
2351
the transform tree, and no fancy options are supplied.
2353
if (from_tree is not self._transform._tree or include_unchanged or
2354
specific_files or want_unversioned):
2355
return tree.InterTree(from_tree, self).iter_changes(
2356
include_unchanged=include_unchanged,
2357
specific_files=specific_files,
2359
extra_trees=extra_trees,
2360
require_versioned=require_versioned,
2361
want_unversioned=want_unversioned)
2362
if want_unversioned:
2363
raise ValueError('want_unversioned is not supported')
2364
return self._transform.iter_changes()
2366
def get_file(self, file_id, path=None):
2367
"""See Tree.get_file"""
2368
if not self._content_change(file_id):
2369
return self._transform._tree.get_file(file_id, path)
2370
trans_id = self._transform.trans_id_file_id(file_id)
2371
name = self._transform._limbo_name(trans_id)
2372
return open(name, 'rb')
2374
def get_file_with_stat(self, file_id, path=None):
2375
return self.get_file(file_id, path), None
2377
def annotate_iter(self, file_id,
2378
default_revision=_mod_revision.CURRENT_REVISION):
2379
changes = self._iter_changes_cache.get(file_id)
2383
changed_content, versioned, kind = (changes[2], changes[3],
2387
get_old = (kind[0] == 'file' and versioned[0])
2389
old_annotation = self._transform._tree.annotate_iter(file_id,
2390
default_revision=default_revision)
2394
return old_annotation
2395
if not changed_content:
2396
return old_annotation
2397
# TODO: This is doing something similar to what WT.annotate_iter is
2398
# doing, however it fails slightly because it doesn't know what
2399
# the *other* revision_id is, so it doesn't know how to give the
2400
# other as the origin for some lines, they all get
2401
# 'default_revision'
2402
# It would be nice to be able to use the new Annotator based
2403
# approach, as well.
2404
return annotate.reannotate([old_annotation],
2405
self.get_file(file_id).readlines(),
2408
def get_symlink_target(self, file_id, path=None):
2409
"""See Tree.get_symlink_target"""
2410
if not self._content_change(file_id):
2411
return self._transform._tree.get_symlink_target(file_id)
2412
trans_id = self._transform.trans_id_file_id(file_id)
2413
name = self._transform._limbo_name(trans_id)
2414
return osutils.readlink(name)
2416
def walkdirs(self, prefix=''):
2417
pending = [self._transform.root]
2418
while len(pending) > 0:
2419
parent_id = pending.pop()
2422
prefix = prefix.rstrip('/')
2423
parent_path = self._final_paths.get_path(parent_id)
2424
parent_file_id = self._transform.final_file_id(parent_id)
2425
for child_id in self._all_children(parent_id):
2426
path_from_root = self._final_paths.get_path(child_id)
2427
basename = self._transform.final_name(child_id)
2428
file_id = self._transform.final_file_id(child_id)
2429
kind = self._transform.final_kind(child_id)
2430
if kind is not None:
2431
versioned_kind = kind
2434
versioned_kind = self._transform._tree.stored_kind(file_id)
2435
if versioned_kind == 'directory':
2436
subdirs.append(child_id)
2437
children.append((path_from_root, basename, kind, None,
2438
file_id, versioned_kind))
2440
if parent_path.startswith(prefix):
2441
yield (parent_path, parent_file_id), children
2442
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2445
def get_parent_ids(self):
2446
return self._parent_ids
2448
def set_parent_ids(self, parent_ids):
2449
self._parent_ids = parent_ids
2451
def get_revision_tree(self, revision_id):
2452
return self._transform._tree.get_revision_tree(revision_id)
2455
def joinpath(parent, child):
2456
"""Join tree-relative paths, handling the tree root specially"""
2457
if parent is None or parent == "":
2460
return pathjoin(parent, child)
2463
class FinalPaths(object):
2464
"""Make path calculation cheap by memoizing paths.
2466
The underlying tree must not be manipulated between calls, or else
2467
the results will likely be incorrect.
2469
def __init__(self, transform):
2470
object.__init__(self)
2471
self._known_paths = {}
2472
self.transform = transform
2474
def _determine_path(self, trans_id):
2475
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2477
name = self.transform.final_name(trans_id)
2478
parent_id = self.transform.final_parent(trans_id)
2479
if parent_id == self.transform.root:
2482
return pathjoin(self.get_path(parent_id), name)
2484
def get_path(self, trans_id):
2485
"""Find the final path associated with a trans_id"""
2486
if trans_id not in self._known_paths:
2487
self._known_paths[trans_id] = self._determine_path(trans_id)
2488
return self._known_paths[trans_id]
2490
def get_paths(self, trans_ids):
2491
return [(self.get_path(t), t) for t in trans_ids]
2495
def topology_sorted_ids(tree):
2496
"""Determine the topological order of the ids in a tree"""
2497
file_ids = list(tree)
2498
file_ids.sort(key=tree.id2path)
2502
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2503
delta_from_tree=False):
2504
"""Create working tree for a branch, using a TreeTransform.
2506
This function should be used on empty trees, having a tree root at most.
2507
(see merge and revert functionality for working with existing trees)
2509
Existing files are handled like so:
2511
- Existing bzrdirs take precedence over creating new items. They are
2512
created as '%s.diverted' % name.
2513
- Otherwise, if the content on disk matches the content we are building,
2514
it is silently replaced.
2515
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2517
:param tree: The tree to convert wt into a copy of
2518
:param wt: The working tree that files will be placed into
2519
:param accelerator_tree: A tree which can be used for retrieving file
2520
contents more quickly than tree itself, i.e. a workingtree. tree
2521
will be used for cases where accelerator_tree's content is different.
2522
:param hardlink: If true, hard-link files to accelerator_tree, where
2523
possible. accelerator_tree must implement abspath, i.e. be a
2525
:param delta_from_tree: If true, build_tree may use the input Tree to
2526
generate the inventory delta.
2528
wt.lock_tree_write()
2532
if accelerator_tree is not None:
2533
accelerator_tree.lock_read()
2535
return _build_tree(tree, wt, accelerator_tree, hardlink,
2538
if accelerator_tree is not None:
2539
accelerator_tree.unlock()
2546
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2547
"""See build_tree."""
2548
for num, _unused in enumerate(wt.all_file_ids()):
2549
if num > 0: # more than just a root
2550
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2552
top_pb = ui.ui_factory.nested_progress_bar()
2553
pp = ProgressPhase("Build phase", 2, top_pb)
2554
if tree.get_root_id() is not None:
2555
# This is kind of a hack: we should be altering the root
2556
# as part of the regular tree shape diff logic.
2557
# The conditional test here is to avoid doing an
2558
# expensive operation (flush) every time the root id
2559
# is set within the tree, nor setting the root and thus
2560
# marking the tree as dirty, because we use two different
2561
# idioms here: tree interfaces and inventory interfaces.
2562
if wt.get_root_id() != tree.get_root_id():
2563
wt.set_root_id(tree.get_root_id())
2565
tt = TreeTransform(wt)
2569
file_trans_id[wt.get_root_id()] = \
2570
tt.trans_id_tree_file_id(wt.get_root_id())
2571
pb = ui.ui_factory.nested_progress_bar()
2573
deferred_contents = []
2575
total = len(tree.all_file_ids())
2577
precomputed_delta = []
2579
precomputed_delta = None
2580
# Check if tree inventory has content. If so, we populate
2581
# existing_files with the directory content. If there are no
2582
# entries we skip populating existing_files as its not used.
2583
# This improves performance and unncessary work on large
2584
# directory trees. (#501307)
2586
existing_files = set()
2587
for dir, files in wt.walkdirs():
2588
existing_files.update(f[0] for f in files)
2589
for num, (tree_path, entry) in \
2590
enumerate(tree.iter_entries_by_dir()):
2591
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2592
if entry.parent_id is None:
2595
file_id = entry.file_id
2597
precomputed_delta.append((None, tree_path, file_id, entry))
2598
if tree_path in existing_files:
2599
target_path = wt.abspath(tree_path)
2600
kind = file_kind(target_path)
2601
if kind == "directory":
2603
controldir.ControlDir.open(target_path)
2604
except errors.NotBranchError:
2608
if (file_id not in divert and
2609
_content_match(tree, entry, file_id, kind,
2611
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2612
if kind == 'directory':
2614
parent_id = file_trans_id[entry.parent_id]
2615
if entry.kind == 'file':
2616
# We *almost* replicate new_by_entry, so that we can defer
2617
# getting the file text, and get them all at once.
2618
trans_id = tt.create_path(entry.name, parent_id)
2619
file_trans_id[file_id] = trans_id
2620
tt.version_file(file_id, trans_id)
2621
executable = tree.is_executable(file_id, tree_path)
2623
tt.set_executability(executable, trans_id)
2624
trans_data = (trans_id, tree_path, entry.text_sha1)
2625
deferred_contents.append((file_id, trans_data))
2627
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2630
new_trans_id = file_trans_id[file_id]
2631
old_parent = tt.trans_id_tree_path(tree_path)
2632
_reparent_children(tt, old_parent, new_trans_id)
2633
offset = num + 1 - len(deferred_contents)
2634
_create_files(tt, tree, deferred_contents, pb, offset,
2635
accelerator_tree, hardlink)
2639
divert_trans = set(file_trans_id[f] for f in divert)
2640
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2641
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2642
if len(raw_conflicts) > 0:
2643
precomputed_delta = None
2644
conflicts = cook_conflicts(raw_conflicts, tt)
2645
for conflict in conflicts:
2646
trace.warning(unicode(conflict))
2648
wt.add_conflicts(conflicts)
2649
except errors.UnsupportedOperation:
2651
result = tt.apply(no_conflicts=True,
2652
precomputed_delta=precomputed_delta)
2659
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2661
total = len(desired_files) + offset
2663
if accelerator_tree is None:
2664
new_desired_files = desired_files
2666
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2667
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2668
in iter if not (c or e[0] != e[1])]
2669
if accelerator_tree.supports_content_filtering():
2670
unchanged = [(f, p) for (f, p) in unchanged
2671
if not accelerator_tree.iter_search_rules([p]).next()]
2672
unchanged = dict(unchanged)
2673
new_desired_files = []
2675
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2676
accelerator_path = unchanged.get(file_id)
2677
if accelerator_path is None:
2678
new_desired_files.append((file_id,
2679
(trans_id, tree_path, text_sha1)))
2681
pb.update(gettext('Adding file contents'), count + offset, total)
2683
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2686
contents = accelerator_tree.get_file(file_id, accelerator_path)
2687
if wt.supports_content_filtering():
2688
filters = wt._content_filter_stack(tree_path)
2689
contents = filtered_output_bytes(contents, filters,
2690
ContentFilterContext(tree_path, tree))
2692
tt.create_file(contents, trans_id, sha1=text_sha1)
2696
except AttributeError:
2697
# after filtering, contents may no longer be file-like
2701
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2702
tree.iter_files_bytes(new_desired_files)):
2703
if wt.supports_content_filtering():
2704
filters = wt._content_filter_stack(tree_path)
2705
contents = filtered_output_bytes(contents, filters,
2706
ContentFilterContext(tree_path, tree))
2707
tt.create_file(contents, trans_id, sha1=text_sha1)
2708
pb.update(gettext('Adding file contents'), count + offset, total)
2711
def _reparent_children(tt, old_parent, new_parent):
2712
for child in tt.iter_tree_children(old_parent):
2713
tt.adjust_path(tt.final_name(child), new_parent, child)
2716
def _reparent_transform_children(tt, old_parent, new_parent):
2717
by_parent = tt.by_parent()
2718
for child in by_parent[old_parent]:
2719
tt.adjust_path(tt.final_name(child), new_parent, child)
2720
return by_parent[old_parent]
2723
def _content_match(tree, entry, file_id, kind, target_path):
2724
if entry.kind != kind:
2726
if entry.kind == "directory":
2728
if entry.kind == "file":
2729
f = file(target_path, 'rb')
2731
if tree.get_file_text(file_id) == f.read():
2735
elif entry.kind == "symlink":
2736
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2741
def resolve_checkout(tt, conflicts, divert):
2742
new_conflicts = set()
2743
for c_type, conflict in ((c[0], c) for c in conflicts):
2744
# Anything but a 'duplicate' would indicate programmer error
2745
if c_type != 'duplicate':
2746
raise AssertionError(c_type)
2747
# Now figure out which is new and which is old
2748
if tt.new_contents(conflict[1]):
2749
new_file = conflict[1]
2750
old_file = conflict[2]
2752
new_file = conflict[2]
2753
old_file = conflict[1]
2755
# We should only get here if the conflict wasn't completely
2757
final_parent = tt.final_parent(old_file)
2758
if new_file in divert:
2759
new_name = tt.final_name(old_file)+'.diverted'
2760
tt.adjust_path(new_name, final_parent, new_file)
2761
new_conflicts.add((c_type, 'Diverted to',
2762
new_file, old_file))
2764
new_name = tt.final_name(old_file)+'.moved'
2765
tt.adjust_path(new_name, final_parent, old_file)
2766
new_conflicts.add((c_type, 'Moved existing file to',
2767
old_file, new_file))
2768
return new_conflicts
2771
def new_by_entry(tt, entry, parent_id, tree):
2772
"""Create a new file according to its inventory entry"""
2776
contents = tree.get_file(entry.file_id).readlines()
2777
executable = tree.is_executable(entry.file_id)
2778
return tt.new_file(name, parent_id, contents, entry.file_id,
2780
elif kind in ('directory', 'tree-reference'):
2781
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2782
if kind == 'tree-reference':
2783
tt.set_tree_reference(entry.reference_revision, trans_id)
2785
elif kind == 'symlink':
2786
target = tree.get_symlink_target(entry.file_id)
2787
return tt.new_symlink(name, parent_id, target, entry.file_id)
2789
raise errors.BadFileKindError(name, kind)
2792
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2793
filter_tree_path=None):
2794
"""Create new file contents according to tree contents.
2796
:param filter_tree_path: the tree path to use to lookup
2797
content filters to apply to the bytes output in the working tree.
2798
This only applies if the working tree supports content filtering.
2800
kind = tree.kind(file_id)
2801
if kind == 'directory':
2802
tt.create_directory(trans_id)
2803
elif kind == "file":
2805
tree_file = tree.get_file(file_id)
2807
bytes = tree_file.readlines()
2811
if wt.supports_content_filtering() and filter_tree_path is not None:
2812
filters = wt._content_filter_stack(filter_tree_path)
2813
bytes = filtered_output_bytes(bytes, filters,
2814
ContentFilterContext(filter_tree_path, tree))
2815
tt.create_file(bytes, trans_id)
2816
elif kind == "symlink":
2817
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2819
raise AssertionError('Unknown kind %r' % kind)
2822
def create_entry_executability(tt, entry, trans_id):
2823
"""Set the executability of a trans_id according to an inventory entry"""
2824
if entry.kind == "file":
2825
tt.set_executability(entry.executable, trans_id)
2828
@deprecated_function(deprecated_in((2, 3, 0)))
2829
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2830
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2833
@deprecated_function(deprecated_in((2, 3, 0)))
2834
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2835
"""Produce a backup-style name that appears to be available"""
2839
yield "%s.~%d~" % (name, counter)
2841
for new_name in name_gen():
2842
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2846
def revert(working_tree, target_tree, filenames, backups=False,
2847
pb=None, change_reporter=None):
2848
"""Revert a working tree's contents to those of a target tree."""
2849
target_tree.lock_read()
2850
pb = ui.ui_factory.nested_progress_bar()
2851
tt = TreeTransform(working_tree, pb)
2853
pp = ProgressPhase("Revert phase", 3, pb)
2854
conflicts, merge_modified = _prepare_revert_transform(
2855
working_tree, target_tree, tt, filenames, backups, pp)
2857
change_reporter = delta._ChangeReporter(
2858
unversioned_filter=working_tree.is_ignored)
2859
delta.report_changes(tt.iter_changes(), change_reporter)
2860
for conflict in conflicts:
2861
trace.warning(unicode(conflict))
2864
working_tree.set_merge_modified(merge_modified)
2866
target_tree.unlock()
2872
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2873
backups, pp, basis_tree=None,
2874
merge_modified=None):
2875
child_pb = ui.ui_factory.nested_progress_bar()
2877
if merge_modified is None:
2878
merge_modified = working_tree.merge_modified()
2879
merge_modified = _alter_files(working_tree, target_tree, tt,
2880
child_pb, filenames, backups,
2881
merge_modified, basis_tree)
2884
child_pb = ui.ui_factory.nested_progress_bar()
2886
raw_conflicts = resolve_conflicts(tt, child_pb,
2887
lambda t, c: conflict_pass(t, c, target_tree))
2890
conflicts = cook_conflicts(raw_conflicts, tt)
2891
return conflicts, merge_modified
2894
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2895
backups, merge_modified, basis_tree=None):
2896
if basis_tree is not None:
2897
basis_tree.lock_read()
2898
# We ask the working_tree for its changes relative to the target, rather
2899
# than the target changes relative to the working tree. Because WT4 has an
2900
# optimizer to compare itself to a target, but no optimizer for the
2902
change_list = working_tree.iter_changes(target_tree,
2903
specific_files=specific_files, pb=pb)
2904
if target_tree.get_root_id() is None:
2910
for id_num, (file_id, path, changed_content, versioned, parent, name,
2911
kind, executable) in enumerate(change_list):
2912
target_path, wt_path = path
2913
target_versioned, wt_versioned = versioned
2914
target_parent, wt_parent = parent
2915
target_name, wt_name = name
2916
target_kind, wt_kind = kind
2917
target_executable, wt_executable = executable
2918
if skip_root and wt_parent is None:
2920
trans_id = tt.trans_id_file_id(file_id)
2923
keep_content = False
2924
if wt_kind == 'file' and (backups or target_kind is None):
2925
wt_sha1 = working_tree.get_file_sha1(file_id)
2926
if merge_modified.get(file_id) != wt_sha1:
2927
# acquire the basis tree lazily to prevent the
2928
# expense of accessing it when it's not needed ?
2929
# (Guessing, RBC, 200702)
2930
if basis_tree is None:
2931
basis_tree = working_tree.basis_tree()
2932
basis_tree.lock_read()
2933
if basis_tree.has_id(file_id):
2934
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2936
elif target_kind is None and not target_versioned:
2938
if wt_kind is not None:
2939
if not keep_content:
2940
tt.delete_contents(trans_id)
2941
elif target_kind is not None:
2942
parent_trans_id = tt.trans_id_file_id(wt_parent)
2943
backup_name = tt._available_backup_name(
2944
wt_name, parent_trans_id)
2945
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2946
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2947
if wt_versioned and target_versioned:
2948
tt.unversion_file(trans_id)
2949
tt.version_file(file_id, new_trans_id)
2950
# New contents should have the same unix perms as old
2953
trans_id = new_trans_id
2954
if target_kind in ('directory', 'tree-reference'):
2955
tt.create_directory(trans_id)
2956
if target_kind == 'tree-reference':
2957
revision = target_tree.get_reference_revision(file_id,
2959
tt.set_tree_reference(revision, trans_id)
2960
elif target_kind == 'symlink':
2961
tt.create_symlink(target_tree.get_symlink_target(file_id),
2963
elif target_kind == 'file':
2964
deferred_files.append((file_id, (trans_id, mode_id)))
2965
if basis_tree is None:
2966
basis_tree = working_tree.basis_tree()
2967
basis_tree.lock_read()
2968
new_sha1 = target_tree.get_file_sha1(file_id)
2969
if (basis_tree.has_id(file_id) and
2970
new_sha1 == basis_tree.get_file_sha1(file_id)):
2971
if file_id in merge_modified:
2972
del merge_modified[file_id]
2974
merge_modified[file_id] = new_sha1
2976
# preserve the execute bit when backing up
2977
if keep_content and wt_executable == target_executable:
2978
tt.set_executability(target_executable, trans_id)
2979
elif target_kind is not None:
2980
raise AssertionError(target_kind)
2981
if not wt_versioned and target_versioned:
2982
tt.version_file(file_id, trans_id)
2983
if wt_versioned and not target_versioned:
2984
tt.unversion_file(trans_id)
2985
if (target_name is not None and
2986
(wt_name != target_name or wt_parent != target_parent)):
2987
if target_name == '' and target_parent is None:
2988
parent_trans = ROOT_PARENT
2990
parent_trans = tt.trans_id_file_id(target_parent)
2991
if wt_parent is None and wt_versioned:
2992
tt.adjust_root_path(target_name, parent_trans)
2994
tt.adjust_path(target_name, parent_trans, trans_id)
2995
if wt_executable != target_executable and target_kind == "file":
2996
tt.set_executability(target_executable, trans_id)
2997
if working_tree.supports_content_filtering():
2998
for index, ((trans_id, mode_id), bytes) in enumerate(
2999
target_tree.iter_files_bytes(deferred_files)):
3000
file_id = deferred_files[index][0]
3001
# We're reverting a tree to the target tree so using the
3002
# target tree to find the file path seems the best choice
3003
# here IMO - Ian C 27/Oct/2009
3004
filter_tree_path = target_tree.id2path(file_id)
3005
filters = working_tree._content_filter_stack(filter_tree_path)
3006
bytes = filtered_output_bytes(bytes, filters,
3007
ContentFilterContext(filter_tree_path, working_tree))
3008
tt.create_file(bytes, trans_id, mode_id)
3010
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3012
tt.create_file(bytes, trans_id, mode_id)
3013
tt.fixup_new_roots()
3015
if basis_tree is not None:
3017
return merge_modified
3020
def resolve_conflicts(tt, pb=None, pass_func=None):
3021
"""Make many conflict-resolution attempts, but die if they fail"""
3022
if pass_func is None:
3023
pass_func = conflict_pass
3024
new_conflicts = set()
3025
pb = ui.ui_factory.nested_progress_bar()
3028
pb.update(gettext('Resolution pass'), n+1, 10)
3029
conflicts = tt.find_conflicts()
3030
if len(conflicts) == 0:
3031
return new_conflicts
3032
new_conflicts.update(pass_func(tt, conflicts))
3033
raise MalformedTransform(conflicts=conflicts)
3038
def conflict_pass(tt, conflicts, path_tree=None):
3039
"""Resolve some classes of conflicts.
3041
:param tt: The transform to resolve conflicts in
3042
:param conflicts: The conflicts to resolve
3043
:param path_tree: A Tree to get supplemental paths from
3045
new_conflicts = set()
3046
for c_type, conflict in ((c[0], c) for c in conflicts):
3047
if c_type == 'duplicate id':
3048
tt.unversion_file(conflict[1])
3049
new_conflicts.add((c_type, 'Unversioned existing file',
3050
conflict[1], conflict[2], ))
3051
elif c_type == 'duplicate':
3052
# files that were renamed take precedence
3053
final_parent = tt.final_parent(conflict[1])
3054
if tt.path_changed(conflict[1]):
3055
existing_file, new_file = conflict[2], conflict[1]
3057
existing_file, new_file = conflict[1], conflict[2]
3058
new_name = tt.final_name(existing_file) + '.moved'
3059
tt.adjust_path(new_name, final_parent, existing_file)
3060
new_conflicts.add((c_type, 'Moved existing file to',
3061
existing_file, new_file))
3062
elif c_type == 'parent loop':
3063
# break the loop by undoing one of the ops that caused the loop
3065
while not tt.path_changed(cur):
3066
cur = tt.final_parent(cur)
3067
new_conflicts.add((c_type, 'Cancelled move', cur,
3068
tt.final_parent(cur),))
3069
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3071
elif c_type == 'missing parent':
3072
trans_id = conflict[1]
3073
if trans_id in tt._removed_contents:
3074
cancel_deletion = True
3075
orphans = tt._get_potential_orphans(trans_id)
3077
cancel_deletion = False
3078
# All children are orphans
3081
tt.new_orphan(o, trans_id)
3082
except OrphaningError:
3083
# Something bad happened so we cancel the directory
3084
# deletion which will leave it in place with a
3085
# conflict. The user can deal with it from there.
3086
# Note that this also catch the case where we don't
3087
# want to create orphans and leave the directory in
3089
cancel_deletion = True
3092
# Cancel the directory deletion
3093
tt.cancel_deletion(trans_id)
3094
new_conflicts.add(('deleting parent', 'Not deleting',
3099
tt.final_name(trans_id)
3101
if path_tree is not None:
3102
file_id = tt.final_file_id(trans_id)
3104
file_id = tt.inactive_file_id(trans_id)
3105
_, entry = path_tree.iter_entries_by_dir(
3107
# special-case the other tree root (move its
3108
# children to current root)
3109
if entry.parent_id is None:
3111
moved = _reparent_transform_children(
3112
tt, trans_id, tt.root)
3114
new_conflicts.add((c_type, 'Moved to root',
3117
parent_trans_id = tt.trans_id_file_id(
3119
tt.adjust_path(entry.name, parent_trans_id,
3122
tt.create_directory(trans_id)
3123
new_conflicts.add((c_type, 'Created directory', trans_id))
3124
elif c_type == 'unversioned parent':
3125
file_id = tt.inactive_file_id(conflict[1])
3126
# special-case the other tree root (move its children instead)
3127
if path_tree and path_tree.has_id(file_id):
3128
if path_tree.path2id('') == file_id:
3129
# This is the root entry, skip it
3131
tt.version_file(file_id, conflict[1])
3132
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3133
elif c_type == 'non-directory parent':
3134
parent_id = conflict[1]
3135
parent_parent = tt.final_parent(parent_id)
3136
parent_name = tt.final_name(parent_id)
3137
parent_file_id = tt.final_file_id(parent_id)
3138
new_parent_id = tt.new_directory(parent_name + '.new',
3139
parent_parent, parent_file_id)
3140
_reparent_transform_children(tt, parent_id, new_parent_id)
3141
if parent_file_id is not None:
3142
tt.unversion_file(parent_id)
3143
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3144
elif c_type == 'versioning no contents':
3145
tt.cancel_versioning(conflict[1])
3146
return new_conflicts
3149
def cook_conflicts(raw_conflicts, tt):
3150
"""Generate a list of cooked conflicts, sorted by file path"""
3151
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3152
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3155
def iter_cook_conflicts(raw_conflicts, tt):
3157
for conflict in raw_conflicts:
3158
c_type = conflict[0]
3159
action = conflict[1]
3160
modified_path = fp.get_path(conflict[2])
3161
modified_id = tt.final_file_id(conflict[2])
3162
if len(conflict) == 3:
3163
yield conflicts.Conflict.factory(
3164
c_type, action=action, path=modified_path, file_id=modified_id)
3167
conflicting_path = fp.get_path(conflict[3])
3168
conflicting_id = tt.final_file_id(conflict[3])
3169
yield conflicts.Conflict.factory(
3170
c_type, action=action, path=modified_path,
3171
file_id=modified_id,
3172
conflict_path=conflicting_path,
3173
conflict_file_id=conflicting_id)
3176
class _FileMover(object):
3177
"""Moves and deletes files for TreeTransform, tracking operations"""
3180
self.past_renames = []
3181
self.pending_deletions = []
3183
def rename(self, from_, to):
3184
"""Rename a file from one path to another."""
3186
os.rename(from_, to)
3188
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3189
raise errors.FileExists(to, str(e))
3190
# normal OSError doesn't include filenames so it's hard to see where
3191
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3192
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3193
self.past_renames.append((from_, to))
3195
def pre_delete(self, from_, to):
3196
"""Rename a file out of the way and mark it for deletion.
3198
Unlike os.unlink, this works equally well for files and directories.
3199
:param from_: The current file path
3200
:param to: A temporary path for the file
3202
self.rename(from_, to)
3203
self.pending_deletions.append(to)
3206
"""Reverse all renames that have been performed"""
3207
for from_, to in reversed(self.past_renames):
3209
os.rename(to, from_)
3211
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3212
# after rollback, don't reuse _FileMover
3214
pending_deletions = None
3216
def apply_deletions(self):
3217
"""Apply all marked deletions"""
3218
for path in self.pending_deletions:
3220
# after apply_deletions, don't reuse _FileMover
3222
pending_deletions = None
added
removed
bzrlib/transform.py
