1
# Copyright (C) 2006, 2007, 2008, 2009 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 ProgressTask 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 _check_malformed(self):
446
conflicts = self.find_conflicts()
447
if len(conflicts) != 0:
448
raise MalformedTransform(conflicts=conflicts)
450
def _add_tree_children(self):
451
"""Add all the children of all active parents to the known paths.
453
Active parents are those which gain children, and those which are
454
removed. This is a necessary first step in detecting conflicts.
456
parents = self.by_parent().keys()
457
parents.extend([t for t in self._removed_contents if
458
self.tree_kind(t) == 'directory'])
459
for trans_id in self._removed_id:
460
file_id = self.tree_file_id(trans_id)
461
if file_id is not None:
462
if self._tree.inventory[file_id].kind == 'directory':
463
parents.append(trans_id)
464
elif self.tree_kind(trans_id) == 'directory':
465
parents.append(trans_id)
467
for parent_id in parents:
468
# ensure that all children are registered with the transaction
469
list(self.iter_tree_children(parent_id))
471
def has_named_child(self, by_parent, parent_id, name):
473
children = by_parent[parent_id]
476
for child in children:
477
if self.final_name(child) == name:
480
path = self._tree_id_paths[parent_id]
483
childpath = joinpath(path, name)
484
child_id = self._tree_path_ids.get(childpath)
486
return lexists(self._tree.abspath(childpath))
488
if self.final_parent(child_id) != parent_id:
490
if child_id in self._removed_contents:
491
# XXX What about dangling file-ids?
496
def _parent_loops(self):
497
"""No entry should be its own ancestor"""
499
for trans_id in self._new_parent:
502
while parent_id is not ROOT_PARENT:
505
parent_id = self.final_parent(parent_id)
508
if parent_id == trans_id:
509
conflicts.append(('parent loop', trans_id))
510
if parent_id in seen:
514
def _unversioned_parents(self, by_parent):
515
"""If parent directories are versioned, children must be versioned."""
517
for parent_id, children in by_parent.iteritems():
518
if parent_id is ROOT_PARENT:
520
if self.final_file_id(parent_id) is not None:
522
for child_id in children:
523
if self.final_file_id(child_id) is not None:
524
conflicts.append(('unversioned parent', parent_id))
528
def _improper_versioning(self):
529
"""Cannot version a file with no contents, or a bad type.
531
However, existing entries with no contents are okay.
534
for trans_id in self._new_id.iterkeys():
536
kind = self.final_kind(trans_id)
538
conflicts.append(('versioning no contents', trans_id))
540
if not InventoryEntry.versionable_kind(kind):
541
conflicts.append(('versioning bad kind', trans_id, kind))
544
def _executability_conflicts(self):
545
"""Check for bad executability changes.
547
Only versioned files may have their executability set, because
548
1. only versioned entries can have executability under windows
549
2. only files can be executable. (The execute bit on a directory
550
does not indicate searchability)
553
for trans_id in self._new_executability:
554
if self.final_file_id(trans_id) is None:
555
conflicts.append(('unversioned executability', trans_id))
558
non_file = self.final_kind(trans_id) != "file"
562
conflicts.append(('non-file executability', trans_id))
565
def _overwrite_conflicts(self):
566
"""Check for overwrites (not permitted on Win32)"""
568
for trans_id in self._new_contents:
570
self.tree_kind(trans_id)
573
if trans_id not in self._removed_contents:
574
conflicts.append(('overwrite', trans_id,
575
self.final_name(trans_id)))
578
def _duplicate_entries(self, by_parent):
579
"""No directory may have two entries with the same name."""
581
if (self._new_name, self._new_parent) == ({}, {}):
583
for children in by_parent.itervalues():
584
name_ids = [(self.final_name(t), t) for t in children]
585
if not self._case_sensitive_target:
586
name_ids = [(n.lower(), t) for n, t in name_ids]
590
for name, trans_id in name_ids:
592
kind = self.final_kind(trans_id)
595
file_id = self.final_file_id(trans_id)
596
if kind is None and file_id is None:
598
if name == last_name:
599
conflicts.append(('duplicate', last_trans_id, trans_id,
602
last_trans_id = trans_id
605
def _duplicate_ids(self):
606
"""Each inventory id may only be used once"""
608
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
610
all_ids = self._tree.all_file_ids()
611
active_tree_ids = all_ids.difference(removed_tree_ids)
612
for trans_id, file_id in self._new_id.iteritems():
613
if file_id in active_tree_ids:
614
old_trans_id = self.trans_id_tree_file_id(file_id)
615
conflicts.append(('duplicate id', old_trans_id, trans_id))
618
def _parent_type_conflicts(self, by_parent):
619
"""parents must have directory 'contents'."""
621
for parent_id, children in by_parent.iteritems():
622
if parent_id is ROOT_PARENT:
624
if not self._any_contents(children):
626
for child in children:
628
self.final_kind(child)
632
kind = self.final_kind(parent_id)
636
conflicts.append(('missing parent', parent_id))
637
elif kind != "directory":
638
conflicts.append(('non-directory parent', parent_id))
641
def _any_contents(self, trans_ids):
642
"""Return true if any of the trans_ids, will have contents."""
643
for trans_id in trans_ids:
645
kind = self.final_kind(trans_id)
651
def _set_executability(self, path, trans_id):
652
"""Set the executability of versioned files """
653
if supports_executable():
654
new_executability = self._new_executability[trans_id]
655
abspath = self._tree.abspath(path)
656
current_mode = os.stat(abspath).st_mode
657
if new_executability:
660
to_mode = current_mode | (0100 & ~umask)
661
# Enable x-bit for others only if they can read it.
662
if current_mode & 0004:
663
to_mode |= 0001 & ~umask
664
if current_mode & 0040:
665
to_mode |= 0010 & ~umask
667
to_mode = current_mode & ~0111
668
os.chmod(abspath, to_mode)
670
def _new_entry(self, name, parent_id, file_id):
671
"""Helper function to create a new filesystem entry."""
672
trans_id = self.create_path(name, parent_id)
673
if file_id is not None:
674
self.version_file(file_id, trans_id)
677
def new_file(self, name, parent_id, contents, file_id=None,
679
"""Convenience method to create files.
681
name is the name of the file to create.
682
parent_id is the transaction id of the parent directory of the file.
683
contents is an iterator of bytestrings, which will be used to produce
685
:param file_id: The inventory ID of the file, if it is to be versioned.
686
:param executable: Only valid when a file_id has been supplied.
688
trans_id = self._new_entry(name, parent_id, file_id)
689
# TODO: rather than scheduling a set_executable call,
690
# have create_file create the file with the right mode.
691
self.create_file(contents, trans_id)
692
if executable is not None:
693
self.set_executability(executable, trans_id)
696
def new_directory(self, name, parent_id, file_id=None):
697
"""Convenience method to create directories.
699
name is the name of the directory to create.
700
parent_id is the transaction id of the parent directory of the
702
file_id is the inventory ID of the directory, if it is to be versioned.
704
trans_id = self._new_entry(name, parent_id, file_id)
705
self.create_directory(trans_id)
708
def new_symlink(self, name, parent_id, target, file_id=None):
709
"""Convenience method to create symbolic link.
711
name is the name of the symlink to create.
712
parent_id is the transaction id of the parent directory of the symlink.
713
target is a bytestring of the target of the symlink.
714
file_id is the inventory ID of the file, if it is to be versioned.
716
trans_id = self._new_entry(name, parent_id, file_id)
717
self.create_symlink(target, trans_id)
720
def _affected_ids(self):
721
"""Return the set of transform ids affected by the transform"""
722
trans_ids = set(self._removed_id)
723
trans_ids.update(self._new_id.keys())
724
trans_ids.update(self._removed_contents)
725
trans_ids.update(self._new_contents.keys())
726
trans_ids.update(self._new_executability.keys())
727
trans_ids.update(self._new_name.keys())
728
trans_ids.update(self._new_parent.keys())
731
def _get_file_id_maps(self):
732
"""Return mapping of file_ids to trans_ids in the to and from states"""
733
trans_ids = self._affected_ids()
736
# Build up two dicts: trans_ids associated with file ids in the
737
# FROM state, vs the TO state.
738
for trans_id in trans_ids:
739
from_file_id = self.tree_file_id(trans_id)
740
if from_file_id is not None:
741
from_trans_ids[from_file_id] = trans_id
742
to_file_id = self.final_file_id(trans_id)
743
if to_file_id is not None:
744
to_trans_ids[to_file_id] = trans_id
745
return from_trans_ids, to_trans_ids
747
def _from_file_data(self, from_trans_id, from_versioned, file_id):
748
"""Get data about a file in the from (tree) state
750
Return a (name, parent, kind, executable) tuple
752
from_path = self._tree_id_paths.get(from_trans_id)
754
# get data from working tree if versioned
755
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
756
from_name = from_entry.name
757
from_parent = from_entry.parent_id
760
if from_path is None:
761
# File does not exist in FROM state
765
# File exists, but is not versioned. Have to use path-
767
from_name = os.path.basename(from_path)
768
tree_parent = self.get_tree_parent(from_trans_id)
769
from_parent = self.tree_file_id(tree_parent)
770
if from_path is not None:
771
from_kind, from_executable, from_stats = \
772
self._tree._comparison_data(from_entry, from_path)
775
from_executable = False
776
return from_name, from_parent, from_kind, from_executable
778
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
779
"""Get data about a file in the to (target) state
781
Return a (name, parent, kind, executable) tuple
783
to_name = self.final_name(to_trans_id)
785
to_kind = self.final_kind(to_trans_id)
788
to_parent = self.final_file_id(self.final_parent(to_trans_id))
789
if to_trans_id in self._new_executability:
790
to_executable = self._new_executability[to_trans_id]
791
elif to_trans_id == from_trans_id:
792
to_executable = from_executable
794
to_executable = False
795
return to_name, to_parent, to_kind, to_executable
797
def iter_changes(self):
798
"""Produce output in the same format as Tree.iter_changes.
800
Will produce nonsensical results if invoked while inventory/filesystem
801
conflicts (as reported by TreeTransform.find_conflicts()) are present.
803
This reads the Transform, but only reproduces changes involving a
804
file_id. Files that are not versioned in either of the FROM or TO
805
states are not reflected.
807
final_paths = FinalPaths(self)
808
from_trans_ids, to_trans_ids = self._get_file_id_maps()
810
# Now iterate through all active file_ids
811
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
813
from_trans_id = from_trans_ids.get(file_id)
814
# find file ids, and determine versioning state
815
if from_trans_id is None:
816
from_versioned = False
817
from_trans_id = to_trans_ids[file_id]
819
from_versioned = True
820
to_trans_id = to_trans_ids.get(file_id)
821
if to_trans_id is None:
823
to_trans_id = from_trans_id
827
from_name, from_parent, from_kind, from_executable = \
828
self._from_file_data(from_trans_id, from_versioned, file_id)
830
to_name, to_parent, to_kind, to_executable = \
831
self._to_file_data(to_trans_id, from_trans_id, from_executable)
833
if not from_versioned:
836
from_path = self._tree_id_paths.get(from_trans_id)
840
to_path = final_paths.get_path(to_trans_id)
841
if from_kind != to_kind:
843
elif to_kind in ('file', 'symlink') and (
844
to_trans_id != from_trans_id or
845
to_trans_id in self._new_contents):
847
if (not modified and from_versioned == to_versioned and
848
from_parent==to_parent and from_name == to_name and
849
from_executable == to_executable):
851
results.append((file_id, (from_path, to_path), modified,
852
(from_versioned, to_versioned),
853
(from_parent, to_parent),
854
(from_name, to_name),
855
(from_kind, to_kind),
856
(from_executable, to_executable)))
857
return iter(sorted(results, key=lambda x:x[1]))
859
def get_preview_tree(self):
860
"""Return a tree representing the result of the transform.
862
The tree is a snapshot, and altering the TreeTransform will invalidate
865
return _PreviewTree(self)
867
def commit(self, branch, message, merge_parents=None, strict=False):
868
"""Commit the result of this TreeTransform to a branch.
870
:param branch: The branch to commit to.
871
:param message: The message to attach to the commit.
872
:param merge_parents: Additional parents specified by pending merges.
873
:return: The revision_id of the revision committed.
875
self._check_malformed()
877
unversioned = set(self._new_contents).difference(set(self._new_id))
878
for trans_id in unversioned:
879
if self.final_file_id(trans_id) is None:
880
raise errors.StrictCommitFailed()
882
revno, last_rev_id = branch.last_revision_info()
883
if last_rev_id == _mod_revision.NULL_REVISION:
884
if merge_parents is not None:
885
raise ValueError('Cannot supply merge parents for first'
889
parent_ids = [last_rev_id]
890
if merge_parents is not None:
891
parent_ids.extend(merge_parents)
892
if self._tree.get_revision_id() != last_rev_id:
893
raise ValueError('TreeTransform not based on branch basis: %s' %
894
self._tree.get_revision_id())
895
builder = branch.get_commit_builder(parent_ids)
896
preview = self.get_preview_tree()
897
list(builder.record_iter_changes(preview, last_rev_id,
898
self.iter_changes()))
899
builder.finish_inventory()
900
revision_id = builder.commit(message)
901
branch.set_last_revision_info(revno + 1, revision_id)
904
def _text_parent(self, trans_id):
905
file_id = self.tree_file_id(trans_id)
907
if file_id is None or self._tree.kind(file_id) != 'file':
909
except errors.NoSuchFile:
913
def _get_parents_texts(self, trans_id):
914
"""Get texts for compression parents of this file."""
915
file_id = self._text_parent(trans_id)
918
return (self._tree.get_file_text(file_id),)
920
def _get_parents_lines(self, trans_id):
921
"""Get lines for compression parents of this file."""
922
file_id = self._text_parent(trans_id)
925
return (self._tree.get_file_lines(file_id),)
927
def serialize(self, serializer):
928
"""Serialize this TreeTransform.
930
:param serializer: A Serialiser like pack.ContainerSerializer.
932
new_name = dict((k, v.encode('utf-8')) for k, v in
933
self._new_name.items())
934
new_executability = dict((k, int(v)) for k, v in
935
self._new_executability.items())
936
tree_path_ids = dict((k.encode('utf-8'), v)
937
for k, v in self._tree_path_ids.items())
939
'_id_number': self._id_number,
940
'_new_name': new_name,
941
'_new_parent': self._new_parent,
942
'_new_executability': new_executability,
943
'_new_id': self._new_id,
944
'_tree_path_ids': tree_path_ids,
945
'_removed_id': list(self._removed_id),
946
'_removed_contents': list(self._removed_contents),
947
'_non_present_ids': self._non_present_ids,
949
yield serializer.bytes_record(bencode.bencode(attribs),
951
for trans_id, kind in self._new_contents.items():
953
lines = osutils.chunks_to_lines(
954
self._read_file_chunks(trans_id))
955
parents = self._get_parents_lines(trans_id)
956
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
957
content = ''.join(mpdiff.to_patch())
958
if kind == 'directory':
960
if kind == 'symlink':
961
content = self._read_symlink_target(trans_id)
962
yield serializer.bytes_record(content, ((trans_id, kind),))
964
def deserialize(self, records):
965
"""Deserialize a stored TreeTransform.
967
:param records: An iterable of (names, content) tuples, as per
968
pack.ContainerPushParser.
970
names, content = records.next()
971
attribs = bencode.bdecode(content)
972
self._id_number = attribs['_id_number']
973
self._new_name = dict((k, v.decode('utf-8'))
974
for k, v in attribs['_new_name'].items())
975
self._new_parent = attribs['_new_parent']
976
self._new_executability = dict((k, bool(v)) for k, v in
977
attribs['_new_executability'].items())
978
self._new_id = attribs['_new_id']
979
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
980
self._tree_path_ids = {}
981
self._tree_id_paths = {}
982
for bytepath, trans_id in attribs['_tree_path_ids'].items():
983
path = bytepath.decode('utf-8')
984
self._tree_path_ids[path] = trans_id
985
self._tree_id_paths[trans_id] = path
986
self._removed_id = set(attribs['_removed_id'])
987
self._removed_contents = set(attribs['_removed_contents'])
988
self._non_present_ids = attribs['_non_present_ids']
989
for ((trans_id, kind),), content in records:
991
mpdiff = multiparent.MultiParent.from_patch(content)
992
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
993
self.create_file(lines, trans_id)
994
if kind == 'directory':
995
self.create_directory(trans_id)
996
if kind == 'symlink':
997
self.create_symlink(content.decode('utf-8'), trans_id)
1000
class DiskTreeTransform(TreeTransformBase):
1001
"""Tree transform storing its contents on disk."""
1003
def __init__(self, tree, limbodir, pb=DummyProgress(),
1004
case_sensitive=True):
1006
:param tree: The tree that will be transformed, but not necessarily
1008
:param limbodir: A directory where new files can be stored until
1009
they are installed in their proper places
1010
:param pb: A ProgressBar indicating how much progress is being made
1011
:param case_sensitive: If True, the target of the transform is
1012
case sensitive, not just case preserving.
1014
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1015
self._limbodir = limbodir
1016
self._deletiondir = None
1017
# A mapping of transform ids to their limbo filename
1018
self._limbo_files = {}
1019
# A mapping of transform ids to a set of the transform ids of children
1020
# that their limbo directory has
1021
self._limbo_children = {}
1022
# Map transform ids to maps of child filename to child transform id
1023
self._limbo_children_names = {}
1024
# List of transform ids that need to be renamed from limbo into place
1025
self._needs_rename = set()
1028
"""Release the working tree lock, if held, clean up limbo dir.
1030
This is required if apply has not been invoked, but can be invoked
1033
if self._tree is None:
1036
entries = [(self._limbo_name(t), t, k) for t, k in
1037
self._new_contents.iteritems()]
1038
entries.sort(reverse=True)
1039
for path, trans_id, kind in entries:
1042
delete_any(self._limbodir)
1044
# We don't especially care *why* the dir is immortal.
1045
raise ImmortalLimbo(self._limbodir)
1047
if self._deletiondir is not None:
1048
delete_any(self._deletiondir)
1050
raise errors.ImmortalPendingDeletion(self._deletiondir)
1052
TreeTransformBase.finalize(self)
1054
def _limbo_name(self, trans_id):
1055
"""Generate the limbo name of a file"""
1056
limbo_name = self._limbo_files.get(trans_id)
1057
if limbo_name is None:
1058
limbo_name = self._generate_limbo_path(trans_id)
1059
self._limbo_files[trans_id] = limbo_name
1062
def _generate_limbo_path(self, trans_id):
1063
"""Generate a limbo path using the trans_id as the relative path.
1065
This is suitable as a fallback, and when the transform should not be
1066
sensitive to the path encoding of the limbo directory.
1068
self._needs_rename.add(trans_id)
1069
return pathjoin(self._limbodir, trans_id)
1071
def adjust_path(self, name, parent, trans_id):
1072
previous_parent = self._new_parent.get(trans_id)
1073
previous_name = self._new_name.get(trans_id)
1074
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1075
if (trans_id in self._limbo_files and
1076
trans_id not in self._needs_rename):
1077
self._rename_in_limbo([trans_id])
1078
self._limbo_children[previous_parent].remove(trans_id)
1079
del self._limbo_children_names[previous_parent][previous_name]
1081
def _rename_in_limbo(self, trans_ids):
1082
"""Fix limbo names so that the right final path is produced.
1084
This means we outsmarted ourselves-- we tried to avoid renaming
1085
these files later by creating them with their final names in their
1086
final parents. But now the previous name or parent is no longer
1087
suitable, so we have to rename them.
1089
Even for trans_ids that have no new contents, we must remove their
1090
entries from _limbo_files, because they are now stale.
1092
for trans_id in trans_ids:
1093
old_path = self._limbo_files.pop(trans_id)
1094
if trans_id not in self._new_contents:
1096
new_path = self._limbo_name(trans_id)
1097
os.rename(old_path, new_path)
1099
def create_file(self, contents, trans_id, mode_id=None):
1100
"""Schedule creation of a new file.
1104
Contents is an iterator of strings, all of which will be written
1105
to the target destination.
1107
New file takes the permissions of any existing file with that id,
1108
unless mode_id is specified.
1110
name = self._limbo_name(trans_id)
1111
f = open(name, 'wb')
1114
unique_add(self._new_contents, trans_id, 'file')
1116
# Clean up the file, it never got registered so
1117
# TreeTransform.finalize() won't clean it up.
1122
f.writelines(contents)
1125
self._set_mode(trans_id, mode_id, S_ISREG)
1127
def _read_file_chunks(self, trans_id):
1128
cur_file = open(self._limbo_name(trans_id), 'rb')
1130
return cur_file.readlines()
1134
def _read_symlink_target(self, trans_id):
1135
return os.readlink(self._limbo_name(trans_id))
1137
def create_hardlink(self, path, trans_id):
1138
"""Schedule creation of a hard link"""
1139
name = self._limbo_name(trans_id)
1143
if e.errno != errno.EPERM:
1145
raise errors.HardLinkNotSupported(path)
1147
unique_add(self._new_contents, trans_id, 'file')
1149
# Clean up the file, it never got registered so
1150
# TreeTransform.finalize() won't clean it up.
1154
def create_directory(self, trans_id):
1155
"""Schedule creation of a new directory.
1157
See also new_directory.
1159
os.mkdir(self._limbo_name(trans_id))
1160
unique_add(self._new_contents, trans_id, 'directory')
1162
def create_symlink(self, target, trans_id):
1163
"""Schedule creation of a new symbolic link.
1165
target is a bytestring.
1166
See also new_symlink.
1169
os.symlink(target, self._limbo_name(trans_id))
1170
unique_add(self._new_contents, trans_id, 'symlink')
1173
path = FinalPaths(self).get_path(trans_id)
1176
raise UnableCreateSymlink(path=path)
1178
def cancel_creation(self, trans_id):
1179
"""Cancel the creation of new file contents."""
1180
del self._new_contents[trans_id]
1181
children = self._limbo_children.get(trans_id)
1182
# if this is a limbo directory with children, move them before removing
1184
if children is not None:
1185
self._rename_in_limbo(children)
1186
del self._limbo_children[trans_id]
1187
del self._limbo_children_names[trans_id]
1188
delete_any(self._limbo_name(trans_id))
1191
class TreeTransform(DiskTreeTransform):
1192
"""Represent a tree transformation.
1194
This object is designed to support incremental generation of the transform,
1197
However, it gives optimum performance when parent directories are created
1198
before their contents. The transform is then able to put child files
1199
directly in their parent directory, avoiding later renames.
1201
It is easy to produce malformed transforms, but they are generally
1202
harmless. Attempting to apply a malformed transform will cause an
1203
exception to be raised before any modifications are made to the tree.
1205
Many kinds of malformed transforms can be corrected with the
1206
resolve_conflicts function. The remaining ones indicate programming error,
1207
such as trying to create a file with no path.
1209
Two sets of file creation methods are supplied. Convenience methods are:
1214
These are composed of the low-level methods:
1216
* create_file or create_directory or create_symlink
1220
Transform/Transaction ids
1221
-------------------------
1222
trans_ids are temporary ids assigned to all files involved in a transform.
1223
It's possible, even common, that not all files in the Tree have trans_ids.
1225
trans_ids are used because filenames and file_ids are not good enough
1226
identifiers; filenames change, and not all files have file_ids. File-ids
1227
are also associated with trans-ids, so that moving a file moves its
1230
trans_ids are only valid for the TreeTransform that generated them.
1234
Limbo is a temporary directory use to hold new versions of files.
1235
Files are added to limbo by create_file, create_directory, create_symlink,
1236
and their convenience variants (new_*). Files may be removed from limbo
1237
using cancel_creation. Files are renamed from limbo into their final
1238
location as part of TreeTransform.apply
1240
Limbo must be cleaned up, by either calling TreeTransform.apply or
1241
calling TreeTransform.finalize.
1243
Files are placed into limbo inside their parent directories, where
1244
possible. This reduces subsequent renames, and makes operations involving
1245
lots of files faster. This optimization is only possible if the parent
1246
directory is created *before* creating any of its children, so avoid
1247
creating children before parents, where possible.
1251
This temporary directory is used by _FileMover for storing files that are
1252
about to be deleted. In case of rollback, the files will be restored.
1253
FileMover does not delete files until it is sure that a rollback will not
1256
def __init__(self, tree, pb=DummyProgress()):
1257
"""Note: a tree_write lock is taken on the tree.
1259
Use TreeTransform.finalize() to release the lock (can be omitted if
1260
TreeTransform.apply() called).
1262
tree.lock_tree_write()
1265
limbodir = urlutils.local_path_from_url(
1266
tree._transport.abspath('limbo'))
1270
if e.errno == errno.EEXIST:
1271
raise ExistingLimbo(limbodir)
1272
deletiondir = urlutils.local_path_from_url(
1273
tree._transport.abspath('pending-deletion'))
1275
os.mkdir(deletiondir)
1277
if e.errno == errno.EEXIST:
1278
raise errors.ExistingPendingDeletion(deletiondir)
1283
# Cache of realpath results, to speed up canonical_path
1284
self._realpaths = {}
1285
# Cache of relpath results, to speed up canonical_path
1287
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1288
tree.case_sensitive)
1289
self._deletiondir = deletiondir
1291
def canonical_path(self, path):
1292
"""Get the canonical tree-relative path"""
1293
# don't follow final symlinks
1294
abs = self._tree.abspath(path)
1295
if abs in self._relpaths:
1296
return self._relpaths[abs]
1297
dirname, basename = os.path.split(abs)
1298
if dirname not in self._realpaths:
1299
self._realpaths[dirname] = os.path.realpath(dirname)
1300
dirname = self._realpaths[dirname]
1301
abs = pathjoin(dirname, basename)
1302
if dirname in self._relpaths:
1303
relpath = pathjoin(self._relpaths[dirname], basename)
1304
relpath = relpath.rstrip('/\\')
1306
relpath = self._tree.relpath(abs)
1307
self._relpaths[abs] = relpath
1310
def tree_kind(self, trans_id):
1311
"""Determine the file kind in the working tree.
1313
Raises NoSuchFile if the file does not exist
1315
path = self._tree_id_paths.get(trans_id)
1317
raise NoSuchFile(None)
1319
return file_kind(self._tree.abspath(path))
1321
if e.errno != errno.ENOENT:
1324
raise NoSuchFile(path)
1326
def _set_mode(self, trans_id, mode_id, typefunc):
1327
"""Set the mode of new file contents.
1328
The mode_id is the existing file to get the mode from (often the same
1329
as trans_id). The operation is only performed if there's a mode match
1330
according to typefunc.
1335
old_path = self._tree_id_paths[mode_id]
1339
mode = os.stat(self._tree.abspath(old_path)).st_mode
1341
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1342
# Either old_path doesn't exist, or the parent of the
1343
# target is not a directory (but will be one eventually)
1344
# Either way, we know it doesn't exist *right now*
1345
# See also bug #248448
1350
os.chmod(self._limbo_name(trans_id), mode)
1352
def iter_tree_children(self, parent_id):
1353
"""Iterate through the entry's tree children, if any"""
1355
path = self._tree_id_paths[parent_id]
1359
children = os.listdir(self._tree.abspath(path))
1361
if not (osutils._is_error_enotdir(e)
1362
or e.errno in (errno.ENOENT, errno.ESRCH)):
1366
for child in children:
1367
childpath = joinpath(path, child)
1368
if self._tree.is_control_filename(childpath):
1370
yield self.trans_id_tree_path(childpath)
1372
def _generate_limbo_path(self, trans_id):
1373
"""Generate a limbo path using the final path if possible.
1375
This optimizes the performance of applying the tree transform by
1376
avoiding renames. These renames can be avoided only when the parent
1377
directory is already scheduled for creation.
1379
If the final path cannot be used, falls back to using the trans_id as
1382
parent = self._new_parent.get(trans_id)
1383
# if the parent directory is already in limbo (e.g. when building a
1384
# tree), choose a limbo name inside the parent, to reduce further
1386
use_direct_path = False
1387
if self._new_contents.get(parent) == 'directory':
1388
filename = self._new_name.get(trans_id)
1389
if filename is not None:
1390
if parent not in self._limbo_children:
1391
self._limbo_children[parent] = set()
1392
self._limbo_children_names[parent] = {}
1393
use_direct_path = True
1394
# the direct path can only be used if no other file has
1395
# already taken this pathname, i.e. if the name is unused, or
1396
# if it is already associated with this trans_id.
1397
elif self._case_sensitive_target:
1398
if (self._limbo_children_names[parent].get(filename)
1399
in (trans_id, None)):
1400
use_direct_path = True
1402
for l_filename, l_trans_id in\
1403
self._limbo_children_names[parent].iteritems():
1404
if l_trans_id == trans_id:
1406
if l_filename.lower() == filename.lower():
1409
use_direct_path = True
1411
if not use_direct_path:
1412
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1414
limbo_name = pathjoin(self._limbo_files[parent], filename)
1415
self._limbo_children[parent].add(trans_id)
1416
self._limbo_children_names[parent][filename] = trans_id
1420
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1421
"""Apply all changes to the inventory and filesystem.
1423
If filesystem or inventory conflicts are present, MalformedTransform
1426
If apply succeeds, finalize is not necessary.
1428
:param no_conflicts: if True, the caller guarantees there are no
1429
conflicts, so no check is made.
1430
:param precomputed_delta: An inventory delta to use instead of
1432
:param _mover: Supply an alternate FileMover, for testing
1434
if not no_conflicts:
1435
self._check_malformed()
1436
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1438
if precomputed_delta is None:
1439
child_pb.update('Apply phase', 0, 2)
1440
inventory_delta = self._generate_inventory_delta()
1443
inventory_delta = precomputed_delta
1446
mover = _FileMover()
1450
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1451
self._apply_removals(mover)
1452
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1453
modified_paths = self._apply_insertions(mover)
1458
mover.apply_deletions()
1461
self._tree.apply_inventory_delta(inventory_delta)
1464
return _TransformResults(modified_paths, self.rename_count)
1466
def _generate_inventory_delta(self):
1467
"""Generate an inventory delta for the current transform."""
1468
inventory_delta = []
1469
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1470
new_paths = self._inventory_altered()
1471
total_entries = len(new_paths) + len(self._removed_id)
1473
for num, trans_id in enumerate(self._removed_id):
1475
child_pb.update('removing file', num, total_entries)
1476
if trans_id == self._new_root:
1477
file_id = self._tree.get_root_id()
1479
file_id = self.tree_file_id(trans_id)
1480
# File-id isn't really being deleted, just moved
1481
if file_id in self._r_new_id:
1483
path = self._tree_id_paths[trans_id]
1484
inventory_delta.append((path, None, file_id, None))
1485
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1487
entries = self._tree.iter_entries_by_dir(
1488
new_path_file_ids.values())
1489
old_paths = dict((e.file_id, p) for p, e in entries)
1491
for num, (path, trans_id) in enumerate(new_paths):
1493
child_pb.update('adding file',
1494
num + len(self._removed_id), total_entries)
1495
file_id = new_path_file_ids[trans_id]
1500
kind = self.final_kind(trans_id)
1502
kind = self._tree.stored_kind(file_id)
1503
parent_trans_id = self.final_parent(trans_id)
1504
parent_file_id = new_path_file_ids.get(parent_trans_id)
1505
if parent_file_id is None:
1506
parent_file_id = self.final_file_id(parent_trans_id)
1507
if trans_id in self._new_reference_revision:
1508
new_entry = inventory.TreeReference(
1510
self._new_name[trans_id],
1511
self.final_file_id(self._new_parent[trans_id]),
1512
None, self._new_reference_revision[trans_id])
1514
new_entry = inventory.make_entry(kind,
1515
self.final_name(trans_id),
1516
parent_file_id, file_id)
1517
old_path = old_paths.get(new_entry.file_id)
1518
new_executability = self._new_executability.get(trans_id)
1519
if new_executability is not None:
1520
new_entry.executable = new_executability
1521
inventory_delta.append(
1522
(old_path, path, new_entry.file_id, new_entry))
1525
return inventory_delta
1527
def _apply_removals(self, mover):
1528
"""Perform tree operations that remove directory/inventory names.
1530
That is, delete files that are to be deleted, and put any files that
1531
need renaming into limbo. This must be done in strict child-to-parent
1534
If inventory_delta is None, no inventory delta generation is performed.
1536
tree_paths = list(self._tree_path_ids.iteritems())
1537
tree_paths.sort(reverse=True)
1538
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1540
for num, data in enumerate(tree_paths):
1541
path, trans_id = data
1542
child_pb.update('removing file', num, len(tree_paths))
1543
full_path = self._tree.abspath(path)
1544
if trans_id in self._removed_contents:
1545
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1547
elif trans_id in self._new_name or trans_id in \
1550
mover.rename(full_path, self._limbo_name(trans_id))
1552
if e.errno != errno.ENOENT:
1555
self.rename_count += 1
1559
def _apply_insertions(self, mover):
1560
"""Perform tree operations that insert directory/inventory names.
1562
That is, create any files that need to be created, and restore from
1563
limbo any files that needed renaming. This must be done in strict
1564
parent-to-child order.
1566
If inventory_delta is None, no inventory delta is calculated, and
1567
no list of modified paths is returned.
1569
new_paths = self.new_paths(filesystem_only=True)
1571
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1573
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1575
for num, (path, trans_id) in enumerate(new_paths):
1577
child_pb.update('adding file', num, len(new_paths))
1578
full_path = self._tree.abspath(path)
1579
if trans_id in self._needs_rename:
1581
mover.rename(self._limbo_name(trans_id), full_path)
1583
# We may be renaming a dangling inventory id
1584
if e.errno != errno.ENOENT:
1587
self.rename_count += 1
1588
if (trans_id in self._new_contents or
1589
self.path_changed(trans_id)):
1590
if trans_id in self._new_contents:
1591
modified_paths.append(full_path)
1592
if trans_id in self._new_executability:
1593
self._set_executability(path, trans_id)
1596
self._new_contents.clear()
1597
return modified_paths
1600
class TransformPreview(DiskTreeTransform):
1601
"""A TreeTransform for generating preview trees.
1603
Unlike TreeTransform, this version works when the input tree is a
1604
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1605
unversioned files in the input tree.
1608
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1610
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1611
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1613
def canonical_path(self, path):
1616
def tree_kind(self, trans_id):
1617
path = self._tree_id_paths.get(trans_id)
1619
raise NoSuchFile(None)
1620
file_id = self._tree.path2id(path)
1621
return self._tree.kind(file_id)
1623
def _set_mode(self, trans_id, mode_id, typefunc):
1624
"""Set the mode of new file contents.
1625
The mode_id is the existing file to get the mode from (often the same
1626
as trans_id). The operation is only performed if there's a mode match
1627
according to typefunc.
1629
# is it ok to ignore this? probably
1632
def iter_tree_children(self, parent_id):
1633
"""Iterate through the entry's tree children, if any"""
1635
path = self._tree_id_paths[parent_id]
1638
file_id = self.tree_file_id(parent_id)
1641
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1642
children = getattr(entry, 'children', {})
1643
for child in children:
1644
childpath = joinpath(path, child)
1645
yield self.trans_id_tree_path(childpath)
1648
class _PreviewTree(tree.Tree):
1649
"""Partial implementation of Tree to support show_diff_trees"""
1651
def __init__(self, transform):
1652
self._transform = transform
1653
self._final_paths = FinalPaths(transform)
1654
self.__by_parent = None
1655
self._parent_ids = []
1656
self._all_children_cache = {}
1657
self._path2trans_id_cache = {}
1658
self._final_name_cache = {}
1659
self._iter_changes_cache = dict((c[0], c) for c in
1660
self._transform.iter_changes())
1662
def _content_change(self, file_id):
1663
"""Return True if the content of this file changed"""
1664
changes = self._iter_changes_cache.get(file_id)
1665
# changes[2] is true if the file content changed. See
1666
# InterTree.iter_changes.
1667
return (changes is not None and changes[2])
1669
def _get_repository(self):
1670
repo = getattr(self._transform._tree, '_repository', None)
1672
repo = self._transform._tree.branch.repository
1675
def _iter_parent_trees(self):
1676
for revision_id in self.get_parent_ids():
1678
yield self.revision_tree(revision_id)
1679
except errors.NoSuchRevisionInTree:
1680
yield self._get_repository().revision_tree(revision_id)
1682
def _get_file_revision(self, file_id, vf, tree_revision):
1683
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1684
self._iter_parent_trees()]
1685
vf.add_lines((file_id, tree_revision), parent_keys,
1686
self.get_file(file_id).readlines())
1687
repo = self._get_repository()
1688
base_vf = repo.texts
1689
if base_vf not in vf.fallback_versionedfiles:
1690
vf.fallback_versionedfiles.append(base_vf)
1691
return tree_revision
1693
def _stat_limbo_file(self, file_id):
1694
trans_id = self._transform.trans_id_file_id(file_id)
1695
name = self._transform._limbo_name(trans_id)
1696
return os.lstat(name)
1699
def _by_parent(self):
1700
if self.__by_parent is None:
1701
self.__by_parent = self._transform.by_parent()
1702
return self.__by_parent
1704
def _comparison_data(self, entry, path):
1705
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1706
if kind == 'missing':
1710
file_id = self._transform.final_file_id(self._path2trans_id(path))
1711
executable = self.is_executable(file_id, path)
1712
return kind, executable, None
1714
def lock_read(self):
1715
# Perhaps in theory, this should lock the TreeTransform?
1722
def inventory(self):
1723
"""This Tree does not use inventory as its backing data."""
1724
raise NotImplementedError(_PreviewTree.inventory)
1726
def get_root_id(self):
1727
return self._transform.final_file_id(self._transform.root)
1729
def all_file_ids(self):
1730
tree_ids = set(self._transform._tree.all_file_ids())
1731
tree_ids.difference_update(self._transform.tree_file_id(t)
1732
for t in self._transform._removed_id)
1733
tree_ids.update(self._transform._new_id.values())
1737
return iter(self.all_file_ids())
1739
def _has_id(self, file_id, fallback_check):
1740
if file_id in self._transform._r_new_id:
1742
elif file_id in set([self._transform.tree_file_id(trans_id) for
1743
trans_id in self._transform._removed_id]):
1746
return fallback_check(file_id)
1748
def has_id(self, file_id):
1749
return self._has_id(file_id, self._transform._tree.has_id)
1751
def has_or_had_id(self, file_id):
1752
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1754
def _path2trans_id(self, path):
1755
# We must not use None here, because that is a valid value to store.
1756
trans_id = self._path2trans_id_cache.get(path, object)
1757
if trans_id is not object:
1759
segments = splitpath(path)
1760
cur_parent = self._transform.root
1761
for cur_segment in segments:
1762
for child in self._all_children(cur_parent):
1763
final_name = self._final_name_cache.get(child)
1764
if final_name is None:
1765
final_name = self._transform.final_name(child)
1766
self._final_name_cache[child] = final_name
1767
if final_name == cur_segment:
1771
self._path2trans_id_cache[path] = None
1773
self._path2trans_id_cache[path] = cur_parent
1776
def path2id(self, path):
1777
return self._transform.final_file_id(self._path2trans_id(path))
1779
def id2path(self, file_id):
1780
trans_id = self._transform.trans_id_file_id(file_id)
1782
return self._final_paths._determine_path(trans_id)
1784
raise errors.NoSuchId(self, file_id)
1786
def _all_children(self, trans_id):
1787
children = self._all_children_cache.get(trans_id)
1788
if children is not None:
1790
children = set(self._transform.iter_tree_children(trans_id))
1791
# children in the _new_parent set are provided by _by_parent.
1792
children.difference_update(self._transform._new_parent.keys())
1793
children.update(self._by_parent.get(trans_id, []))
1794
self._all_children_cache[trans_id] = children
1797
def iter_children(self, file_id):
1798
trans_id = self._transform.trans_id_file_id(file_id)
1799
for child_trans_id in self._all_children(trans_id):
1800
yield self._transform.final_file_id(child_trans_id)
1803
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1804
in self._transform._tree.extras())
1805
possible_extras.update(self._transform._new_contents)
1806
possible_extras.update(self._transform._removed_id)
1807
for trans_id in possible_extras:
1808
if self._transform.final_file_id(trans_id) is None:
1809
yield self._final_paths._determine_path(trans_id)
1811
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1812
yield_parents=False):
1813
for trans_id, parent_file_id in ordered_entries:
1814
file_id = self._transform.final_file_id(trans_id)
1817
if (specific_file_ids is not None
1818
and file_id not in specific_file_ids):
1821
kind = self._transform.final_kind(trans_id)
1823
kind = self._transform._tree.stored_kind(file_id)
1824
new_entry = inventory.make_entry(
1826
self._transform.final_name(trans_id),
1827
parent_file_id, file_id)
1828
yield new_entry, trans_id
1830
def _list_files_by_dir(self):
1831
todo = [ROOT_PARENT]
1833
while len(todo) > 0:
1835
parent_file_id = self._transform.final_file_id(parent)
1836
children = list(self._all_children(parent))
1837
paths = dict(zip(children, self._final_paths.get_paths(children)))
1838
children.sort(key=paths.get)
1839
todo.extend(reversed(children))
1840
for trans_id in children:
1841
ordered_ids.append((trans_id, parent_file_id))
1844
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1845
# This may not be a maximally efficient implementation, but it is
1846
# reasonably straightforward. An implementation that grafts the
1847
# TreeTransform changes onto the tree's iter_entries_by_dir results
1848
# might be more efficient, but requires tricky inferences about stack
1850
ordered_ids = self._list_files_by_dir()
1851
for entry, trans_id in self._make_inv_entries(ordered_ids,
1852
specific_file_ids, yield_parents=yield_parents):
1853
yield unicode(self._final_paths.get_path(trans_id)), entry
1855
def _iter_entries_for_dir(self, dir_path):
1856
"""Return path, entry for items in a directory without recursing down."""
1857
dir_file_id = self.path2id(dir_path)
1859
for file_id in self.iter_children(dir_file_id):
1860
trans_id = self._transform.trans_id_file_id(file_id)
1861
ordered_ids.append((trans_id, file_id))
1862
for entry, trans_id in self._make_inv_entries(ordered_ids):
1863
yield unicode(self._final_paths.get_path(trans_id)), entry
1865
def list_files(self, include_root=False, from_dir=None, recursive=True):
1866
"""See WorkingTree.list_files."""
1867
# XXX This should behave like WorkingTree.list_files, but is really
1868
# more like RevisionTree.list_files.
1872
prefix = from_dir + '/'
1873
entries = self.iter_entries_by_dir()
1874
for path, entry in entries:
1875
if entry.name == '' and not include_root:
1878
if not path.startswith(prefix):
1880
path = path[len(prefix):]
1881
yield path, 'V', entry.kind, entry.file_id, entry
1883
if from_dir is None and include_root is True:
1884
root_entry = inventory.make_entry('directory', '',
1885
ROOT_PARENT, self.get_root_id())
1886
yield '', 'V', 'directory', root_entry.file_id, root_entry
1887
entries = self._iter_entries_for_dir(from_dir or '')
1888
for path, entry in entries:
1889
yield path, 'V', entry.kind, entry.file_id, entry
1891
def kind(self, file_id):
1892
trans_id = self._transform.trans_id_file_id(file_id)
1893
return self._transform.final_kind(trans_id)
1895
def stored_kind(self, file_id):
1896
trans_id = self._transform.trans_id_file_id(file_id)
1898
return self._transform._new_contents[trans_id]
1900
return self._transform._tree.stored_kind(file_id)
1902
def get_file_mtime(self, file_id, path=None):
1903
"""See Tree.get_file_mtime"""
1904
if not self._content_change(file_id):
1905
return self._transform._tree.get_file_mtime(file_id, path)
1906
return self._stat_limbo_file(file_id).st_mtime
1908
def _file_size(self, entry, stat_value):
1909
return self.get_file_size(entry.file_id)
1911
def get_file_size(self, file_id):
1912
"""See Tree.get_file_size"""
1913
if self.kind(file_id) == 'file':
1914
return self._transform._tree.get_file_size(file_id)
1918
def get_file_sha1(self, file_id, path=None, stat_value=None):
1919
trans_id = self._transform.trans_id_file_id(file_id)
1920
kind = self._transform._new_contents.get(trans_id)
1922
return self._transform._tree.get_file_sha1(file_id)
1924
fileobj = self.get_file(file_id)
1926
return sha_file(fileobj)
1930
def is_executable(self, file_id, path=None):
1933
trans_id = self._transform.trans_id_file_id(file_id)
1935
return self._transform._new_executability[trans_id]
1938
return self._transform._tree.is_executable(file_id, path)
1940
if e.errno == errno.ENOENT:
1943
except errors.NoSuchId:
1946
def path_content_summary(self, path):
1947
trans_id = self._path2trans_id(path)
1948
tt = self._transform
1949
tree_path = tt._tree_id_paths.get(trans_id)
1950
kind = tt._new_contents.get(trans_id)
1952
if tree_path is None or trans_id in tt._removed_contents:
1953
return 'missing', None, None, None
1954
summary = tt._tree.path_content_summary(tree_path)
1955
kind, size, executable, link_or_sha1 = summary
1958
limbo_name = tt._limbo_name(trans_id)
1959
if trans_id in tt._new_reference_revision:
1960
kind = 'tree-reference'
1962
statval = os.lstat(limbo_name)
1963
size = statval.st_size
1964
if not supports_executable():
1967
executable = statval.st_mode & S_IEXEC
1971
if kind == 'symlink':
1972
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1973
if supports_executable():
1974
executable = tt._new_executability.get(trans_id, executable)
1975
return kind, size, executable, link_or_sha1
1977
def iter_changes(self, from_tree, include_unchanged=False,
1978
specific_files=None, pb=None, extra_trees=None,
1979
require_versioned=True, want_unversioned=False):
1980
"""See InterTree.iter_changes.
1982
This has a fast path that is only used when the from_tree matches
1983
the transform tree, and no fancy options are supplied.
1985
if (from_tree is not self._transform._tree or include_unchanged or
1986
specific_files or want_unversioned):
1987
return tree.InterTree(from_tree, self).iter_changes(
1988
include_unchanged=include_unchanged,
1989
specific_files=specific_files,
1991
extra_trees=extra_trees,
1992
require_versioned=require_versioned,
1993
want_unversioned=want_unversioned)
1994
if want_unversioned:
1995
raise ValueError('want_unversioned is not supported')
1996
return self._transform.iter_changes()
1998
def get_file(self, file_id, path=None):
1999
"""See Tree.get_file"""
2000
if not self._content_change(file_id):
2001
return self._transform._tree.get_file(file_id, path)
2002
trans_id = self._transform.trans_id_file_id(file_id)
2003
name = self._transform._limbo_name(trans_id)
2004
return open(name, 'rb')
2006
def get_file_with_stat(self, file_id, path=None):
2007
return self.get_file(file_id, path), None
2009
def annotate_iter(self, file_id,
2010
default_revision=_mod_revision.CURRENT_REVISION):
2011
changes = self._iter_changes_cache.get(file_id)
2015
changed_content, versioned, kind = (changes[2], changes[3],
2019
get_old = (kind[0] == 'file' and versioned[0])
2021
old_annotation = self._transform._tree.annotate_iter(file_id,
2022
default_revision=default_revision)
2026
return old_annotation
2027
if not changed_content:
2028
return old_annotation
2029
# TODO: This is doing something similar to what WT.annotate_iter is
2030
# doing, however it fails slightly because it doesn't know what
2031
# the *other* revision_id is, so it doesn't know how to give the
2032
# other as the origin for some lines, they all get
2033
# 'default_revision'
2034
# It would be nice to be able to use the new Annotator based
2035
# approach, as well.
2036
return annotate.reannotate([old_annotation],
2037
self.get_file(file_id).readlines(),
2040
def get_symlink_target(self, file_id):
2041
"""See Tree.get_symlink_target"""
2042
if not self._content_change(file_id):
2043
return self._transform._tree.get_symlink_target(file_id)
2044
trans_id = self._transform.trans_id_file_id(file_id)
2045
name = self._transform._limbo_name(trans_id)
2046
return osutils.readlink(name)
2048
def walkdirs(self, prefix=''):
2049
pending = [self._transform.root]
2050
while len(pending) > 0:
2051
parent_id = pending.pop()
2054
prefix = prefix.rstrip('/')
2055
parent_path = self._final_paths.get_path(parent_id)
2056
parent_file_id = self._transform.final_file_id(parent_id)
2057
for child_id in self._all_children(parent_id):
2058
path_from_root = self._final_paths.get_path(child_id)
2059
basename = self._transform.final_name(child_id)
2060
file_id = self._transform.final_file_id(child_id)
2062
kind = self._transform.final_kind(child_id)
2063
versioned_kind = kind
2066
versioned_kind = self._transform._tree.stored_kind(file_id)
2067
if versioned_kind == 'directory':
2068
subdirs.append(child_id)
2069
children.append((path_from_root, basename, kind, None,
2070
file_id, versioned_kind))
2072
if parent_path.startswith(prefix):
2073
yield (parent_path, parent_file_id), children
2074
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2077
def get_parent_ids(self):
2078
return self._parent_ids
2080
def set_parent_ids(self, parent_ids):
2081
self._parent_ids = parent_ids
2083
def get_revision_tree(self, revision_id):
2084
return self._transform._tree.get_revision_tree(revision_id)
2087
def joinpath(parent, child):
2088
"""Join tree-relative paths, handling the tree root specially"""
2089
if parent is None or parent == "":
2092
return pathjoin(parent, child)
2095
class FinalPaths(object):
2096
"""Make path calculation cheap by memoizing paths.
2098
The underlying tree must not be manipulated between calls, or else
2099
the results will likely be incorrect.
2101
def __init__(self, transform):
2102
object.__init__(self)
2103
self._known_paths = {}
2104
self.transform = transform
2106
def _determine_path(self, trans_id):
2107
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2109
name = self.transform.final_name(trans_id)
2110
parent_id = self.transform.final_parent(trans_id)
2111
if parent_id == self.transform.root:
2114
return pathjoin(self.get_path(parent_id), name)
2116
def get_path(self, trans_id):
2117
"""Find the final path associated with a trans_id"""
2118
if trans_id not in self._known_paths:
2119
self._known_paths[trans_id] = self._determine_path(trans_id)
2120
return self._known_paths[trans_id]
2122
def get_paths(self, trans_ids):
2123
return [(self.get_path(t), t) for t in trans_ids]
2127
def topology_sorted_ids(tree):
2128
"""Determine the topological order of the ids in a tree"""
2129
file_ids = list(tree)
2130
file_ids.sort(key=tree.id2path)
2134
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2135
delta_from_tree=False):
2136
"""Create working tree for a branch, using a TreeTransform.
2138
This function should be used on empty trees, having a tree root at most.
2139
(see merge and revert functionality for working with existing trees)
2141
Existing files are handled like so:
2143
- Existing bzrdirs take precedence over creating new items. They are
2144
created as '%s.diverted' % name.
2145
- Otherwise, if the content on disk matches the content we are building,
2146
it is silently replaced.
2147
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2149
:param tree: The tree to convert wt into a copy of
2150
:param wt: The working tree that files will be placed into
2151
:param accelerator_tree: A tree which can be used for retrieving file
2152
contents more quickly than tree itself, i.e. a workingtree. tree
2153
will be used for cases where accelerator_tree's content is different.
2154
:param hardlink: If true, hard-link files to accelerator_tree, where
2155
possible. accelerator_tree must implement abspath, i.e. be a
2157
:param delta_from_tree: If true, build_tree may use the input Tree to
2158
generate the inventory delta.
2160
wt.lock_tree_write()
2164
if accelerator_tree is not None:
2165
accelerator_tree.lock_read()
2167
return _build_tree(tree, wt, accelerator_tree, hardlink,
2170
if accelerator_tree is not None:
2171
accelerator_tree.unlock()
2178
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2179
"""See build_tree."""
2180
for num, _unused in enumerate(wt.all_file_ids()):
2181
if num > 0: # more than just a root
2182
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2183
existing_files = set()
2184
for dir, files in wt.walkdirs():
2185
existing_files.update(f[0] for f in files)
2187
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2188
pp = ProgressPhase("Build phase", 2, top_pb)
2189
if tree.inventory.root is not None:
2190
# This is kind of a hack: we should be altering the root
2191
# as part of the regular tree shape diff logic.
2192
# The conditional test here is to avoid doing an
2193
# expensive operation (flush) every time the root id
2194
# is set within the tree, nor setting the root and thus
2195
# marking the tree as dirty, because we use two different
2196
# idioms here: tree interfaces and inventory interfaces.
2197
if wt.get_root_id() != tree.get_root_id():
2198
wt.set_root_id(tree.get_root_id())
2200
tt = TreeTransform(wt)
2204
file_trans_id[wt.get_root_id()] = \
2205
tt.trans_id_tree_file_id(wt.get_root_id())
2206
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2208
deferred_contents = []
2210
total = len(tree.inventory)
2212
precomputed_delta = []
2214
precomputed_delta = None
2215
for num, (tree_path, entry) in \
2216
enumerate(tree.inventory.iter_entries_by_dir()):
2217
pb.update("Building tree", num - len(deferred_contents), total)
2218
if entry.parent_id is None:
2221
file_id = entry.file_id
2223
precomputed_delta.append((None, tree_path, file_id, entry))
2224
if tree_path in existing_files:
2225
target_path = wt.abspath(tree_path)
2226
kind = file_kind(target_path)
2227
if kind == "directory":
2229
bzrdir.BzrDir.open(target_path)
2230
except errors.NotBranchError:
2234
if (file_id not in divert and
2235
_content_match(tree, entry, file_id, kind,
2237
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2238
if kind == 'directory':
2240
parent_id = file_trans_id[entry.parent_id]
2241
if entry.kind == 'file':
2242
# We *almost* replicate new_by_entry, so that we can defer
2243
# getting the file text, and get them all at once.
2244
trans_id = tt.create_path(entry.name, parent_id)
2245
file_trans_id[file_id] = trans_id
2246
tt.version_file(file_id, trans_id)
2247
executable = tree.is_executable(file_id, tree_path)
2249
tt.set_executability(executable, trans_id)
2250
trans_data = (trans_id, tree_path)
2251
deferred_contents.append((file_id, trans_data))
2253
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2256
new_trans_id = file_trans_id[file_id]
2257
old_parent = tt.trans_id_tree_path(tree_path)
2258
_reparent_children(tt, old_parent, new_trans_id)
2259
offset = num + 1 - len(deferred_contents)
2260
_create_files(tt, tree, deferred_contents, pb, offset,
2261
accelerator_tree, hardlink)
2265
divert_trans = set(file_trans_id[f] for f in divert)
2266
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2267
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2268
if len(raw_conflicts) > 0:
2269
precomputed_delta = None
2270
conflicts = cook_conflicts(raw_conflicts, tt)
2271
for conflict in conflicts:
2274
wt.add_conflicts(conflicts)
2275
except errors.UnsupportedOperation:
2277
result = tt.apply(no_conflicts=True,
2278
precomputed_delta=precomputed_delta)
2285
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2287
total = len(desired_files) + offset
2289
if accelerator_tree is None:
2290
new_desired_files = desired_files
2292
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2293
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2294
in iter if not (c or e[0] != e[1]))
2295
new_desired_files = []
2297
for file_id, (trans_id, tree_path) in desired_files:
2298
accelerator_path = unchanged.get(file_id)
2299
if accelerator_path is None:
2300
new_desired_files.append((file_id, (trans_id, tree_path)))
2302
pb.update('Adding file contents', count + offset, total)
2304
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2307
contents = accelerator_tree.get_file(file_id, accelerator_path)
2308
if wt.supports_content_filtering():
2309
filters = wt._content_filter_stack(tree_path)
2310
contents = filtered_output_bytes(contents, filters,
2311
ContentFilterContext(tree_path, tree))
2313
tt.create_file(contents, trans_id)
2317
except AttributeError:
2318
# after filtering, contents may no longer be file-like
2322
for count, ((trans_id, tree_path), contents) in enumerate(
2323
tree.iter_files_bytes(new_desired_files)):
2324
if wt.supports_content_filtering():
2325
filters = wt._content_filter_stack(tree_path)
2326
contents = filtered_output_bytes(contents, filters,
2327
ContentFilterContext(tree_path, tree))
2328
tt.create_file(contents, trans_id)
2329
pb.update('Adding file contents', count + offset, total)
2332
def _reparent_children(tt, old_parent, new_parent):
2333
for child in tt.iter_tree_children(old_parent):
2334
tt.adjust_path(tt.final_name(child), new_parent, child)
2336
def _reparent_transform_children(tt, old_parent, new_parent):
2337
by_parent = tt.by_parent()
2338
for child in by_parent[old_parent]:
2339
tt.adjust_path(tt.final_name(child), new_parent, child)
2340
return by_parent[old_parent]
2342
def _content_match(tree, entry, file_id, kind, target_path):
2343
if entry.kind != kind:
2345
if entry.kind == "directory":
2347
if entry.kind == "file":
2348
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2350
elif entry.kind == "symlink":
2351
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2356
def resolve_checkout(tt, conflicts, divert):
2357
new_conflicts = set()
2358
for c_type, conflict in ((c[0], c) for c in conflicts):
2359
# Anything but a 'duplicate' would indicate programmer error
2360
if c_type != 'duplicate':
2361
raise AssertionError(c_type)
2362
# Now figure out which is new and which is old
2363
if tt.new_contents(conflict[1]):
2364
new_file = conflict[1]
2365
old_file = conflict[2]
2367
new_file = conflict[2]
2368
old_file = conflict[1]
2370
# We should only get here if the conflict wasn't completely
2372
final_parent = tt.final_parent(old_file)
2373
if new_file in divert:
2374
new_name = tt.final_name(old_file)+'.diverted'
2375
tt.adjust_path(new_name, final_parent, new_file)
2376
new_conflicts.add((c_type, 'Diverted to',
2377
new_file, old_file))
2379
new_name = tt.final_name(old_file)+'.moved'
2380
tt.adjust_path(new_name, final_parent, old_file)
2381
new_conflicts.add((c_type, 'Moved existing file to',
2382
old_file, new_file))
2383
return new_conflicts
2386
def new_by_entry(tt, entry, parent_id, tree):
2387
"""Create a new file according to its inventory entry"""
2391
contents = tree.get_file(entry.file_id).readlines()
2392
executable = tree.is_executable(entry.file_id)
2393
return tt.new_file(name, parent_id, contents, entry.file_id,
2395
elif kind in ('directory', 'tree-reference'):
2396
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2397
if kind == 'tree-reference':
2398
tt.set_tree_reference(entry.reference_revision, trans_id)
2400
elif kind == 'symlink':
2401
target = tree.get_symlink_target(entry.file_id)
2402
return tt.new_symlink(name, parent_id, target, entry.file_id)
2404
raise errors.BadFileKindError(name, kind)
2407
@deprecated_function(deprecated_in((1, 9, 0)))
2408
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2409
"""Create new file contents according to an inventory entry.
2411
DEPRECATED. Use create_from_tree instead.
2413
if entry.kind == "file":
2415
lines = tree.get_file(entry.file_id).readlines()
2416
tt.create_file(lines, trans_id, mode_id=mode_id)
2417
elif entry.kind == "symlink":
2418
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2419
elif entry.kind == "directory":
2420
tt.create_directory(trans_id)
2423
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2424
filter_tree_path=None):
2425
"""Create new file contents according to tree contents.
2427
:param filter_tree_path: the tree path to use to lookup
2428
content filters to apply to the bytes output in the working tree.
2429
This only applies if the working tree supports content filtering.
2431
kind = tree.kind(file_id)
2432
if kind == 'directory':
2433
tt.create_directory(trans_id)
2434
elif kind == "file":
2436
tree_file = tree.get_file(file_id)
2438
bytes = tree_file.readlines()
2442
if wt.supports_content_filtering() and filter_tree_path is not None:
2443
filters = wt._content_filter_stack(filter_tree_path)
2444
bytes = filtered_output_bytes(bytes, filters,
2445
ContentFilterContext(filter_tree_path, tree))
2446
tt.create_file(bytes, trans_id)
2447
elif kind == "symlink":
2448
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2450
raise AssertionError('Unknown kind %r' % kind)
2453
def create_entry_executability(tt, entry, trans_id):
2454
"""Set the executability of a trans_id according to an inventory entry"""
2455
if entry.kind == "file":
2456
tt.set_executability(entry.executable, trans_id)
2459
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2460
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2463
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2464
"""Produce a backup-style name that appears to be available"""
2468
yield "%s.~%d~" % (name, counter)
2470
for new_name in name_gen():
2471
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2475
def _entry_changes(file_id, entry, working_tree):
2476
"""Determine in which ways the inventory entry has changed.
2478
Returns booleans: has_contents, content_mod, meta_mod
2479
has_contents means there are currently contents, but they differ
2480
contents_mod means contents need to be modified
2481
meta_mod means the metadata needs to be modified
2483
cur_entry = working_tree.inventory[file_id]
2485
working_kind = working_tree.kind(file_id)
2488
has_contents = False
2491
if has_contents is True:
2492
if entry.kind != working_kind:
2493
contents_mod, meta_mod = True, False
2495
cur_entry._read_tree_state(working_tree.id2path(file_id),
2497
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2498
cur_entry._forget_tree_state()
2499
return has_contents, contents_mod, meta_mod
2502
def revert(working_tree, target_tree, filenames, backups=False,
2503
pb=DummyProgress(), change_reporter=None):
2504
"""Revert a working tree's contents to those of a target tree."""
2505
target_tree.lock_read()
2506
tt = TreeTransform(working_tree, pb)
2508
pp = ProgressPhase("Revert phase", 3, pb)
2509
conflicts, merge_modified = _prepare_revert_transform(
2510
working_tree, target_tree, tt, filenames, backups, pp)
2512
change_reporter = delta._ChangeReporter(
2513
unversioned_filter=working_tree.is_ignored)
2514
delta.report_changes(tt.iter_changes(), change_reporter)
2515
for conflict in conflicts:
2519
working_tree.set_merge_modified(merge_modified)
2521
target_tree.unlock()
2527
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2528
backups, pp, basis_tree=None,
2529
merge_modified=None):
2531
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2533
if merge_modified is None:
2534
merge_modified = working_tree.merge_modified()
2535
merge_modified = _alter_files(working_tree, target_tree, tt,
2536
child_pb, filenames, backups,
2537
merge_modified, basis_tree)
2541
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2543
raw_conflicts = resolve_conflicts(tt, child_pb,
2544
lambda t, c: conflict_pass(t, c, target_tree))
2547
conflicts = cook_conflicts(raw_conflicts, tt)
2548
return conflicts, merge_modified
2551
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2552
backups, merge_modified, basis_tree=None):
2553
if basis_tree is not None:
2554
basis_tree.lock_read()
2555
change_list = target_tree.iter_changes(working_tree,
2556
specific_files=specific_files, pb=pb)
2557
if target_tree.get_root_id() is None:
2563
for id_num, (file_id, path, changed_content, versioned, parent, name,
2564
kind, executable) in enumerate(change_list):
2565
if skip_root and file_id[0] is not None and parent[0] is None:
2567
trans_id = tt.trans_id_file_id(file_id)
2570
keep_content = False
2571
if kind[0] == 'file' and (backups or kind[1] is None):
2572
wt_sha1 = working_tree.get_file_sha1(file_id)
2573
if merge_modified.get(file_id) != wt_sha1:
2574
# acquire the basis tree lazily to prevent the
2575
# expense of accessing it when it's not needed ?
2576
# (Guessing, RBC, 200702)
2577
if basis_tree is None:
2578
basis_tree = working_tree.basis_tree()
2579
basis_tree.lock_read()
2580
if file_id in basis_tree:
2581
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2583
elif kind[1] is None and not versioned[1]:
2585
if kind[0] is not None:
2586
if not keep_content:
2587
tt.delete_contents(trans_id)
2588
elif kind[1] is not None:
2589
parent_trans_id = tt.trans_id_file_id(parent[0])
2590
by_parent = tt.by_parent()
2591
backup_name = _get_backup_name(name[0], by_parent,
2592
parent_trans_id, tt)
2593
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2594
new_trans_id = tt.create_path(name[0], parent_trans_id)
2595
if versioned == (True, True):
2596
tt.unversion_file(trans_id)
2597
tt.version_file(file_id, new_trans_id)
2598
# New contents should have the same unix perms as old
2601
trans_id = new_trans_id
2602
if kind[1] in ('directory', 'tree-reference'):
2603
tt.create_directory(trans_id)
2604
if kind[1] == 'tree-reference':
2605
revision = target_tree.get_reference_revision(file_id,
2607
tt.set_tree_reference(revision, trans_id)
2608
elif kind[1] == 'symlink':
2609
tt.create_symlink(target_tree.get_symlink_target(file_id),
2611
elif kind[1] == 'file':
2612
deferred_files.append((file_id, (trans_id, mode_id)))
2613
if basis_tree is None:
2614
basis_tree = working_tree.basis_tree()
2615
basis_tree.lock_read()
2616
new_sha1 = target_tree.get_file_sha1(file_id)
2617
if (file_id in basis_tree and new_sha1 ==
2618
basis_tree.get_file_sha1(file_id)):
2619
if file_id in merge_modified:
2620
del merge_modified[file_id]
2622
merge_modified[file_id] = new_sha1
2624
# preserve the execute bit when backing up
2625
if keep_content and executable[0] == executable[1]:
2626
tt.set_executability(executable[1], trans_id)
2627
elif kind[1] is not None:
2628
raise AssertionError(kind[1])
2629
if versioned == (False, True):
2630
tt.version_file(file_id, trans_id)
2631
if versioned == (True, False):
2632
tt.unversion_file(trans_id)
2633
if (name[1] is not None and
2634
(name[0] != name[1] or parent[0] != parent[1])):
2635
if name[1] == '' and parent[1] is None:
2636
parent_trans = ROOT_PARENT
2638
parent_trans = tt.trans_id_file_id(parent[1])
2639
tt.adjust_path(name[1], parent_trans, trans_id)
2640
if executable[0] != executable[1] and kind[1] == "file":
2641
tt.set_executability(executable[1], trans_id)
2642
if working_tree.supports_content_filtering():
2643
for index, ((trans_id, mode_id), bytes) in enumerate(
2644
target_tree.iter_files_bytes(deferred_files)):
2645
file_id = deferred_files[index][0]
2646
# We're reverting a tree to the target tree so using the
2647
# target tree to find the file path seems the best choice
2648
# here IMO - Ian C 27/Oct/2009
2649
filter_tree_path = target_tree.id2path(file_id)
2650
filters = working_tree._content_filter_stack(filter_tree_path)
2651
bytes = filtered_output_bytes(bytes, filters,
2652
ContentFilterContext(filter_tree_path, working_tree))
2653
tt.create_file(bytes, trans_id, mode_id)
2655
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2657
tt.create_file(bytes, trans_id, mode_id)
2659
if basis_tree is not None:
2661
return merge_modified
2664
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2665
"""Make many conflict-resolution attempts, but die if they fail"""
2666
if pass_func is None:
2667
pass_func = conflict_pass
2668
new_conflicts = set()
2671
pb.update('Resolution pass', n+1, 10)
2672
conflicts = tt.find_conflicts()
2673
if len(conflicts) == 0:
2674
return new_conflicts
2675
new_conflicts.update(pass_func(tt, conflicts))
2676
raise MalformedTransform(conflicts=conflicts)
2681
def conflict_pass(tt, conflicts, path_tree=None):
2682
"""Resolve some classes of conflicts.
2684
:param tt: The transform to resolve conflicts in
2685
:param conflicts: The conflicts to resolve
2686
:param path_tree: A Tree to get supplemental paths from
2688
new_conflicts = set()
2689
for c_type, conflict in ((c[0], c) for c in conflicts):
2690
if c_type == 'duplicate id':
2691
tt.unversion_file(conflict[1])
2692
new_conflicts.add((c_type, 'Unversioned existing file',
2693
conflict[1], conflict[2], ))
2694
elif c_type == 'duplicate':
2695
# files that were renamed take precedence
2696
final_parent = tt.final_parent(conflict[1])
2697
if tt.path_changed(conflict[1]):
2698
existing_file, new_file = conflict[2], conflict[1]
2700
existing_file, new_file = conflict[1], conflict[2]
2701
new_name = tt.final_name(existing_file)+'.moved'
2702
tt.adjust_path(new_name, final_parent, existing_file)
2703
new_conflicts.add((c_type, 'Moved existing file to',
2704
existing_file, new_file))
2705
elif c_type == 'parent loop':
2706
# break the loop by undoing one of the ops that caused the loop
2708
while not tt.path_changed(cur):
2709
cur = tt.final_parent(cur)
2710
new_conflicts.add((c_type, 'Cancelled move', cur,
2711
tt.final_parent(cur),))
2712
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2714
elif c_type == 'missing parent':
2715
trans_id = conflict[1]
2717
tt.cancel_deletion(trans_id)
2718
new_conflicts.add(('deleting parent', 'Not deleting',
2723
tt.final_name(trans_id)
2725
if path_tree is not None:
2726
file_id = tt.final_file_id(trans_id)
2728
file_id = tt.inactive_file_id(trans_id)
2729
entry = path_tree.inventory[file_id]
2730
# special-case the other tree root (move its
2731
# children to current root)
2732
if entry.parent_id is None:
2734
moved = _reparent_transform_children(
2735
tt, trans_id, tt.root)
2737
new_conflicts.add((c_type, 'Moved to root',
2740
parent_trans_id = tt.trans_id_file_id(
2742
tt.adjust_path(entry.name, parent_trans_id,
2745
tt.create_directory(trans_id)
2746
new_conflicts.add((c_type, 'Created directory', trans_id))
2747
elif c_type == 'unversioned parent':
2748
file_id = tt.inactive_file_id(conflict[1])
2749
# special-case the other tree root (move its children instead)
2750
if path_tree and file_id in path_tree:
2751
if path_tree.inventory[file_id].parent_id is None:
2753
tt.version_file(file_id, conflict[1])
2754
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2755
elif c_type == 'non-directory parent':
2756
parent_id = conflict[1]
2757
parent_parent = tt.final_parent(parent_id)
2758
parent_name = tt.final_name(parent_id)
2759
parent_file_id = tt.final_file_id(parent_id)
2760
new_parent_id = tt.new_directory(parent_name + '.new',
2761
parent_parent, parent_file_id)
2762
_reparent_transform_children(tt, parent_id, new_parent_id)
2763
if parent_file_id is not None:
2764
tt.unversion_file(parent_id)
2765
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2766
elif c_type == 'versioning no contents':
2767
tt.cancel_versioning(conflict[1])
2768
return new_conflicts
2771
def cook_conflicts(raw_conflicts, tt):
2772
"""Generate a list of cooked conflicts, sorted by file path"""
2773
from bzrlib.conflicts import Conflict
2774
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2775
return sorted(conflict_iter, key=Conflict.sort_key)
2778
def iter_cook_conflicts(raw_conflicts, tt):
2779
from bzrlib.conflicts import Conflict
2781
for conflict in raw_conflicts:
2782
c_type = conflict[0]
2783
action = conflict[1]
2784
modified_path = fp.get_path(conflict[2])
2785
modified_id = tt.final_file_id(conflict[2])
2786
if len(conflict) == 3:
2787
yield Conflict.factory(c_type, action=action, path=modified_path,
2788
file_id=modified_id)
2791
conflicting_path = fp.get_path(conflict[3])
2792
conflicting_id = tt.final_file_id(conflict[3])
2793
yield Conflict.factory(c_type, action=action, path=modified_path,
2794
file_id=modified_id,
2795
conflict_path=conflicting_path,
2796
conflict_file_id=conflicting_id)
2799
class _FileMover(object):
2800
"""Moves and deletes files for TreeTransform, tracking operations"""
2803
self.past_renames = []
2804
self.pending_deletions = []
2806
def rename(self, from_, to):
2807
"""Rename a file from one path to another. Functions like os.rename"""
2809
os.rename(from_, to)
2811
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2812
raise errors.FileExists(to, str(e))
2814
self.past_renames.append((from_, to))
2816
def pre_delete(self, from_, to):
2817
"""Rename a file out of the way and mark it for deletion.
2819
Unlike os.unlink, this works equally well for files and directories.
2820
:param from_: The current file path
2821
:param to: A temporary path for the file
2823
self.rename(from_, to)
2824
self.pending_deletions.append(to)
2827
"""Reverse all renames that have been performed"""
2828
for from_, to in reversed(self.past_renames):
2829
os.rename(to, from_)
2830
# after rollback, don't reuse _FileMover
2832
pending_deletions = None
2834
def apply_deletions(self):
2835
"""Apply all marked deletions"""
2836
for path in self.pending_deletions:
2838
# after apply_deletions, don't reuse _FileMover
2840
pending_deletions = None
added
removed
bzrlib/transform.py
