1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from stat import S_ISREG, S_IEXEC
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
32
revision as _mod_revision,
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
ReusingTransform, NotVersionedError, CantMoveRoot,
37
ExistingLimbo, ImmortalLimbo, NoFinalPath,
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
40
from bzrlib.inventory import InventoryEntry
41
from bzrlib.osutils import (
51
from bzrlib.progress import DummyProgress, ProgressPhase
52
from bzrlib.symbol_versioning import (
56
from bzrlib.trace import mutter, warning
57
from bzrlib import tree
59
import bzrlib.urlutils as urlutils
62
ROOT_PARENT = "root-parent"
65
def unique_add(map, key, value):
67
raise DuplicateKey(key=key)
71
class _TransformResults(object):
72
def __init__(self, modified_paths, rename_count):
74
self.modified_paths = modified_paths
75
self.rename_count = rename_count
78
class TreeTransformBase(object):
79
"""The base class for TreeTransform and its kin."""
81
def __init__(self, tree, pb=DummyProgress(),
85
:param tree: The tree that will be transformed, but not necessarily
87
:param pb: A ProgressBar indicating how much progress is being made
88
:param case_sensitive: If True, the target of the transform is
89
case sensitive, not just case preserving.
94
# mapping of trans_id -> new basename
96
# mapping of trans_id -> new parent trans_id
98
# mapping of trans_id with new contents -> new file_kind
99
self._new_contents = {}
100
# Set of trans_ids whose contents will be removed
101
self._removed_contents = set()
102
# Mapping of trans_id -> new execute-bit value
103
self._new_executability = {}
104
# Mapping of trans_id -> new tree-reference value
105
self._new_reference_revision = {}
106
# Mapping of trans_id -> new file_id
108
# Mapping of old file-id -> trans_id
109
self._non_present_ids = {}
110
# Mapping of new file_id -> trans_id
112
# Set of trans_ids that will be removed
113
self._removed_id = set()
114
# Mapping of path in old tree -> trans_id
115
self._tree_path_ids = {}
116
# Mapping trans_id -> path in old tree
117
self._tree_id_paths = {}
118
# The trans_id that will be used as the tree root
119
root_id = tree.get_root_id()
120
if root_id is not None:
121
self._new_root = self.trans_id_tree_file_id(root_id)
123
self._new_root = None
124
# Indictor of whether the transform has been applied
128
# Whether the target is case sensitive
129
self._case_sensitive_target = case_sensitive
130
# A counter of how many files have been renamed
131
self.rename_count = 0
134
"""Release the working tree lock, if held.
136
This is required if apply has not been invoked, but can be invoked
139
if self._tree is None:
144
def __get_root(self):
145
return self._new_root
147
root = property(__get_root)
149
def _assign_id(self):
150
"""Produce a new tranform id"""
151
new_id = "new-%s" % self._id_number
155
def create_path(self, name, parent):
156
"""Assign a transaction id to a new path"""
157
trans_id = self._assign_id()
158
unique_add(self._new_name, trans_id, name)
159
unique_add(self._new_parent, trans_id, parent)
162
def adjust_path(self, name, parent, trans_id):
163
"""Change the path that is assigned to a transaction id."""
164
if trans_id == self._new_root:
166
self._new_name[trans_id] = name
167
self._new_parent[trans_id] = parent
168
if parent == ROOT_PARENT:
169
if self._new_root is not None:
170
raise ValueError("Cannot have multiple roots.")
171
self._new_root = trans_id
173
def adjust_root_path(self, name, parent):
174
"""Emulate moving the root by moving all children, instead.
176
We do this by undoing the association of root's transaction id with the
177
current tree. This allows us to create a new directory with that
178
transaction id. We unversion the root directory and version the
179
physically new directory, and hope someone versions the tree root
182
old_root = self._new_root
183
old_root_file_id = self.final_file_id(old_root)
184
# force moving all children of root
185
for child_id in self.iter_tree_children(old_root):
186
if child_id != parent:
187
self.adjust_path(self.final_name(child_id),
188
self.final_parent(child_id), child_id)
189
file_id = self.final_file_id(child_id)
190
if file_id is not None:
191
self.unversion_file(child_id)
192
self.version_file(file_id, child_id)
194
# the physical root needs a new transaction id
195
self._tree_path_ids.pop("")
196
self._tree_id_paths.pop(old_root)
197
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
198
if parent == old_root:
199
parent = self._new_root
200
self.adjust_path(name, parent, old_root)
201
self.create_directory(old_root)
202
self.version_file(old_root_file_id, old_root)
203
self.unversion_file(self._new_root)
205
def trans_id_tree_file_id(self, inventory_id):
206
"""Determine the transaction id of a working tree file.
208
This reflects only files that already exist, not ones that will be
209
added by transactions.
211
if inventory_id is None:
212
raise ValueError('None is not a valid file id')
213
path = self._tree.id2path(inventory_id)
214
return self.trans_id_tree_path(path)
216
def trans_id_file_id(self, file_id):
217
"""Determine or set the transaction id associated with a file ID.
218
A new id is only created for file_ids that were never present. If
219
a transaction has been unversioned, it is deliberately still returned.
220
(this will likely lead to an unversioned parent conflict.)
223
raise ValueError('None is not a valid file id')
224
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
225
return self._r_new_id[file_id]
228
self._tree.iter_entries_by_dir([file_id]).next()
229
except StopIteration:
230
if file_id in self._non_present_ids:
231
return self._non_present_ids[file_id]
233
trans_id = self._assign_id()
234
self._non_present_ids[file_id] = trans_id
237
return self.trans_id_tree_file_id(file_id)
239
def trans_id_tree_path(self, path):
240
"""Determine (and maybe set) the transaction ID for a tree path."""
241
path = self.canonical_path(path)
242
if path not in self._tree_path_ids:
243
self._tree_path_ids[path] = self._assign_id()
244
self._tree_id_paths[self._tree_path_ids[path]] = path
245
return self._tree_path_ids[path]
247
def get_tree_parent(self, trans_id):
248
"""Determine id of the parent in the tree."""
249
path = self._tree_id_paths[trans_id]
252
return self.trans_id_tree_path(os.path.dirname(path))
254
def delete_contents(self, trans_id):
255
"""Schedule the contents of a path entry for deletion"""
256
self.tree_kind(trans_id)
257
self._removed_contents.add(trans_id)
259
def cancel_deletion(self, trans_id):
260
"""Cancel a scheduled deletion"""
261
self._removed_contents.remove(trans_id)
263
def unversion_file(self, trans_id):
264
"""Schedule a path entry to become unversioned"""
265
self._removed_id.add(trans_id)
267
def delete_versioned(self, trans_id):
268
"""Delete and unversion a versioned file"""
269
self.delete_contents(trans_id)
270
self.unversion_file(trans_id)
272
def set_executability(self, executability, trans_id):
273
"""Schedule setting of the 'execute' bit
274
To unschedule, set to None
276
if executability is None:
277
del self._new_executability[trans_id]
279
unique_add(self._new_executability, trans_id, executability)
281
def set_tree_reference(self, revision_id, trans_id):
282
"""Set the reference associated with a directory"""
283
unique_add(self._new_reference_revision, trans_id, revision_id)
285
def version_file(self, file_id, trans_id):
286
"""Schedule a file to become versioned."""
289
unique_add(self._new_id, trans_id, file_id)
290
unique_add(self._r_new_id, file_id, trans_id)
292
def cancel_versioning(self, trans_id):
293
"""Undo a previous versioning of a file"""
294
file_id = self._new_id[trans_id]
295
del self._new_id[trans_id]
296
del self._r_new_id[file_id]
298
def new_paths(self, filesystem_only=False):
299
"""Determine the paths of all new and changed files.
301
:param filesystem_only: if True, only calculate values for files
302
that require renames or execute bit changes.
306
stale_ids = self._needs_rename.difference(self._new_name)
307
stale_ids.difference_update(self._new_parent)
308
stale_ids.difference_update(self._new_contents)
309
stale_ids.difference_update(self._new_id)
310
needs_rename = self._needs_rename.difference(stale_ids)
311
id_sets = (needs_rename, self._new_executability)
313
id_sets = (self._new_name, self._new_parent, self._new_contents,
314
self._new_id, self._new_executability)
315
for id_set in id_sets:
316
new_ids.update(id_set)
317
return sorted(FinalPaths(self).get_paths(new_ids))
319
def _inventory_altered(self):
320
"""Get the trans_ids and paths of files needing new inv entries."""
322
for id_set in [self._new_name, self._new_parent, self._new_id,
323
self._new_executability]:
324
new_ids.update(id_set)
325
changed_kind = set(self._removed_contents)
326
changed_kind.intersection_update(self._new_contents)
327
changed_kind.difference_update(new_ids)
328
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
330
new_ids.update(changed_kind)
331
return sorted(FinalPaths(self).get_paths(new_ids))
333
def final_kind(self, trans_id):
334
"""Determine the final file kind, after any changes applied.
336
Raises NoSuchFile if the file does not exist/has no contents.
337
(It is conceivable that a path would be created without the
338
corresponding contents insertion command)
340
if trans_id in self._new_contents:
341
return self._new_contents[trans_id]
342
elif trans_id in self._removed_contents:
343
raise NoSuchFile(None)
345
return self.tree_kind(trans_id)
347
def tree_file_id(self, trans_id):
348
"""Determine the file id associated with the trans_id in the tree"""
350
path = self._tree_id_paths[trans_id]
352
# the file is a new, unversioned file, or invalid trans_id
354
# the file is old; the old id is still valid
355
if self._new_root == trans_id:
356
return self._tree.get_root_id()
357
return self._tree.path2id(path)
359
def final_file_id(self, trans_id):
360
"""Determine the file id after any changes are applied, or None.
362
None indicates that the file will not be versioned after changes are
366
return self._new_id[trans_id]
368
if trans_id in self._removed_id:
370
return self.tree_file_id(trans_id)
372
def inactive_file_id(self, trans_id):
373
"""Return the inactive file_id associated with a transaction id.
374
That is, the one in the tree or in non_present_ids.
375
The file_id may actually be active, too.
377
file_id = self.tree_file_id(trans_id)
378
if file_id is not None:
380
for key, value in self._non_present_ids.iteritems():
381
if value == trans_id:
384
def final_parent(self, trans_id):
385
"""Determine the parent file_id, after any changes are applied.
387
ROOT_PARENT is returned for the tree root.
390
return self._new_parent[trans_id]
392
return self.get_tree_parent(trans_id)
394
def final_name(self, trans_id):
395
"""Determine the final filename, after all changes are applied."""
397
return self._new_name[trans_id]
400
return os.path.basename(self._tree_id_paths[trans_id])
402
raise NoFinalPath(trans_id, self)
405
"""Return a map of parent: children for known parents.
407
Only new paths and parents of tree files with assigned ids are used.
410
items = list(self._new_parent.iteritems())
411
items.extend((t, self.final_parent(t)) for t in
412
self._tree_id_paths.keys())
413
for trans_id, parent_id in items:
414
if parent_id not in by_parent:
415
by_parent[parent_id] = set()
416
by_parent[parent_id].add(trans_id)
419
def path_changed(self, trans_id):
420
"""Return True if a trans_id's path has changed."""
421
return (trans_id in self._new_name) or (trans_id in self._new_parent)
423
def new_contents(self, trans_id):
424
return (trans_id in self._new_contents)
426
def find_conflicts(self):
427
"""Find any violations of inventory or filesystem invariants"""
428
if self._done is True:
429
raise ReusingTransform()
431
# ensure all children of all existent parents are known
432
# all children of non-existent parents are known, by definition.
433
self._add_tree_children()
434
by_parent = self.by_parent()
435
conflicts.extend(self._unversioned_parents(by_parent))
436
conflicts.extend(self._parent_loops())
437
conflicts.extend(self._duplicate_entries(by_parent))
438
conflicts.extend(self._duplicate_ids())
439
conflicts.extend(self._parent_type_conflicts(by_parent))
440
conflicts.extend(self._improper_versioning())
441
conflicts.extend(self._executability_conflicts())
442
conflicts.extend(self._overwrite_conflicts())
445
def _add_tree_children(self):
446
"""Add all the children of all active parents to the known paths.
448
Active parents are those which gain children, and those which are
449
removed. This is a necessary first step in detecting conflicts.
451
parents = self.by_parent().keys()
452
parents.extend([t for t in self._removed_contents if
453
self.tree_kind(t) == 'directory'])
454
for trans_id in self._removed_id:
455
file_id = self.tree_file_id(trans_id)
456
if file_id is not None:
457
if self._tree.inventory[file_id].kind == 'directory':
458
parents.append(trans_id)
459
elif self.tree_kind(trans_id) == 'directory':
460
parents.append(trans_id)
462
for parent_id in parents:
463
# ensure that all children are registered with the transaction
464
list(self.iter_tree_children(parent_id))
466
def has_named_child(self, by_parent, parent_id, name):
468
children = by_parent[parent_id]
471
for child in children:
472
if self.final_name(child) == name:
475
path = self._tree_id_paths[parent_id]
478
childpath = joinpath(path, name)
479
child_id = self._tree_path_ids.get(childpath)
481
return lexists(self._tree.abspath(childpath))
483
if self.final_parent(child_id) != parent_id:
485
if child_id in self._removed_contents:
486
# XXX What about dangling file-ids?
491
def _parent_loops(self):
492
"""No entry should be its own ancestor"""
494
for trans_id in self._new_parent:
497
while parent_id is not ROOT_PARENT:
500
parent_id = self.final_parent(parent_id)
503
if parent_id == trans_id:
504
conflicts.append(('parent loop', trans_id))
505
if parent_id in seen:
509
def _unversioned_parents(self, by_parent):
510
"""If parent directories are versioned, children must be versioned."""
512
for parent_id, children in by_parent.iteritems():
513
if parent_id is ROOT_PARENT:
515
if self.final_file_id(parent_id) is not None:
517
for child_id in children:
518
if self.final_file_id(child_id) is not None:
519
conflicts.append(('unversioned parent', parent_id))
523
def _improper_versioning(self):
524
"""Cannot version a file with no contents, or a bad type.
526
However, existing entries with no contents are okay.
529
for trans_id in self._new_id.iterkeys():
531
kind = self.final_kind(trans_id)
533
conflicts.append(('versioning no contents', trans_id))
535
if not InventoryEntry.versionable_kind(kind):
536
conflicts.append(('versioning bad kind', trans_id, kind))
539
def _executability_conflicts(self):
540
"""Check for bad executability changes.
542
Only versioned files may have their executability set, because
543
1. only versioned entries can have executability under windows
544
2. only files can be executable. (The execute bit on a directory
545
does not indicate searchability)
548
for trans_id in self._new_executability:
549
if self.final_file_id(trans_id) is None:
550
conflicts.append(('unversioned executability', trans_id))
553
non_file = self.final_kind(trans_id) != "file"
557
conflicts.append(('non-file executability', trans_id))
560
def _overwrite_conflicts(self):
561
"""Check for overwrites (not permitted on Win32)"""
563
for trans_id in self._new_contents:
565
self.tree_kind(trans_id)
568
if trans_id not in self._removed_contents:
569
conflicts.append(('overwrite', trans_id,
570
self.final_name(trans_id)))
573
def _duplicate_entries(self, by_parent):
574
"""No directory may have two entries with the same name."""
576
if (self._new_name, self._new_parent) == ({}, {}):
578
for children in by_parent.itervalues():
579
name_ids = [(self.final_name(t), t) for t in children]
580
if not self._case_sensitive_target:
581
name_ids = [(n.lower(), t) for n, t in name_ids]
585
for name, trans_id in name_ids:
587
kind = self.final_kind(trans_id)
590
file_id = self.final_file_id(trans_id)
591
if kind is None and file_id is None:
593
if name == last_name:
594
conflicts.append(('duplicate', last_trans_id, trans_id,
597
last_trans_id = trans_id
600
def _duplicate_ids(self):
601
"""Each inventory id may only be used once"""
603
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
605
all_ids = self._tree.all_file_ids()
606
active_tree_ids = all_ids.difference(removed_tree_ids)
607
for trans_id, file_id in self._new_id.iteritems():
608
if file_id in active_tree_ids:
609
old_trans_id = self.trans_id_tree_file_id(file_id)
610
conflicts.append(('duplicate id', old_trans_id, trans_id))
613
def _parent_type_conflicts(self, by_parent):
614
"""parents must have directory 'contents'."""
616
for parent_id, children in by_parent.iteritems():
617
if parent_id is ROOT_PARENT:
619
if not self._any_contents(children):
621
for child in children:
623
self.final_kind(child)
627
kind = self.final_kind(parent_id)
631
conflicts.append(('missing parent', parent_id))
632
elif kind != "directory":
633
conflicts.append(('non-directory parent', parent_id))
636
def _any_contents(self, trans_ids):
637
"""Return true if any of the trans_ids, will have contents."""
638
for trans_id in trans_ids:
640
kind = self.final_kind(trans_id)
646
def _set_executability(self, path, trans_id):
647
"""Set the executability of versioned files """
648
if supports_executable():
649
new_executability = self._new_executability[trans_id]
650
abspath = self._tree.abspath(path)
651
current_mode = os.stat(abspath).st_mode
652
if new_executability:
655
to_mode = current_mode | (0100 & ~umask)
656
# Enable x-bit for others only if they can read it.
657
if current_mode & 0004:
658
to_mode |= 0001 & ~umask
659
if current_mode & 0040:
660
to_mode |= 0010 & ~umask
662
to_mode = current_mode & ~0111
663
os.chmod(abspath, to_mode)
665
def _new_entry(self, name, parent_id, file_id):
666
"""Helper function to create a new filesystem entry."""
667
trans_id = self.create_path(name, parent_id)
668
if file_id is not None:
669
self.version_file(file_id, trans_id)
672
def new_file(self, name, parent_id, contents, file_id=None,
674
"""Convenience method to create files.
676
name is the name of the file to create.
677
parent_id is the transaction id of the parent directory of the file.
678
contents is an iterator of bytestrings, which will be used to produce
680
:param file_id: The inventory ID of the file, if it is to be versioned.
681
:param executable: Only valid when a file_id has been supplied.
683
trans_id = self._new_entry(name, parent_id, file_id)
684
# TODO: rather than scheduling a set_executable call,
685
# have create_file create the file with the right mode.
686
self.create_file(contents, trans_id)
687
if executable is not None:
688
self.set_executability(executable, trans_id)
691
def new_directory(self, name, parent_id, file_id=None):
692
"""Convenience method to create directories.
694
name is the name of the directory to create.
695
parent_id is the transaction id of the parent directory of the
697
file_id is the inventory ID of the directory, if it is to be versioned.
699
trans_id = self._new_entry(name, parent_id, file_id)
700
self.create_directory(trans_id)
703
def new_symlink(self, name, parent_id, target, file_id=None):
704
"""Convenience method to create symbolic link.
706
name is the name of the symlink to create.
707
parent_id is the transaction id of the parent directory of the symlink.
708
target is a bytestring of the target of the symlink.
709
file_id is the inventory ID of the file, if it is to be versioned.
711
trans_id = self._new_entry(name, parent_id, file_id)
712
self.create_symlink(target, trans_id)
715
def _affected_ids(self):
716
"""Return the set of transform ids affected by the transform"""
717
trans_ids = set(self._removed_id)
718
trans_ids.update(self._new_id.keys())
719
trans_ids.update(self._removed_contents)
720
trans_ids.update(self._new_contents.keys())
721
trans_ids.update(self._new_executability.keys())
722
trans_ids.update(self._new_name.keys())
723
trans_ids.update(self._new_parent.keys())
726
def _get_file_id_maps(self):
727
"""Return mapping of file_ids to trans_ids in the to and from states"""
728
trans_ids = self._affected_ids()
731
# Build up two dicts: trans_ids associated with file ids in the
732
# FROM state, vs the TO state.
733
for trans_id in trans_ids:
734
from_file_id = self.tree_file_id(trans_id)
735
if from_file_id is not None:
736
from_trans_ids[from_file_id] = trans_id
737
to_file_id = self.final_file_id(trans_id)
738
if to_file_id is not None:
739
to_trans_ids[to_file_id] = trans_id
740
return from_trans_ids, to_trans_ids
742
def _from_file_data(self, from_trans_id, from_versioned, file_id):
743
"""Get data about a file in the from (tree) state
745
Return a (name, parent, kind, executable) tuple
747
from_path = self._tree_id_paths.get(from_trans_id)
749
# get data from working tree if versioned
750
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
751
from_name = from_entry.name
752
from_parent = from_entry.parent_id
755
if from_path is None:
756
# File does not exist in FROM state
760
# File exists, but is not versioned. Have to use path-
762
from_name = os.path.basename(from_path)
763
tree_parent = self.get_tree_parent(from_trans_id)
764
from_parent = self.tree_file_id(tree_parent)
765
if from_path is not None:
766
from_kind, from_executable, from_stats = \
767
self._tree._comparison_data(from_entry, from_path)
770
from_executable = False
771
return from_name, from_parent, from_kind, from_executable
773
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
774
"""Get data about a file in the to (target) state
776
Return a (name, parent, kind, executable) tuple
778
to_name = self.final_name(to_trans_id)
780
to_kind = self.final_kind(to_trans_id)
783
to_parent = self.final_file_id(self.final_parent(to_trans_id))
784
if to_trans_id in self._new_executability:
785
to_executable = self._new_executability[to_trans_id]
786
elif to_trans_id == from_trans_id:
787
to_executable = from_executable
789
to_executable = False
790
return to_name, to_parent, to_kind, to_executable
792
def iter_changes(self):
793
"""Produce output in the same format as Tree.iter_changes.
795
Will produce nonsensical results if invoked while inventory/filesystem
796
conflicts (as reported by TreeTransform.find_conflicts()) are present.
798
This reads the Transform, but only reproduces changes involving a
799
file_id. Files that are not versioned in either of the FROM or TO
800
states are not reflected.
802
final_paths = FinalPaths(self)
803
from_trans_ids, to_trans_ids = self._get_file_id_maps()
805
# Now iterate through all active file_ids
806
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
808
from_trans_id = from_trans_ids.get(file_id)
809
# find file ids, and determine versioning state
810
if from_trans_id is None:
811
from_versioned = False
812
from_trans_id = to_trans_ids[file_id]
814
from_versioned = True
815
to_trans_id = to_trans_ids.get(file_id)
816
if to_trans_id is None:
818
to_trans_id = from_trans_id
822
from_name, from_parent, from_kind, from_executable = \
823
self._from_file_data(from_trans_id, from_versioned, file_id)
825
to_name, to_parent, to_kind, to_executable = \
826
self._to_file_data(to_trans_id, from_trans_id, from_executable)
828
if not from_versioned:
831
from_path = self._tree_id_paths.get(from_trans_id)
835
to_path = final_paths.get_path(to_trans_id)
836
if from_kind != to_kind:
838
elif to_kind in ('file', 'symlink') and (
839
to_trans_id != from_trans_id or
840
to_trans_id in self._new_contents):
842
if (not modified and from_versioned == to_versioned and
843
from_parent==to_parent and from_name == to_name and
844
from_executable == to_executable):
846
results.append((file_id, (from_path, to_path), modified,
847
(from_versioned, to_versioned),
848
(from_parent, to_parent),
849
(from_name, to_name),
850
(from_kind, to_kind),
851
(from_executable, to_executable)))
852
return iter(sorted(results, key=lambda x:x[1]))
854
def get_preview_tree(self):
855
"""Return a tree representing the result of the transform.
857
This tree only supports the subset of Tree functionality required
858
by show_diff_trees. It must only be compared to tt._tree.
860
return _PreviewTree(self)
862
def _text_parent(self, trans_id):
863
file_id = self.tree_file_id(trans_id)
865
if file_id is None or self._tree.kind(file_id) != 'file':
867
except errors.NoSuchFile:
871
def _get_parents_texts(self, trans_id):
872
"""Get texts for compression parents of this file."""
873
file_id = self._text_parent(trans_id)
876
return (self._tree.get_file_text(file_id),)
878
def _get_parents_lines(self, trans_id):
879
"""Get lines for compression parents of this file."""
880
file_id = self._text_parent(trans_id)
883
return (self._tree.get_file_lines(file_id),)
885
def serialize(self, serializer):
886
"""Serialize this TreeTransform.
888
:param serializer: A Serialiser like pack.ContainerSerializer.
890
new_name = dict((k, v.encode('utf-8')) for k, v in
891
self._new_name.items())
892
new_executability = dict((k, int(v)) for k, v in
893
self._new_executability.items())
894
tree_path_ids = dict((k.encode('utf-8'), v)
895
for k, v in self._tree_path_ids.items())
897
'_id_number': self._id_number,
898
'_new_name': new_name,
899
'_new_parent': self._new_parent,
900
'_new_executability': new_executability,
901
'_new_id': self._new_id,
902
'_tree_path_ids': tree_path_ids,
903
'_removed_id': list(self._removed_id),
904
'_removed_contents': list(self._removed_contents),
905
'_non_present_ids': self._non_present_ids,
907
yield serializer.bytes_record(bencode.bencode(attribs),
909
for trans_id, kind in self._new_contents.items():
911
lines = osutils.chunks_to_lines(
912
self._read_file_chunks(trans_id))
913
parents = self._get_parents_lines(trans_id)
914
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
915
content = ''.join(mpdiff.to_patch())
916
if kind == 'directory':
918
if kind == 'symlink':
919
content = self._read_symlink_target(trans_id)
920
yield serializer.bytes_record(content, ((trans_id, kind),))
922
def deserialize(self, records):
923
"""Deserialize a stored TreeTransform.
925
:param records: An iterable of (names, content) tuples, as per
926
pack.ContainerPushParser.
928
names, content = records.next()
929
attribs = bencode.bdecode(content)
930
self._id_number = attribs['_id_number']
931
self._new_name = dict((k, v.decode('utf-8'))
932
for k, v in attribs['_new_name'].items())
933
self._new_parent = attribs['_new_parent']
934
self._new_executability = dict((k, bool(v)) for k, v in
935
attribs['_new_executability'].items())
936
self._new_id = attribs['_new_id']
937
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
938
self._tree_path_ids = {}
939
self._tree_id_paths = {}
940
for bytepath, trans_id in attribs['_tree_path_ids'].items():
941
path = bytepath.decode('utf-8')
942
self._tree_path_ids[path] = trans_id
943
self._tree_id_paths[trans_id] = path
944
self._removed_id = set(attribs['_removed_id'])
945
self._removed_contents = set(attribs['_removed_contents'])
946
self._non_present_ids = attribs['_non_present_ids']
947
for ((trans_id, kind),), content in records:
949
mpdiff = multiparent.MultiParent.from_patch(content)
950
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
951
self.create_file(lines, trans_id)
952
if kind == 'directory':
953
self.create_directory(trans_id)
954
if kind == 'symlink':
955
self.create_symlink(content.decode('utf-8'), trans_id)
958
class DiskTreeTransform(TreeTransformBase):
959
"""Tree transform storing its contents on disk."""
961
def __init__(self, tree, limbodir, pb=DummyProgress(),
962
case_sensitive=True):
964
:param tree: The tree that will be transformed, but not necessarily
966
:param limbodir: A directory where new files can be stored until
967
they are installed in their proper places
968
:param pb: A ProgressBar indicating how much progress is being made
969
:param case_sensitive: If True, the target of the transform is
970
case sensitive, not just case preserving.
972
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
973
self._limbodir = limbodir
974
self._deletiondir = None
975
# A mapping of transform ids to their limbo filename
976
self._limbo_files = {}
977
# A mapping of transform ids to a set of the transform ids of children
978
# that their limbo directory has
979
self._limbo_children = {}
980
# Map transform ids to maps of child filename to child transform id
981
self._limbo_children_names = {}
982
# List of transform ids that need to be renamed from limbo into place
983
self._needs_rename = set()
986
"""Release the working tree lock, if held, clean up limbo dir.
988
This is required if apply has not been invoked, but can be invoked
991
if self._tree is None:
994
entries = [(self._limbo_name(t), t, k) for t, k in
995
self._new_contents.iteritems()]
996
entries.sort(reverse=True)
997
for path, trans_id, kind in entries:
998
if kind == "directory":
1003
os.rmdir(self._limbodir)
1005
# We don't especially care *why* the dir is immortal.
1006
raise ImmortalLimbo(self._limbodir)
1008
if self._deletiondir is not None:
1009
os.rmdir(self._deletiondir)
1011
raise errors.ImmortalPendingDeletion(self._deletiondir)
1013
TreeTransformBase.finalize(self)
1015
def _limbo_name(self, trans_id):
1016
"""Generate the limbo name of a file"""
1017
limbo_name = self._limbo_files.get(trans_id)
1018
if limbo_name is not None:
1020
parent = self._new_parent.get(trans_id)
1021
# if the parent directory is already in limbo (e.g. when building a
1022
# tree), choose a limbo name inside the parent, to reduce further
1024
use_direct_path = False
1025
if self._new_contents.get(parent) == 'directory':
1026
filename = self._new_name.get(trans_id)
1027
if filename is not None:
1028
if parent not in self._limbo_children:
1029
self._limbo_children[parent] = set()
1030
self._limbo_children_names[parent] = {}
1031
use_direct_path = True
1032
# the direct path can only be used if no other file has
1033
# already taken this pathname, i.e. if the name is unused, or
1034
# if it is already associated with this trans_id.
1035
elif self._case_sensitive_target:
1036
if (self._limbo_children_names[parent].get(filename)
1037
in (trans_id, None)):
1038
use_direct_path = True
1040
for l_filename, l_trans_id in\
1041
self._limbo_children_names[parent].iteritems():
1042
if l_trans_id == trans_id:
1044
if l_filename.lower() == filename.lower():
1047
use_direct_path = True
1050
limbo_name = pathjoin(self._limbo_files[parent], filename)
1051
self._limbo_children[parent].add(trans_id)
1052
self._limbo_children_names[parent][filename] = trans_id
1054
limbo_name = pathjoin(self._limbodir, trans_id)
1055
self._needs_rename.add(trans_id)
1056
self._limbo_files[trans_id] = limbo_name
1059
def adjust_path(self, name, parent, trans_id):
1060
previous_parent = self._new_parent.get(trans_id)
1061
previous_name = self._new_name.get(trans_id)
1062
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1063
if (trans_id in self._limbo_files and
1064
trans_id not in self._needs_rename):
1065
self._rename_in_limbo([trans_id])
1066
self._limbo_children[previous_parent].remove(trans_id)
1067
del self._limbo_children_names[previous_parent][previous_name]
1069
def _rename_in_limbo(self, trans_ids):
1070
"""Fix limbo names so that the right final path is produced.
1072
This means we outsmarted ourselves-- we tried to avoid renaming
1073
these files later by creating them with their final names in their
1074
final parents. But now the previous name or parent is no longer
1075
suitable, so we have to rename them.
1077
Even for trans_ids that have no new contents, we must remove their
1078
entries from _limbo_files, because they are now stale.
1080
for trans_id in trans_ids:
1081
old_path = self._limbo_files.pop(trans_id)
1082
if trans_id not in self._new_contents:
1084
new_path = self._limbo_name(trans_id)
1085
os.rename(old_path, new_path)
1087
def create_file(self, contents, trans_id, mode_id=None):
1088
"""Schedule creation of a new file.
1092
Contents is an iterator of strings, all of which will be written
1093
to the target destination.
1095
New file takes the permissions of any existing file with that id,
1096
unless mode_id is specified.
1098
name = self._limbo_name(trans_id)
1099
f = open(name, 'wb')
1102
unique_add(self._new_contents, trans_id, 'file')
1104
# Clean up the file, it never got registered so
1105
# TreeTransform.finalize() won't clean it up.
1110
f.writelines(contents)
1113
self._set_mode(trans_id, mode_id, S_ISREG)
1115
def _read_file_chunks(self, trans_id):
1116
cur_file = open(self._limbo_name(trans_id), 'rb')
1118
return cur_file.readlines()
1122
def _read_symlink_target(self, trans_id):
1123
return os.readlink(self._limbo_name(trans_id))
1125
def create_hardlink(self, path, trans_id):
1126
"""Schedule creation of a hard link"""
1127
name = self._limbo_name(trans_id)
1131
if e.errno != errno.EPERM:
1133
raise errors.HardLinkNotSupported(path)
1135
unique_add(self._new_contents, trans_id, 'file')
1137
# Clean up the file, it never got registered so
1138
# TreeTransform.finalize() won't clean it up.
1142
def create_directory(self, trans_id):
1143
"""Schedule creation of a new directory.
1145
See also new_directory.
1147
os.mkdir(self._limbo_name(trans_id))
1148
unique_add(self._new_contents, trans_id, 'directory')
1150
def create_symlink(self, target, trans_id):
1151
"""Schedule creation of a new symbolic link.
1153
target is a bytestring.
1154
See also new_symlink.
1157
os.symlink(target, self._limbo_name(trans_id))
1158
unique_add(self._new_contents, trans_id, 'symlink')
1161
path = FinalPaths(self).get_path(trans_id)
1164
raise UnableCreateSymlink(path=path)
1166
def cancel_creation(self, trans_id):
1167
"""Cancel the creation of new file contents."""
1168
del self._new_contents[trans_id]
1169
children = self._limbo_children.get(trans_id)
1170
# if this is a limbo directory with children, move them before removing
1172
if children is not None:
1173
self._rename_in_limbo(children)
1174
del self._limbo_children[trans_id]
1175
del self._limbo_children_names[trans_id]
1176
delete_any(self._limbo_name(trans_id))
1179
class TreeTransform(DiskTreeTransform):
1180
"""Represent a tree transformation.
1182
This object is designed to support incremental generation of the transform,
1185
However, it gives optimum performance when parent directories are created
1186
before their contents. The transform is then able to put child files
1187
directly in their parent directory, avoiding later renames.
1189
It is easy to produce malformed transforms, but they are generally
1190
harmless. Attempting to apply a malformed transform will cause an
1191
exception to be raised before any modifications are made to the tree.
1193
Many kinds of malformed transforms can be corrected with the
1194
resolve_conflicts function. The remaining ones indicate programming error,
1195
such as trying to create a file with no path.
1197
Two sets of file creation methods are supplied. Convenience methods are:
1202
These are composed of the low-level methods:
1204
* create_file or create_directory or create_symlink
1208
Transform/Transaction ids
1209
-------------------------
1210
trans_ids are temporary ids assigned to all files involved in a transform.
1211
It's possible, even common, that not all files in the Tree have trans_ids.
1213
trans_ids are used because filenames and file_ids are not good enough
1214
identifiers; filenames change, and not all files have file_ids. File-ids
1215
are also associated with trans-ids, so that moving a file moves its
1218
trans_ids are only valid for the TreeTransform that generated them.
1222
Limbo is a temporary directory use to hold new versions of files.
1223
Files are added to limbo by create_file, create_directory, create_symlink,
1224
and their convenience variants (new_*). Files may be removed from limbo
1225
using cancel_creation. Files are renamed from limbo into their final
1226
location as part of TreeTransform.apply
1228
Limbo must be cleaned up, by either calling TreeTransform.apply or
1229
calling TreeTransform.finalize.
1231
Files are placed into limbo inside their parent directories, where
1232
possible. This reduces subsequent renames, and makes operations involving
1233
lots of files faster. This optimization is only possible if the parent
1234
directory is created *before* creating any of its children, so avoid
1235
creating children before parents, where possible.
1239
This temporary directory is used by _FileMover for storing files that are
1240
about to be deleted. In case of rollback, the files will be restored.
1241
FileMover does not delete files until it is sure that a rollback will not
1244
def __init__(self, tree, pb=DummyProgress()):
1245
"""Note: a tree_write lock is taken on the tree.
1247
Use TreeTransform.finalize() to release the lock (can be omitted if
1248
TreeTransform.apply() called).
1250
tree.lock_tree_write()
1253
limbodir = urlutils.local_path_from_url(
1254
tree._transport.abspath('limbo'))
1258
if e.errno == errno.EEXIST:
1259
raise ExistingLimbo(limbodir)
1260
deletiondir = urlutils.local_path_from_url(
1261
tree._transport.abspath('pending-deletion'))
1263
os.mkdir(deletiondir)
1265
if e.errno == errno.EEXIST:
1266
raise errors.ExistingPendingDeletion(deletiondir)
1271
# Cache of realpath results, to speed up canonical_path
1272
self._realpaths = {}
1273
# Cache of relpath results, to speed up canonical_path
1275
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1276
tree.case_sensitive)
1277
self._deletiondir = deletiondir
1279
def canonical_path(self, path):
1280
"""Get the canonical tree-relative path"""
1281
# don't follow final symlinks
1282
abs = self._tree.abspath(path)
1283
if abs in self._relpaths:
1284
return self._relpaths[abs]
1285
dirname, basename = os.path.split(abs)
1286
if dirname not in self._realpaths:
1287
self._realpaths[dirname] = os.path.realpath(dirname)
1288
dirname = self._realpaths[dirname]
1289
abs = pathjoin(dirname, basename)
1290
if dirname in self._relpaths:
1291
relpath = pathjoin(self._relpaths[dirname], basename)
1292
relpath = relpath.rstrip('/\\')
1294
relpath = self._tree.relpath(abs)
1295
self._relpaths[abs] = relpath
1298
def tree_kind(self, trans_id):
1299
"""Determine the file kind in the working tree.
1301
Raises NoSuchFile if the file does not exist
1303
path = self._tree_id_paths.get(trans_id)
1305
raise NoSuchFile(None)
1307
return file_kind(self._tree.abspath(path))
1309
if e.errno != errno.ENOENT:
1312
raise NoSuchFile(path)
1314
def _set_mode(self, trans_id, mode_id, typefunc):
1315
"""Set the mode of new file contents.
1316
The mode_id is the existing file to get the mode from (often the same
1317
as trans_id). The operation is only performed if there's a mode match
1318
according to typefunc.
1323
old_path = self._tree_id_paths[mode_id]
1327
mode = os.stat(self._tree.abspath(old_path)).st_mode
1329
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1330
# Either old_path doesn't exist, or the parent of the
1331
# target is not a directory (but will be one eventually)
1332
# Either way, we know it doesn't exist *right now*
1333
# See also bug #248448
1338
os.chmod(self._limbo_name(trans_id), mode)
1340
def iter_tree_children(self, parent_id):
1341
"""Iterate through the entry's tree children, if any"""
1343
path = self._tree_id_paths[parent_id]
1347
children = os.listdir(self._tree.abspath(path))
1349
if not (osutils._is_error_enotdir(e)
1350
or e.errno in (errno.ENOENT, errno.ESRCH)):
1354
for child in children:
1355
childpath = joinpath(path, child)
1356
if self._tree.is_control_filename(childpath):
1358
yield self.trans_id_tree_path(childpath)
1361
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1362
"""Apply all changes to the inventory and filesystem.
1364
If filesystem or inventory conflicts are present, MalformedTransform
1367
If apply succeeds, finalize is not necessary.
1369
:param no_conflicts: if True, the caller guarantees there are no
1370
conflicts, so no check is made.
1371
:param precomputed_delta: An inventory delta to use instead of
1373
:param _mover: Supply an alternate FileMover, for testing
1375
if not no_conflicts:
1376
conflicts = self.find_conflicts()
1377
if len(conflicts) != 0:
1378
raise MalformedTransform(conflicts=conflicts)
1379
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1381
if precomputed_delta is None:
1382
child_pb.update('Apply phase', 0, 2)
1383
inventory_delta = self._generate_inventory_delta()
1386
inventory_delta = precomputed_delta
1389
mover = _FileMover()
1393
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1394
self._apply_removals(mover)
1395
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1396
modified_paths = self._apply_insertions(mover)
1401
mover.apply_deletions()
1404
self._tree.apply_inventory_delta(inventory_delta)
1407
return _TransformResults(modified_paths, self.rename_count)
1409
def _generate_inventory_delta(self):
1410
"""Generate an inventory delta for the current transform."""
1411
inventory_delta = []
1412
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1413
new_paths = self._inventory_altered()
1414
total_entries = len(new_paths) + len(self._removed_id)
1416
for num, trans_id in enumerate(self._removed_id):
1418
child_pb.update('removing file', num, total_entries)
1419
if trans_id == self._new_root:
1420
file_id = self._tree.get_root_id()
1422
file_id = self.tree_file_id(trans_id)
1423
# File-id isn't really being deleted, just moved
1424
if file_id in self._r_new_id:
1426
path = self._tree_id_paths[trans_id]
1427
inventory_delta.append((path, None, file_id, None))
1428
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1430
entries = self._tree.iter_entries_by_dir(
1431
new_path_file_ids.values())
1432
old_paths = dict((e.file_id, p) for p, e in entries)
1434
for num, (path, trans_id) in enumerate(new_paths):
1436
child_pb.update('adding file',
1437
num + len(self._removed_id), total_entries)
1438
file_id = new_path_file_ids[trans_id]
1443
kind = self.final_kind(trans_id)
1445
kind = self._tree.stored_kind(file_id)
1446
parent_trans_id = self.final_parent(trans_id)
1447
parent_file_id = new_path_file_ids.get(parent_trans_id)
1448
if parent_file_id is None:
1449
parent_file_id = self.final_file_id(parent_trans_id)
1450
if trans_id in self._new_reference_revision:
1451
new_entry = inventory.TreeReference(
1453
self._new_name[trans_id],
1454
self.final_file_id(self._new_parent[trans_id]),
1455
None, self._new_reference_revision[trans_id])
1457
new_entry = inventory.make_entry(kind,
1458
self.final_name(trans_id),
1459
parent_file_id, file_id)
1460
old_path = old_paths.get(new_entry.file_id)
1461
new_executability = self._new_executability.get(trans_id)
1462
if new_executability is not None:
1463
new_entry.executable = new_executability
1464
inventory_delta.append(
1465
(old_path, path, new_entry.file_id, new_entry))
1468
return inventory_delta
1470
def _apply_removals(self, mover):
1471
"""Perform tree operations that remove directory/inventory names.
1473
That is, delete files that are to be deleted, and put any files that
1474
need renaming into limbo. This must be done in strict child-to-parent
1477
If inventory_delta is None, no inventory delta generation is performed.
1479
tree_paths = list(self._tree_path_ids.iteritems())
1480
tree_paths.sort(reverse=True)
1481
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1483
for num, data in enumerate(tree_paths):
1484
path, trans_id = data
1485
child_pb.update('removing file', num, len(tree_paths))
1486
full_path = self._tree.abspath(path)
1487
if trans_id in self._removed_contents:
1488
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1490
elif trans_id in self._new_name or trans_id in \
1493
mover.rename(full_path, self._limbo_name(trans_id))
1495
if e.errno != errno.ENOENT:
1498
self.rename_count += 1
1502
def _apply_insertions(self, mover):
1503
"""Perform tree operations that insert directory/inventory names.
1505
That is, create any files that need to be created, and restore from
1506
limbo any files that needed renaming. This must be done in strict
1507
parent-to-child order.
1509
If inventory_delta is None, no inventory delta is calculated, and
1510
no list of modified paths is returned.
1512
new_paths = self.new_paths(filesystem_only=True)
1514
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1516
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1518
for num, (path, trans_id) in enumerate(new_paths):
1520
child_pb.update('adding file', num, len(new_paths))
1521
full_path = self._tree.abspath(path)
1522
if trans_id in self._needs_rename:
1524
mover.rename(self._limbo_name(trans_id), full_path)
1526
# We may be renaming a dangling inventory id
1527
if e.errno != errno.ENOENT:
1530
self.rename_count += 1
1531
if (trans_id in self._new_contents or
1532
self.path_changed(trans_id)):
1533
if trans_id in self._new_contents:
1534
modified_paths.append(full_path)
1535
if trans_id in self._new_executability:
1536
self._set_executability(path, trans_id)
1539
self._new_contents.clear()
1540
return modified_paths
1543
class TransformPreview(DiskTreeTransform):
1544
"""A TreeTransform for generating preview trees.
1546
Unlike TreeTransform, this version works when the input tree is a
1547
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1548
unversioned files in the input tree.
1551
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1553
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1554
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1556
def canonical_path(self, path):
1559
def tree_kind(self, trans_id):
1560
path = self._tree_id_paths.get(trans_id)
1562
raise NoSuchFile(None)
1563
file_id = self._tree.path2id(path)
1564
return self._tree.kind(file_id)
1566
def _set_mode(self, trans_id, mode_id, typefunc):
1567
"""Set the mode of new file contents.
1568
The mode_id is the existing file to get the mode from (often the same
1569
as trans_id). The operation is only performed if there's a mode match
1570
according to typefunc.
1572
# is it ok to ignore this? probably
1575
def iter_tree_children(self, parent_id):
1576
"""Iterate through the entry's tree children, if any"""
1578
path = self._tree_id_paths[parent_id]
1581
file_id = self.tree_file_id(parent_id)
1584
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1585
children = getattr(entry, 'children', {})
1586
for child in children:
1587
childpath = joinpath(path, child)
1588
yield self.trans_id_tree_path(childpath)
1591
class _PreviewTree(tree.Tree):
1592
"""Partial implementation of Tree to support show_diff_trees"""
1594
def __init__(self, transform):
1595
self._transform = transform
1596
self._final_paths = FinalPaths(transform)
1597
self.__by_parent = None
1598
self._parent_ids = []
1599
self._all_children_cache = {}
1600
self._path2trans_id_cache = {}
1601
self._final_name_cache = {}
1603
def _changes(self, file_id):
1604
for changes in self._transform.iter_changes():
1605
if changes[0] == file_id:
1608
def _content_change(self, file_id):
1609
"""Return True if the content of this file changed"""
1610
changes = self._changes(file_id)
1611
# changes[2] is true if the file content changed. See
1612
# InterTree.iter_changes.
1613
return (changes is not None and changes[2])
1615
def _get_repository(self):
1616
repo = getattr(self._transform._tree, '_repository', None)
1618
repo = self._transform._tree.branch.repository
1621
def _iter_parent_trees(self):
1622
for revision_id in self.get_parent_ids():
1624
yield self.revision_tree(revision_id)
1625
except errors.NoSuchRevisionInTree:
1626
yield self._get_repository().revision_tree(revision_id)
1628
def _get_file_revision(self, file_id, vf, tree_revision):
1629
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1630
self._iter_parent_trees()]
1631
vf.add_lines((file_id, tree_revision), parent_keys,
1632
self.get_file(file_id).readlines())
1633
repo = self._get_repository()
1634
base_vf = repo.texts
1635
if base_vf not in vf.fallback_versionedfiles:
1636
vf.fallback_versionedfiles.append(base_vf)
1637
return tree_revision
1639
def _stat_limbo_file(self, file_id):
1640
trans_id = self._transform.trans_id_file_id(file_id)
1641
name = self._transform._limbo_name(trans_id)
1642
return os.lstat(name)
1645
def _by_parent(self):
1646
if self.__by_parent is None:
1647
self.__by_parent = self._transform.by_parent()
1648
return self.__by_parent
1650
def _comparison_data(self, entry, path):
1651
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1652
if kind == 'missing':
1656
file_id = self._transform.final_file_id(self._path2trans_id(path))
1657
executable = self.is_executable(file_id, path)
1658
return kind, executable, None
1660
def lock_read(self):
1661
# Perhaps in theory, this should lock the TreeTransform?
1668
def inventory(self):
1669
"""This Tree does not use inventory as its backing data."""
1670
raise NotImplementedError(_PreviewTree.inventory)
1672
def get_root_id(self):
1673
return self._transform.final_file_id(self._transform.root)
1675
def all_file_ids(self):
1676
tree_ids = set(self._transform._tree.all_file_ids())
1677
tree_ids.difference_update(self._transform.tree_file_id(t)
1678
for t in self._transform._removed_id)
1679
tree_ids.update(self._transform._new_id.values())
1683
return iter(self.all_file_ids())
1685
def has_id(self, file_id):
1686
if file_id in self._transform._r_new_id:
1688
elif file_id in set([self._transform.tree_file_id(trans_id) for
1689
trans_id in self._transform._removed_id]):
1692
return self._transform._tree.has_id(file_id)
1694
def _path2trans_id(self, path):
1695
# We must not use None here, because that is a valid value to store.
1696
trans_id = self._path2trans_id_cache.get(path, object)
1697
if trans_id is not object:
1699
segments = splitpath(path)
1700
cur_parent = self._transform.root
1701
for cur_segment in segments:
1702
for child in self._all_children(cur_parent):
1703
final_name = self._final_name_cache.get(child)
1704
if final_name is None:
1705
final_name = self._transform.final_name(child)
1706
self._final_name_cache[child] = final_name
1707
if final_name == cur_segment:
1711
self._path2trans_id_cache[path] = None
1713
self._path2trans_id_cache[path] = cur_parent
1716
def path2id(self, path):
1717
return self._transform.final_file_id(self._path2trans_id(path))
1719
def id2path(self, file_id):
1720
trans_id = self._transform.trans_id_file_id(file_id)
1722
return self._final_paths._determine_path(trans_id)
1724
raise errors.NoSuchId(self, file_id)
1726
def _all_children(self, trans_id):
1727
children = self._all_children_cache.get(trans_id)
1728
if children is not None:
1730
children = set(self._transform.iter_tree_children(trans_id))
1731
# children in the _new_parent set are provided by _by_parent.
1732
children.difference_update(self._transform._new_parent.keys())
1733
children.update(self._by_parent.get(trans_id, []))
1734
self._all_children_cache[trans_id] = children
1737
def iter_children(self, file_id):
1738
trans_id = self._transform.trans_id_file_id(file_id)
1739
for child_trans_id in self._all_children(trans_id):
1740
yield self._transform.final_file_id(child_trans_id)
1743
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1744
in self._transform._tree.extras())
1745
possible_extras.update(self._transform._new_contents)
1746
possible_extras.update(self._transform._removed_id)
1747
for trans_id in possible_extras:
1748
if self._transform.final_file_id(trans_id) is None:
1749
yield self._final_paths._determine_path(trans_id)
1751
def _make_inv_entries(self, ordered_entries, specific_file_ids):
1752
for trans_id, parent_file_id in ordered_entries:
1753
file_id = self._transform.final_file_id(trans_id)
1756
if (specific_file_ids is not None
1757
and file_id not in specific_file_ids):
1760
kind = self._transform.final_kind(trans_id)
1762
kind = self._transform._tree.stored_kind(file_id)
1763
new_entry = inventory.make_entry(
1765
self._transform.final_name(trans_id),
1766
parent_file_id, file_id)
1767
yield new_entry, trans_id
1769
def _list_files_by_dir(self):
1770
todo = [ROOT_PARENT]
1772
while len(todo) > 0:
1774
parent_file_id = self._transform.final_file_id(parent)
1775
children = list(self._all_children(parent))
1776
paths = dict(zip(children, self._final_paths.get_paths(children)))
1777
children.sort(key=paths.get)
1778
todo.extend(reversed(children))
1779
for trans_id in children:
1780
ordered_ids.append((trans_id, parent_file_id))
1783
def iter_entries_by_dir(self, specific_file_ids=None):
1784
# This may not be a maximally efficient implementation, but it is
1785
# reasonably straightforward. An implementation that grafts the
1786
# TreeTransform changes onto the tree's iter_entries_by_dir results
1787
# might be more efficient, but requires tricky inferences about stack
1789
ordered_ids = self._list_files_by_dir()
1790
for entry, trans_id in self._make_inv_entries(ordered_ids,
1792
yield unicode(self._final_paths.get_path(trans_id)), entry
1794
def list_files(self, include_root=False):
1795
"""See Tree.list_files."""
1796
# XXX This should behave like WorkingTree.list_files, but is really
1797
# more like RevisionTree.list_files.
1798
for path, entry in self.iter_entries_by_dir():
1799
if entry.name == '' and not include_root:
1801
yield path, 'V', entry.kind, entry.file_id, entry
1803
def kind(self, file_id):
1804
trans_id = self._transform.trans_id_file_id(file_id)
1805
return self._transform.final_kind(trans_id)
1807
def stored_kind(self, file_id):
1808
trans_id = self._transform.trans_id_file_id(file_id)
1810
return self._transform._new_contents[trans_id]
1812
return self._transform._tree.stored_kind(file_id)
1814
def get_file_mtime(self, file_id, path=None):
1815
"""See Tree.get_file_mtime"""
1816
if not self._content_change(file_id):
1817
return self._transform._tree.get_file_mtime(file_id, path)
1818
return self._stat_limbo_file(file_id).st_mtime
1820
def _file_size(self, entry, stat_value):
1821
return self.get_file_size(entry.file_id)
1823
def get_file_size(self, file_id):
1824
"""See Tree.get_file_size"""
1825
if self.kind(file_id) == 'file':
1826
return self._transform._tree.get_file_size(file_id)
1830
def get_file_sha1(self, file_id, path=None, stat_value=None):
1831
trans_id = self._transform.trans_id_file_id(file_id)
1832
kind = self._transform._new_contents.get(trans_id)
1834
return self._transform._tree.get_file_sha1(file_id)
1836
fileobj = self.get_file(file_id)
1838
return sha_file(fileobj)
1842
def is_executable(self, file_id, path=None):
1845
trans_id = self._transform.trans_id_file_id(file_id)
1847
return self._transform._new_executability[trans_id]
1850
return self._transform._tree.is_executable(file_id, path)
1852
if e.errno == errno.ENOENT:
1855
except errors.NoSuchId:
1858
def path_content_summary(self, path):
1859
trans_id = self._path2trans_id(path)
1860
tt = self._transform
1861
tree_path = tt._tree_id_paths.get(trans_id)
1862
kind = tt._new_contents.get(trans_id)
1864
if tree_path is None or trans_id in tt._removed_contents:
1865
return 'missing', None, None, None
1866
summary = tt._tree.path_content_summary(tree_path)
1867
kind, size, executable, link_or_sha1 = summary
1870
limbo_name = tt._limbo_name(trans_id)
1871
if trans_id in tt._new_reference_revision:
1872
kind = 'tree-reference'
1874
statval = os.lstat(limbo_name)
1875
size = statval.st_size
1876
if not supports_executable():
1879
executable = statval.st_mode & S_IEXEC
1883
if kind == 'symlink':
1884
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1885
if supports_executable():
1886
executable = tt._new_executability.get(trans_id, executable)
1887
return kind, size, executable, link_or_sha1
1889
def iter_changes(self, from_tree, include_unchanged=False,
1890
specific_files=None, pb=None, extra_trees=None,
1891
require_versioned=True, want_unversioned=False):
1892
"""See InterTree.iter_changes.
1894
This has a fast path that is only used when the from_tree matches
1895
the transform tree, and no fancy options are supplied.
1897
if (from_tree is not self._transform._tree or include_unchanged or
1898
specific_files or want_unversioned):
1899
return tree.InterTree(from_tree, self).iter_changes(
1900
include_unchanged=include_unchanged,
1901
specific_files=specific_files,
1903
extra_trees=extra_trees,
1904
require_versioned=require_versioned,
1905
want_unversioned=want_unversioned)
1906
if want_unversioned:
1907
raise ValueError('want_unversioned is not supported')
1908
return self._transform.iter_changes()
1910
def get_file(self, file_id, path=None):
1911
"""See Tree.get_file"""
1912
if not self._content_change(file_id):
1913
return self._transform._tree.get_file(file_id, path)
1914
trans_id = self._transform.trans_id_file_id(file_id)
1915
name = self._transform._limbo_name(trans_id)
1916
return open(name, 'rb')
1918
def get_file_with_stat(self, file_id, path=None):
1919
return self.get_file(file_id, path), None
1921
def annotate_iter(self, file_id,
1922
default_revision=_mod_revision.CURRENT_REVISION):
1923
changes = self._changes(file_id)
1927
changed_content, versioned, kind = (changes[2], changes[3],
1931
get_old = (kind[0] == 'file' and versioned[0])
1933
old_annotation = self._transform._tree.annotate_iter(file_id,
1934
default_revision=default_revision)
1938
return old_annotation
1939
if not changed_content:
1940
return old_annotation
1941
return annotate.reannotate([old_annotation],
1942
self.get_file(file_id).readlines(),
1945
def get_symlink_target(self, file_id):
1946
"""See Tree.get_symlink_target"""
1947
if not self._content_change(file_id):
1948
return self._transform._tree.get_symlink_target(file_id)
1949
trans_id = self._transform.trans_id_file_id(file_id)
1950
name = self._transform._limbo_name(trans_id)
1951
return osutils.readlink(name)
1953
def walkdirs(self, prefix=''):
1954
pending = [self._transform.root]
1955
while len(pending) > 0:
1956
parent_id = pending.pop()
1959
prefix = prefix.rstrip('/')
1960
parent_path = self._final_paths.get_path(parent_id)
1961
parent_file_id = self._transform.final_file_id(parent_id)
1962
for child_id in self._all_children(parent_id):
1963
path_from_root = self._final_paths.get_path(child_id)
1964
basename = self._transform.final_name(child_id)
1965
file_id = self._transform.final_file_id(child_id)
1967
kind = self._transform.final_kind(child_id)
1968
versioned_kind = kind
1971
versioned_kind = self._transform._tree.stored_kind(file_id)
1972
if versioned_kind == 'directory':
1973
subdirs.append(child_id)
1974
children.append((path_from_root, basename, kind, None,
1975
file_id, versioned_kind))
1977
if parent_path.startswith(prefix):
1978
yield (parent_path, parent_file_id), children
1979
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
1982
def get_parent_ids(self):
1983
return self._parent_ids
1985
def set_parent_ids(self, parent_ids):
1986
self._parent_ids = parent_ids
1988
def get_revision_tree(self, revision_id):
1989
return self._transform._tree.get_revision_tree(revision_id)
1992
def joinpath(parent, child):
1993
"""Join tree-relative paths, handling the tree root specially"""
1994
if parent is None or parent == "":
1997
return pathjoin(parent, child)
2000
class FinalPaths(object):
2001
"""Make path calculation cheap by memoizing paths.
2003
The underlying tree must not be manipulated between calls, or else
2004
the results will likely be incorrect.
2006
def __init__(self, transform):
2007
object.__init__(self)
2008
self._known_paths = {}
2009
self.transform = transform
2011
def _determine_path(self, trans_id):
2012
if trans_id == self.transform.root:
2014
name = self.transform.final_name(trans_id)
2015
parent_id = self.transform.final_parent(trans_id)
2016
if parent_id == self.transform.root:
2019
return pathjoin(self.get_path(parent_id), name)
2021
def get_path(self, trans_id):
2022
"""Find the final path associated with a trans_id"""
2023
if trans_id not in self._known_paths:
2024
self._known_paths[trans_id] = self._determine_path(trans_id)
2025
return self._known_paths[trans_id]
2027
def get_paths(self, trans_ids):
2028
return [(self.get_path(t), t) for t in trans_ids]
2032
def topology_sorted_ids(tree):
2033
"""Determine the topological order of the ids in a tree"""
2034
file_ids = list(tree)
2035
file_ids.sort(key=tree.id2path)
2039
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2040
delta_from_tree=False):
2041
"""Create working tree for a branch, using a TreeTransform.
2043
This function should be used on empty trees, having a tree root at most.
2044
(see merge and revert functionality for working with existing trees)
2046
Existing files are handled like so:
2048
- Existing bzrdirs take precedence over creating new items. They are
2049
created as '%s.diverted' % name.
2050
- Otherwise, if the content on disk matches the content we are building,
2051
it is silently replaced.
2052
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2054
:param tree: The tree to convert wt into a copy of
2055
:param wt: The working tree that files will be placed into
2056
:param accelerator_tree: A tree which can be used for retrieving file
2057
contents more quickly than tree itself, i.e. a workingtree. tree
2058
will be used for cases where accelerator_tree's content is different.
2059
:param hardlink: If true, hard-link files to accelerator_tree, where
2060
possible. accelerator_tree must implement abspath, i.e. be a
2062
:param delta_from_tree: If true, build_tree may use the input Tree to
2063
generate the inventory delta.
2065
wt.lock_tree_write()
2069
if accelerator_tree is not None:
2070
accelerator_tree.lock_read()
2072
return _build_tree(tree, wt, accelerator_tree, hardlink,
2075
if accelerator_tree is not None:
2076
accelerator_tree.unlock()
2083
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2084
"""See build_tree."""
2085
for num, _unused in enumerate(wt.all_file_ids()):
2086
if num > 0: # more than just a root
2087
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2088
existing_files = set()
2089
for dir, files in wt.walkdirs():
2090
existing_files.update(f[0] for f in files)
2092
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2093
pp = ProgressPhase("Build phase", 2, top_pb)
2094
if tree.inventory.root is not None:
2095
# This is kind of a hack: we should be altering the root
2096
# as part of the regular tree shape diff logic.
2097
# The conditional test here is to avoid doing an
2098
# expensive operation (flush) every time the root id
2099
# is set within the tree, nor setting the root and thus
2100
# marking the tree as dirty, because we use two different
2101
# idioms here: tree interfaces and inventory interfaces.
2102
if wt.get_root_id() != tree.get_root_id():
2103
wt.set_root_id(tree.get_root_id())
2105
tt = TreeTransform(wt)
2109
file_trans_id[wt.get_root_id()] = \
2110
tt.trans_id_tree_file_id(wt.get_root_id())
2111
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2113
deferred_contents = []
2115
total = len(tree.inventory)
2117
precomputed_delta = []
2119
precomputed_delta = None
2120
for num, (tree_path, entry) in \
2121
enumerate(tree.inventory.iter_entries_by_dir()):
2122
pb.update("Building tree", num - len(deferred_contents), total)
2123
if entry.parent_id is None:
2126
file_id = entry.file_id
2128
precomputed_delta.append((None, tree_path, file_id, entry))
2129
if tree_path in existing_files:
2130
target_path = wt.abspath(tree_path)
2131
kind = file_kind(target_path)
2132
if kind == "directory":
2134
bzrdir.BzrDir.open(target_path)
2135
except errors.NotBranchError:
2139
if (file_id not in divert and
2140
_content_match(tree, entry, file_id, kind,
2142
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2143
if kind == 'directory':
2145
parent_id = file_trans_id[entry.parent_id]
2146
if entry.kind == 'file':
2147
# We *almost* replicate new_by_entry, so that we can defer
2148
# getting the file text, and get them all at once.
2149
trans_id = tt.create_path(entry.name, parent_id)
2150
file_trans_id[file_id] = trans_id
2151
tt.version_file(file_id, trans_id)
2152
executable = tree.is_executable(file_id, tree_path)
2154
tt.set_executability(executable, trans_id)
2155
trans_data = (trans_id, tree_path)
2156
deferred_contents.append((file_id, trans_data))
2158
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2161
new_trans_id = file_trans_id[file_id]
2162
old_parent = tt.trans_id_tree_path(tree_path)
2163
_reparent_children(tt, old_parent, new_trans_id)
2164
offset = num + 1 - len(deferred_contents)
2165
_create_files(tt, tree, deferred_contents, pb, offset,
2166
accelerator_tree, hardlink)
2170
divert_trans = set(file_trans_id[f] for f in divert)
2171
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2172
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2173
if len(raw_conflicts) > 0:
2174
precomputed_delta = None
2175
conflicts = cook_conflicts(raw_conflicts, tt)
2176
for conflict in conflicts:
2179
wt.add_conflicts(conflicts)
2180
except errors.UnsupportedOperation:
2182
result = tt.apply(no_conflicts=True,
2183
precomputed_delta=precomputed_delta)
2190
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2192
total = len(desired_files) + offset
2194
if accelerator_tree is None:
2195
new_desired_files = desired_files
2197
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2198
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2199
in iter if not (c or e[0] != e[1]))
2200
new_desired_files = []
2202
for file_id, (trans_id, tree_path) in desired_files:
2203
accelerator_path = unchanged.get(file_id)
2204
if accelerator_path is None:
2205
new_desired_files.append((file_id, (trans_id, tree_path)))
2207
pb.update('Adding file contents', count + offset, total)
2209
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2212
contents = accelerator_tree.get_file(file_id, accelerator_path)
2213
if wt.supports_content_filtering():
2214
filters = wt._content_filter_stack(tree_path)
2215
contents = filtered_output_bytes(contents, filters,
2216
ContentFilterContext(tree_path, tree))
2218
tt.create_file(contents, trans_id)
2222
except AttributeError:
2223
# after filtering, contents may no longer be file-like
2227
for count, ((trans_id, tree_path), contents) in enumerate(
2228
tree.iter_files_bytes(new_desired_files)):
2229
if wt.supports_content_filtering():
2230
filters = wt._content_filter_stack(tree_path)
2231
contents = filtered_output_bytes(contents, filters,
2232
ContentFilterContext(tree_path, tree))
2233
tt.create_file(contents, trans_id)
2234
pb.update('Adding file contents', count + offset, total)
2237
def _reparent_children(tt, old_parent, new_parent):
2238
for child in tt.iter_tree_children(old_parent):
2239
tt.adjust_path(tt.final_name(child), new_parent, child)
2241
def _reparent_transform_children(tt, old_parent, new_parent):
2242
by_parent = tt.by_parent()
2243
for child in by_parent[old_parent]:
2244
tt.adjust_path(tt.final_name(child), new_parent, child)
2245
return by_parent[old_parent]
2247
def _content_match(tree, entry, file_id, kind, target_path):
2248
if entry.kind != kind:
2250
if entry.kind == "directory":
2252
if entry.kind == "file":
2253
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2255
elif entry.kind == "symlink":
2256
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2261
def resolve_checkout(tt, conflicts, divert):
2262
new_conflicts = set()
2263
for c_type, conflict in ((c[0], c) for c in conflicts):
2264
# Anything but a 'duplicate' would indicate programmer error
2265
if c_type != 'duplicate':
2266
raise AssertionError(c_type)
2267
# Now figure out which is new and which is old
2268
if tt.new_contents(conflict[1]):
2269
new_file = conflict[1]
2270
old_file = conflict[2]
2272
new_file = conflict[2]
2273
old_file = conflict[1]
2275
# We should only get here if the conflict wasn't completely
2277
final_parent = tt.final_parent(old_file)
2278
if new_file in divert:
2279
new_name = tt.final_name(old_file)+'.diverted'
2280
tt.adjust_path(new_name, final_parent, new_file)
2281
new_conflicts.add((c_type, 'Diverted to',
2282
new_file, old_file))
2284
new_name = tt.final_name(old_file)+'.moved'
2285
tt.adjust_path(new_name, final_parent, old_file)
2286
new_conflicts.add((c_type, 'Moved existing file to',
2287
old_file, new_file))
2288
return new_conflicts
2291
def new_by_entry(tt, entry, parent_id, tree):
2292
"""Create a new file according to its inventory entry"""
2296
contents = tree.get_file(entry.file_id).readlines()
2297
executable = tree.is_executable(entry.file_id)
2298
return tt.new_file(name, parent_id, contents, entry.file_id,
2300
elif kind in ('directory', 'tree-reference'):
2301
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2302
if kind == 'tree-reference':
2303
tt.set_tree_reference(entry.reference_revision, trans_id)
2305
elif kind == 'symlink':
2306
target = tree.get_symlink_target(entry.file_id)
2307
return tt.new_symlink(name, parent_id, target, entry.file_id)
2309
raise errors.BadFileKindError(name, kind)
2312
@deprecated_function(deprecated_in((1, 9, 0)))
2313
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2314
"""Create new file contents according to an inventory entry.
2316
DEPRECATED. Use create_from_tree instead.
2318
if entry.kind == "file":
2320
lines = tree.get_file(entry.file_id).readlines()
2321
tt.create_file(lines, trans_id, mode_id=mode_id)
2322
elif entry.kind == "symlink":
2323
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2324
elif entry.kind == "directory":
2325
tt.create_directory(trans_id)
2328
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2329
"""Create new file contents according to tree contents."""
2330
kind = tree.kind(file_id)
2331
if kind == 'directory':
2332
tt.create_directory(trans_id)
2333
elif kind == "file":
2335
tree_file = tree.get_file(file_id)
2337
bytes = tree_file.readlines()
2340
tt.create_file(bytes, trans_id)
2341
elif kind == "symlink":
2342
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2344
raise AssertionError('Unknown kind %r' % kind)
2347
def create_entry_executability(tt, entry, trans_id):
2348
"""Set the executability of a trans_id according to an inventory entry"""
2349
if entry.kind == "file":
2350
tt.set_executability(entry.executable, trans_id)
2353
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2354
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2357
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2358
"""Produce a backup-style name that appears to be available"""
2362
yield "%s.~%d~" % (name, counter)
2364
for new_name in name_gen():
2365
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2369
def _entry_changes(file_id, entry, working_tree):
2370
"""Determine in which ways the inventory entry has changed.
2372
Returns booleans: has_contents, content_mod, meta_mod
2373
has_contents means there are currently contents, but they differ
2374
contents_mod means contents need to be modified
2375
meta_mod means the metadata needs to be modified
2377
cur_entry = working_tree.inventory[file_id]
2379
working_kind = working_tree.kind(file_id)
2382
has_contents = False
2385
if has_contents is True:
2386
if entry.kind != working_kind:
2387
contents_mod, meta_mod = True, False
2389
cur_entry._read_tree_state(working_tree.id2path(file_id),
2391
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2392
cur_entry._forget_tree_state()
2393
return has_contents, contents_mod, meta_mod
2396
def revert(working_tree, target_tree, filenames, backups=False,
2397
pb=DummyProgress(), change_reporter=None):
2398
"""Revert a working tree's contents to those of a target tree."""
2399
target_tree.lock_read()
2400
tt = TreeTransform(working_tree, pb)
2402
pp = ProgressPhase("Revert phase", 3, pb)
2403
conflicts, merge_modified = _prepare_revert_transform(
2404
working_tree, target_tree, tt, filenames, backups, pp)
2406
change_reporter = delta._ChangeReporter(
2407
unversioned_filter=working_tree.is_ignored)
2408
delta.report_changes(tt.iter_changes(), change_reporter)
2409
for conflict in conflicts:
2413
working_tree.set_merge_modified(merge_modified)
2415
target_tree.unlock()
2421
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2422
backups, pp, basis_tree=None,
2423
merge_modified=None):
2425
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2427
if merge_modified is None:
2428
merge_modified = working_tree.merge_modified()
2429
merge_modified = _alter_files(working_tree, target_tree, tt,
2430
child_pb, filenames, backups,
2431
merge_modified, basis_tree)
2435
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2437
raw_conflicts = resolve_conflicts(tt, child_pb,
2438
lambda t, c: conflict_pass(t, c, target_tree))
2441
conflicts = cook_conflicts(raw_conflicts, tt)
2442
return conflicts, merge_modified
2445
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2446
backups, merge_modified, basis_tree=None):
2447
if basis_tree is not None:
2448
basis_tree.lock_read()
2449
change_list = target_tree.iter_changes(working_tree,
2450
specific_files=specific_files, pb=pb)
2451
if target_tree.get_root_id() is None:
2457
for id_num, (file_id, path, changed_content, versioned, parent, name,
2458
kind, executable) in enumerate(change_list):
2459
if skip_root and file_id[0] is not None and parent[0] is None:
2461
trans_id = tt.trans_id_file_id(file_id)
2464
keep_content = False
2465
if kind[0] == 'file' and (backups or kind[1] is None):
2466
wt_sha1 = working_tree.get_file_sha1(file_id)
2467
if merge_modified.get(file_id) != wt_sha1:
2468
# acquire the basis tree lazily to prevent the
2469
# expense of accessing it when it's not needed ?
2470
# (Guessing, RBC, 200702)
2471
if basis_tree is None:
2472
basis_tree = working_tree.basis_tree()
2473
basis_tree.lock_read()
2474
if file_id in basis_tree:
2475
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2477
elif kind[1] is None and not versioned[1]:
2479
if kind[0] is not None:
2480
if not keep_content:
2481
tt.delete_contents(trans_id)
2482
elif kind[1] is not None:
2483
parent_trans_id = tt.trans_id_file_id(parent[0])
2484
by_parent = tt.by_parent()
2485
backup_name = _get_backup_name(name[0], by_parent,
2486
parent_trans_id, tt)
2487
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2488
new_trans_id = tt.create_path(name[0], parent_trans_id)
2489
if versioned == (True, True):
2490
tt.unversion_file(trans_id)
2491
tt.version_file(file_id, new_trans_id)
2492
# New contents should have the same unix perms as old
2495
trans_id = new_trans_id
2496
if kind[1] in ('directory', 'tree-reference'):
2497
tt.create_directory(trans_id)
2498
if kind[1] == 'tree-reference':
2499
revision = target_tree.get_reference_revision(file_id,
2501
tt.set_tree_reference(revision, trans_id)
2502
elif kind[1] == 'symlink':
2503
tt.create_symlink(target_tree.get_symlink_target(file_id),
2505
elif kind[1] == 'file':
2506
deferred_files.append((file_id, (trans_id, mode_id)))
2507
if basis_tree is None:
2508
basis_tree = working_tree.basis_tree()
2509
basis_tree.lock_read()
2510
new_sha1 = target_tree.get_file_sha1(file_id)
2511
if (file_id in basis_tree and new_sha1 ==
2512
basis_tree.get_file_sha1(file_id)):
2513
if file_id in merge_modified:
2514
del merge_modified[file_id]
2516
merge_modified[file_id] = new_sha1
2518
# preserve the execute bit when backing up
2519
if keep_content and executable[0] == executable[1]:
2520
tt.set_executability(executable[1], trans_id)
2521
elif kind[1] is not None:
2522
raise AssertionError(kind[1])
2523
if versioned == (False, True):
2524
tt.version_file(file_id, trans_id)
2525
if versioned == (True, False):
2526
tt.unversion_file(trans_id)
2527
if (name[1] is not None and
2528
(name[0] != name[1] or parent[0] != parent[1])):
2529
if name[1] == '' and parent[1] is None:
2530
parent_trans = ROOT_PARENT
2532
parent_trans = tt.trans_id_file_id(parent[1])
2533
tt.adjust_path(name[1], parent_trans, trans_id)
2534
if executable[0] != executable[1] and kind[1] == "file":
2535
tt.set_executability(executable[1], trans_id)
2536
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2538
tt.create_file(bytes, trans_id, mode_id)
2540
if basis_tree is not None:
2542
return merge_modified
2545
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2546
"""Make many conflict-resolution attempts, but die if they fail"""
2547
if pass_func is None:
2548
pass_func = conflict_pass
2549
new_conflicts = set()
2552
pb.update('Resolution pass', n+1, 10)
2553
conflicts = tt.find_conflicts()
2554
if len(conflicts) == 0:
2555
return new_conflicts
2556
new_conflicts.update(pass_func(tt, conflicts))
2557
raise MalformedTransform(conflicts=conflicts)
2562
def conflict_pass(tt, conflicts, path_tree=None):
2563
"""Resolve some classes of conflicts.
2565
:param tt: The transform to resolve conflicts in
2566
:param conflicts: The conflicts to resolve
2567
:param path_tree: A Tree to get supplemental paths from
2569
new_conflicts = set()
2570
for c_type, conflict in ((c[0], c) for c in conflicts):
2571
if c_type == 'duplicate id':
2572
tt.unversion_file(conflict[1])
2573
new_conflicts.add((c_type, 'Unversioned existing file',
2574
conflict[1], conflict[2], ))
2575
elif c_type == 'duplicate':
2576
# files that were renamed take precedence
2577
final_parent = tt.final_parent(conflict[1])
2578
if tt.path_changed(conflict[1]):
2579
existing_file, new_file = conflict[2], conflict[1]
2581
existing_file, new_file = conflict[1], conflict[2]
2582
new_name = tt.final_name(existing_file)+'.moved'
2583
tt.adjust_path(new_name, final_parent, existing_file)
2584
new_conflicts.add((c_type, 'Moved existing file to',
2585
existing_file, new_file))
2586
elif c_type == 'parent loop':
2587
# break the loop by undoing one of the ops that caused the loop
2589
while not tt.path_changed(cur):
2590
cur = tt.final_parent(cur)
2591
new_conflicts.add((c_type, 'Cancelled move', cur,
2592
tt.final_parent(cur),))
2593
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2595
elif c_type == 'missing parent':
2596
trans_id = conflict[1]
2598
tt.cancel_deletion(trans_id)
2599
new_conflicts.add(('deleting parent', 'Not deleting',
2604
tt.final_name(trans_id)
2606
if path_tree is not None:
2607
file_id = tt.final_file_id(trans_id)
2609
file_id = tt.inactive_file_id(trans_id)
2610
entry = path_tree.inventory[file_id]
2611
# special-case the other tree root (move its
2612
# children to current root)
2613
if entry.parent_id is None:
2615
moved = _reparent_transform_children(
2616
tt, trans_id, tt.root)
2618
new_conflicts.add((c_type, 'Moved to root',
2621
parent_trans_id = tt.trans_id_file_id(
2623
tt.adjust_path(entry.name, parent_trans_id,
2626
tt.create_directory(trans_id)
2627
new_conflicts.add((c_type, 'Created directory', trans_id))
2628
elif c_type == 'unversioned parent':
2629
file_id = tt.inactive_file_id(conflict[1])
2630
# special-case the other tree root (move its children instead)
2631
if path_tree and file_id in path_tree:
2632
if path_tree.inventory[file_id].parent_id is None:
2634
tt.version_file(file_id, conflict[1])
2635
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2636
elif c_type == 'non-directory parent':
2637
parent_id = conflict[1]
2638
parent_parent = tt.final_parent(parent_id)
2639
parent_name = tt.final_name(parent_id)
2640
parent_file_id = tt.final_file_id(parent_id)
2641
new_parent_id = tt.new_directory(parent_name + '.new',
2642
parent_parent, parent_file_id)
2643
_reparent_transform_children(tt, parent_id, new_parent_id)
2644
if parent_file_id is not None:
2645
tt.unversion_file(parent_id)
2646
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2647
elif c_type == 'versioning no contents':
2648
tt.cancel_versioning(conflict[1])
2649
return new_conflicts
2652
def cook_conflicts(raw_conflicts, tt):
2653
"""Generate a list of cooked conflicts, sorted by file path"""
2654
from bzrlib.conflicts import Conflict
2655
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2656
return sorted(conflict_iter, key=Conflict.sort_key)
2659
def iter_cook_conflicts(raw_conflicts, tt):
2660
from bzrlib.conflicts import Conflict
2662
for conflict in raw_conflicts:
2663
c_type = conflict[0]
2664
action = conflict[1]
2665
modified_path = fp.get_path(conflict[2])
2666
modified_id = tt.final_file_id(conflict[2])
2667
if len(conflict) == 3:
2668
yield Conflict.factory(c_type, action=action, path=modified_path,
2669
file_id=modified_id)
2672
conflicting_path = fp.get_path(conflict[3])
2673
conflicting_id = tt.final_file_id(conflict[3])
2674
yield Conflict.factory(c_type, action=action, path=modified_path,
2675
file_id=modified_id,
2676
conflict_path=conflicting_path,
2677
conflict_file_id=conflicting_id)
2680
class _FileMover(object):
2681
"""Moves and deletes files for TreeTransform, tracking operations"""
2684
self.past_renames = []
2685
self.pending_deletions = []
2687
def rename(self, from_, to):
2688
"""Rename a file from one path to another. Functions like os.rename"""
2690
os.rename(from_, to)
2692
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2693
raise errors.FileExists(to, str(e))
2695
self.past_renames.append((from_, to))
2697
def pre_delete(self, from_, to):
2698
"""Rename a file out of the way and mark it for deletion.
2700
Unlike os.unlink, this works equally well for files and directories.
2701
:param from_: The current file path
2702
:param to: A temporary path for the file
2704
self.rename(from_, to)
2705
self.pending_deletions.append(to)
2708
"""Reverse all renames that have been performed"""
2709
for from_, to in reversed(self.past_renames):
2710
os.rename(to, from_)
2711
# after rollback, don't reuse _FileMover
2713
pending_deletions = None
2715
def apply_deletions(self):
2716
"""Apply all marked deletions"""
2717
for path in self.pending_deletions:
2719
# after apply_deletions, don't reuse _FileMover
2721
pending_deletions = None
added
removed
bzrlib/transform.py
