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 not None:
1059
parent = self._new_parent.get(trans_id)
1060
# if the parent directory is already in limbo (e.g. when building a
1061
# tree), choose a limbo name inside the parent, to reduce further
1063
use_direct_path = False
1064
if self._new_contents.get(parent) == 'directory':
1065
filename = self._new_name.get(trans_id)
1066
if filename is not None:
1067
if parent not in self._limbo_children:
1068
self._limbo_children[parent] = set()
1069
self._limbo_children_names[parent] = {}
1070
use_direct_path = True
1071
# the direct path can only be used if no other file has
1072
# already taken this pathname, i.e. if the name is unused, or
1073
# if it is already associated with this trans_id.
1074
elif self._case_sensitive_target:
1075
if (self._limbo_children_names[parent].get(filename)
1076
in (trans_id, None)):
1077
use_direct_path = True
1079
for l_filename, l_trans_id in\
1080
self._limbo_children_names[parent].iteritems():
1081
if l_trans_id == trans_id:
1083
if l_filename.lower() == filename.lower():
1086
use_direct_path = True
1089
limbo_name = pathjoin(self._limbo_files[parent], filename)
1090
self._limbo_children[parent].add(trans_id)
1091
self._limbo_children_names[parent][filename] = trans_id
1093
limbo_name = pathjoin(self._limbodir, trans_id)
1094
self._needs_rename.add(trans_id)
1095
self._limbo_files[trans_id] = limbo_name
1098
def adjust_path(self, name, parent, trans_id):
1099
previous_parent = self._new_parent.get(trans_id)
1100
previous_name = self._new_name.get(trans_id)
1101
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1102
if (trans_id in self._limbo_files and
1103
trans_id not in self._needs_rename):
1104
self._rename_in_limbo([trans_id])
1105
self._limbo_children[previous_parent].remove(trans_id)
1106
del self._limbo_children_names[previous_parent][previous_name]
1108
def _rename_in_limbo(self, trans_ids):
1109
"""Fix limbo names so that the right final path is produced.
1111
This means we outsmarted ourselves-- we tried to avoid renaming
1112
these files later by creating them with their final names in their
1113
final parents. But now the previous name or parent is no longer
1114
suitable, so we have to rename them.
1116
Even for trans_ids that have no new contents, we must remove their
1117
entries from _limbo_files, because they are now stale.
1119
for trans_id in trans_ids:
1120
old_path = self._limbo_files.pop(trans_id)
1121
if trans_id not in self._new_contents:
1123
new_path = self._limbo_name(trans_id)
1124
os.rename(old_path, new_path)
1125
for descendant in self._limbo_descendants(trans_id):
1126
desc_path = self._limbo_files[descendant]
1127
desc_path = new_path + desc_path[len(old_path):]
1128
self._limbo_files[descendant] = desc_path
1130
def _limbo_descendants(self, trans_id):
1131
"""Return the set of trans_ids whose limbo paths descend from this."""
1132
descendants = set(self._limbo_children.get(trans_id, []))
1133
for descendant in list(descendants):
1134
descendants.update(self._limbo_descendants(descendant))
1137
def create_file(self, contents, trans_id, mode_id=None):
1138
"""Schedule creation of a new file.
1142
Contents is an iterator of strings, all of which will be written
1143
to the target destination.
1145
New file takes the permissions of any existing file with that id,
1146
unless mode_id is specified.
1148
name = self._limbo_name(trans_id)
1149
f = open(name, 'wb')
1152
unique_add(self._new_contents, trans_id, 'file')
1154
# Clean up the file, it never got registered so
1155
# TreeTransform.finalize() won't clean it up.
1160
f.writelines(contents)
1163
self._set_mode(trans_id, mode_id, S_ISREG)
1165
def _read_file_chunks(self, trans_id):
1166
cur_file = open(self._limbo_name(trans_id), 'rb')
1168
return cur_file.readlines()
1172
def _read_symlink_target(self, trans_id):
1173
return os.readlink(self._limbo_name(trans_id))
1175
def create_hardlink(self, path, trans_id):
1176
"""Schedule creation of a hard link"""
1177
name = self._limbo_name(trans_id)
1181
if e.errno != errno.EPERM:
1183
raise errors.HardLinkNotSupported(path)
1185
unique_add(self._new_contents, trans_id, 'file')
1187
# Clean up the file, it never got registered so
1188
# TreeTransform.finalize() won't clean it up.
1192
def create_directory(self, trans_id):
1193
"""Schedule creation of a new directory.
1195
See also new_directory.
1197
os.mkdir(self._limbo_name(trans_id))
1198
unique_add(self._new_contents, trans_id, 'directory')
1200
def create_symlink(self, target, trans_id):
1201
"""Schedule creation of a new symbolic link.
1203
target is a bytestring.
1204
See also new_symlink.
1207
os.symlink(target, self._limbo_name(trans_id))
1208
unique_add(self._new_contents, trans_id, 'symlink')
1211
path = FinalPaths(self).get_path(trans_id)
1214
raise UnableCreateSymlink(path=path)
1216
def cancel_creation(self, trans_id):
1217
"""Cancel the creation of new file contents."""
1218
del self._new_contents[trans_id]
1219
children = self._limbo_children.get(trans_id)
1220
# if this is a limbo directory with children, move them before removing
1222
if children is not None:
1223
self._rename_in_limbo(children)
1224
del self._limbo_children[trans_id]
1225
del self._limbo_children_names[trans_id]
1226
delete_any(self._limbo_name(trans_id))
1229
class TreeTransform(DiskTreeTransform):
1230
"""Represent a tree transformation.
1232
This object is designed to support incremental generation of the transform,
1235
However, it gives optimum performance when parent directories are created
1236
before their contents. The transform is then able to put child files
1237
directly in their parent directory, avoiding later renames.
1239
It is easy to produce malformed transforms, but they are generally
1240
harmless. Attempting to apply a malformed transform will cause an
1241
exception to be raised before any modifications are made to the tree.
1243
Many kinds of malformed transforms can be corrected with the
1244
resolve_conflicts function. The remaining ones indicate programming error,
1245
such as trying to create a file with no path.
1247
Two sets of file creation methods are supplied. Convenience methods are:
1252
These are composed of the low-level methods:
1254
* create_file or create_directory or create_symlink
1258
Transform/Transaction ids
1259
-------------------------
1260
trans_ids are temporary ids assigned to all files involved in a transform.
1261
It's possible, even common, that not all files in the Tree have trans_ids.
1263
trans_ids are used because filenames and file_ids are not good enough
1264
identifiers; filenames change, and not all files have file_ids. File-ids
1265
are also associated with trans-ids, so that moving a file moves its
1268
trans_ids are only valid for the TreeTransform that generated them.
1272
Limbo is a temporary directory use to hold new versions of files.
1273
Files are added to limbo by create_file, create_directory, create_symlink,
1274
and their convenience variants (new_*). Files may be removed from limbo
1275
using cancel_creation. Files are renamed from limbo into their final
1276
location as part of TreeTransform.apply
1278
Limbo must be cleaned up, by either calling TreeTransform.apply or
1279
calling TreeTransform.finalize.
1281
Files are placed into limbo inside their parent directories, where
1282
possible. This reduces subsequent renames, and makes operations involving
1283
lots of files faster. This optimization is only possible if the parent
1284
directory is created *before* creating any of its children, so avoid
1285
creating children before parents, where possible.
1289
This temporary directory is used by _FileMover for storing files that are
1290
about to be deleted. In case of rollback, the files will be restored.
1291
FileMover does not delete files until it is sure that a rollback will not
1294
def __init__(self, tree, pb=DummyProgress()):
1295
"""Note: a tree_write lock is taken on the tree.
1297
Use TreeTransform.finalize() to release the lock (can be omitted if
1298
TreeTransform.apply() called).
1300
tree.lock_tree_write()
1303
limbodir = urlutils.local_path_from_url(
1304
tree._transport.abspath('limbo'))
1308
if e.errno == errno.EEXIST:
1309
raise ExistingLimbo(limbodir)
1310
deletiondir = urlutils.local_path_from_url(
1311
tree._transport.abspath('pending-deletion'))
1313
os.mkdir(deletiondir)
1315
if e.errno == errno.EEXIST:
1316
raise errors.ExistingPendingDeletion(deletiondir)
1321
# Cache of realpath results, to speed up canonical_path
1322
self._realpaths = {}
1323
# Cache of relpath results, to speed up canonical_path
1325
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1326
tree.case_sensitive)
1327
self._deletiondir = deletiondir
1329
def canonical_path(self, path):
1330
"""Get the canonical tree-relative path"""
1331
# don't follow final symlinks
1332
abs = self._tree.abspath(path)
1333
if abs in self._relpaths:
1334
return self._relpaths[abs]
1335
dirname, basename = os.path.split(abs)
1336
if dirname not in self._realpaths:
1337
self._realpaths[dirname] = os.path.realpath(dirname)
1338
dirname = self._realpaths[dirname]
1339
abs = pathjoin(dirname, basename)
1340
if dirname in self._relpaths:
1341
relpath = pathjoin(self._relpaths[dirname], basename)
1342
relpath = relpath.rstrip('/\\')
1344
relpath = self._tree.relpath(abs)
1345
self._relpaths[abs] = relpath
1348
def tree_kind(self, trans_id):
1349
"""Determine the file kind in the working tree.
1351
Raises NoSuchFile if the file does not exist
1353
path = self._tree_id_paths.get(trans_id)
1355
raise NoSuchFile(None)
1357
return file_kind(self._tree.abspath(path))
1359
if e.errno != errno.ENOENT:
1362
raise NoSuchFile(path)
1364
def _set_mode(self, trans_id, mode_id, typefunc):
1365
"""Set the mode of new file contents.
1366
The mode_id is the existing file to get the mode from (often the same
1367
as trans_id). The operation is only performed if there's a mode match
1368
according to typefunc.
1373
old_path = self._tree_id_paths[mode_id]
1377
mode = os.stat(self._tree.abspath(old_path)).st_mode
1379
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1380
# Either old_path doesn't exist, or the parent of the
1381
# target is not a directory (but will be one eventually)
1382
# Either way, we know it doesn't exist *right now*
1383
# See also bug #248448
1388
os.chmod(self._limbo_name(trans_id), mode)
1390
def iter_tree_children(self, parent_id):
1391
"""Iterate through the entry's tree children, if any"""
1393
path = self._tree_id_paths[parent_id]
1397
children = os.listdir(self._tree.abspath(path))
1399
if not (osutils._is_error_enotdir(e)
1400
or e.errno in (errno.ENOENT, errno.ESRCH)):
1404
for child in children:
1405
childpath = joinpath(path, child)
1406
if self._tree.is_control_filename(childpath):
1408
yield self.trans_id_tree_path(childpath)
1410
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1411
"""Apply all changes to the inventory and filesystem.
1413
If filesystem or inventory conflicts are present, MalformedTransform
1416
If apply succeeds, finalize is not necessary.
1418
:param no_conflicts: if True, the caller guarantees there are no
1419
conflicts, so no check is made.
1420
:param precomputed_delta: An inventory delta to use instead of
1422
:param _mover: Supply an alternate FileMover, for testing
1424
if not no_conflicts:
1425
self._check_malformed()
1426
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1428
if precomputed_delta is None:
1429
child_pb.update('Apply phase', 0, 2)
1430
inventory_delta = self._generate_inventory_delta()
1433
inventory_delta = precomputed_delta
1436
mover = _FileMover()
1440
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1441
self._apply_removals(mover)
1442
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1443
modified_paths = self._apply_insertions(mover)
1448
mover.apply_deletions()
1451
self._tree.apply_inventory_delta(inventory_delta)
1454
return _TransformResults(modified_paths, self.rename_count)
1456
def _generate_inventory_delta(self):
1457
"""Generate an inventory delta for the current transform."""
1458
inventory_delta = []
1459
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1460
new_paths = self._inventory_altered()
1461
total_entries = len(new_paths) + len(self._removed_id)
1463
for num, trans_id in enumerate(self._removed_id):
1465
child_pb.update('removing file', num, total_entries)
1466
if trans_id == self._new_root:
1467
file_id = self._tree.get_root_id()
1469
file_id = self.tree_file_id(trans_id)
1470
# File-id isn't really being deleted, just moved
1471
if file_id in self._r_new_id:
1473
path = self._tree_id_paths[trans_id]
1474
inventory_delta.append((path, None, file_id, None))
1475
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1477
entries = self._tree.iter_entries_by_dir(
1478
new_path_file_ids.values())
1479
old_paths = dict((e.file_id, p) for p, e in entries)
1481
for num, (path, trans_id) in enumerate(new_paths):
1483
child_pb.update('adding file',
1484
num + len(self._removed_id), total_entries)
1485
file_id = new_path_file_ids[trans_id]
1490
kind = self.final_kind(trans_id)
1492
kind = self._tree.stored_kind(file_id)
1493
parent_trans_id = self.final_parent(trans_id)
1494
parent_file_id = new_path_file_ids.get(parent_trans_id)
1495
if parent_file_id is None:
1496
parent_file_id = self.final_file_id(parent_trans_id)
1497
if trans_id in self._new_reference_revision:
1498
new_entry = inventory.TreeReference(
1500
self._new_name[trans_id],
1501
self.final_file_id(self._new_parent[trans_id]),
1502
None, self._new_reference_revision[trans_id])
1504
new_entry = inventory.make_entry(kind,
1505
self.final_name(trans_id),
1506
parent_file_id, file_id)
1507
old_path = old_paths.get(new_entry.file_id)
1508
new_executability = self._new_executability.get(trans_id)
1509
if new_executability is not None:
1510
new_entry.executable = new_executability
1511
inventory_delta.append(
1512
(old_path, path, new_entry.file_id, new_entry))
1515
return inventory_delta
1517
def _apply_removals(self, mover):
1518
"""Perform tree operations that remove directory/inventory names.
1520
That is, delete files that are to be deleted, and put any files that
1521
need renaming into limbo. This must be done in strict child-to-parent
1524
If inventory_delta is None, no inventory delta generation is performed.
1526
tree_paths = list(self._tree_path_ids.iteritems())
1527
tree_paths.sort(reverse=True)
1528
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1530
for num, data in enumerate(tree_paths):
1531
path, trans_id = data
1532
child_pb.update('removing file', num, len(tree_paths))
1533
full_path = self._tree.abspath(path)
1534
if trans_id in self._removed_contents:
1535
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1537
elif trans_id in self._new_name or trans_id in \
1540
mover.rename(full_path, self._limbo_name(trans_id))
1542
if e.errno != errno.ENOENT:
1545
self.rename_count += 1
1549
def _apply_insertions(self, mover):
1550
"""Perform tree operations that insert directory/inventory names.
1552
That is, create any files that need to be created, and restore from
1553
limbo any files that needed renaming. This must be done in strict
1554
parent-to-child order.
1556
If inventory_delta is None, no inventory delta is calculated, and
1557
no list of modified paths is returned.
1559
new_paths = self.new_paths(filesystem_only=True)
1561
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1563
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1565
for num, (path, trans_id) in enumerate(new_paths):
1567
child_pb.update('adding file', num, len(new_paths))
1568
full_path = self._tree.abspath(path)
1569
if trans_id in self._needs_rename:
1571
mover.rename(self._limbo_name(trans_id), full_path)
1573
# We may be renaming a dangling inventory id
1574
if e.errno != errno.ENOENT:
1577
self.rename_count += 1
1578
if (trans_id in self._new_contents or
1579
self.path_changed(trans_id)):
1580
if trans_id in self._new_contents:
1581
modified_paths.append(full_path)
1582
if trans_id in self._new_executability:
1583
self._set_executability(path, trans_id)
1586
self._new_contents.clear()
1587
return modified_paths
1590
class TransformPreview(DiskTreeTransform):
1591
"""A TreeTransform for generating preview trees.
1593
Unlike TreeTransform, this version works when the input tree is a
1594
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1595
unversioned files in the input tree.
1598
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1600
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1601
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1603
def canonical_path(self, path):
1606
def tree_kind(self, trans_id):
1607
path = self._tree_id_paths.get(trans_id)
1609
raise NoSuchFile(None)
1610
file_id = self._tree.path2id(path)
1611
return self._tree.kind(file_id)
1613
def _set_mode(self, trans_id, mode_id, typefunc):
1614
"""Set the mode of new file contents.
1615
The mode_id is the existing file to get the mode from (often the same
1616
as trans_id). The operation is only performed if there's a mode match
1617
according to typefunc.
1619
# is it ok to ignore this? probably
1622
def iter_tree_children(self, parent_id):
1623
"""Iterate through the entry's tree children, if any"""
1625
path = self._tree_id_paths[parent_id]
1628
file_id = self.tree_file_id(parent_id)
1631
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1632
children = getattr(entry, 'children', {})
1633
for child in children:
1634
childpath = joinpath(path, child)
1635
yield self.trans_id_tree_path(childpath)
1638
class _PreviewTree(tree.Tree):
1639
"""Partial implementation of Tree to support show_diff_trees"""
1641
def __init__(self, transform):
1642
self._transform = transform
1643
self._final_paths = FinalPaths(transform)
1644
self.__by_parent = None
1645
self._parent_ids = []
1646
self._all_children_cache = {}
1647
self._path2trans_id_cache = {}
1648
self._final_name_cache = {}
1649
self._iter_changes_cache = dict((c[0], c) for c in
1650
self._transform.iter_changes())
1652
def _content_change(self, file_id):
1653
"""Return True if the content of this file changed"""
1654
changes = self._iter_changes_cache.get(file_id)
1655
# changes[2] is true if the file content changed. See
1656
# InterTree.iter_changes.
1657
return (changes is not None and changes[2])
1659
def _get_repository(self):
1660
repo = getattr(self._transform._tree, '_repository', None)
1662
repo = self._transform._tree.branch.repository
1665
def _iter_parent_trees(self):
1666
for revision_id in self.get_parent_ids():
1668
yield self.revision_tree(revision_id)
1669
except errors.NoSuchRevisionInTree:
1670
yield self._get_repository().revision_tree(revision_id)
1672
def _get_file_revision(self, file_id, vf, tree_revision):
1673
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1674
self._iter_parent_trees()]
1675
vf.add_lines((file_id, tree_revision), parent_keys,
1676
self.get_file(file_id).readlines())
1677
repo = self._get_repository()
1678
base_vf = repo.texts
1679
if base_vf not in vf.fallback_versionedfiles:
1680
vf.fallback_versionedfiles.append(base_vf)
1681
return tree_revision
1683
def _stat_limbo_file(self, file_id):
1684
trans_id = self._transform.trans_id_file_id(file_id)
1685
name = self._transform._limbo_name(trans_id)
1686
return os.lstat(name)
1689
def _by_parent(self):
1690
if self.__by_parent is None:
1691
self.__by_parent = self._transform.by_parent()
1692
return self.__by_parent
1694
def _comparison_data(self, entry, path):
1695
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1696
if kind == 'missing':
1700
file_id = self._transform.final_file_id(self._path2trans_id(path))
1701
executable = self.is_executable(file_id, path)
1702
return kind, executable, None
1704
def lock_read(self):
1705
# Perhaps in theory, this should lock the TreeTransform?
1712
def inventory(self):
1713
"""This Tree does not use inventory as its backing data."""
1714
raise NotImplementedError(_PreviewTree.inventory)
1716
def get_root_id(self):
1717
return self._transform.final_file_id(self._transform.root)
1719
def all_file_ids(self):
1720
tree_ids = set(self._transform._tree.all_file_ids())
1721
tree_ids.difference_update(self._transform.tree_file_id(t)
1722
for t in self._transform._removed_id)
1723
tree_ids.update(self._transform._new_id.values())
1727
return iter(self.all_file_ids())
1729
def _has_id(self, file_id, fallback_check):
1730
if file_id in self._transform._r_new_id:
1732
elif file_id in set([self._transform.tree_file_id(trans_id) for
1733
trans_id in self._transform._removed_id]):
1736
return fallback_check(file_id)
1738
def has_id(self, file_id):
1739
return self._has_id(file_id, self._transform._tree.has_id)
1741
def has_or_had_id(self, file_id):
1742
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1744
def _path2trans_id(self, path):
1745
# We must not use None here, because that is a valid value to store.
1746
trans_id = self._path2trans_id_cache.get(path, object)
1747
if trans_id is not object:
1749
segments = splitpath(path)
1750
cur_parent = self._transform.root
1751
for cur_segment in segments:
1752
for child in self._all_children(cur_parent):
1753
final_name = self._final_name_cache.get(child)
1754
if final_name is None:
1755
final_name = self._transform.final_name(child)
1756
self._final_name_cache[child] = final_name
1757
if final_name == cur_segment:
1761
self._path2trans_id_cache[path] = None
1763
self._path2trans_id_cache[path] = cur_parent
1766
def path2id(self, path):
1767
return self._transform.final_file_id(self._path2trans_id(path))
1769
def id2path(self, file_id):
1770
trans_id = self._transform.trans_id_file_id(file_id)
1772
return self._final_paths._determine_path(trans_id)
1774
raise errors.NoSuchId(self, file_id)
1776
def _all_children(self, trans_id):
1777
children = self._all_children_cache.get(trans_id)
1778
if children is not None:
1780
children = set(self._transform.iter_tree_children(trans_id))
1781
# children in the _new_parent set are provided by _by_parent.
1782
children.difference_update(self._transform._new_parent.keys())
1783
children.update(self._by_parent.get(trans_id, []))
1784
self._all_children_cache[trans_id] = children
1787
def iter_children(self, file_id):
1788
trans_id = self._transform.trans_id_file_id(file_id)
1789
for child_trans_id in self._all_children(trans_id):
1790
yield self._transform.final_file_id(child_trans_id)
1793
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1794
in self._transform._tree.extras())
1795
possible_extras.update(self._transform._new_contents)
1796
possible_extras.update(self._transform._removed_id)
1797
for trans_id in possible_extras:
1798
if self._transform.final_file_id(trans_id) is None:
1799
yield self._final_paths._determine_path(trans_id)
1801
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1802
yield_parents=False):
1803
for trans_id, parent_file_id in ordered_entries:
1804
file_id = self._transform.final_file_id(trans_id)
1807
if (specific_file_ids is not None
1808
and file_id not in specific_file_ids):
1811
kind = self._transform.final_kind(trans_id)
1813
kind = self._transform._tree.stored_kind(file_id)
1814
new_entry = inventory.make_entry(
1816
self._transform.final_name(trans_id),
1817
parent_file_id, file_id)
1818
yield new_entry, trans_id
1820
def _list_files_by_dir(self):
1821
todo = [ROOT_PARENT]
1823
while len(todo) > 0:
1825
parent_file_id = self._transform.final_file_id(parent)
1826
children = list(self._all_children(parent))
1827
paths = dict(zip(children, self._final_paths.get_paths(children)))
1828
children.sort(key=paths.get)
1829
todo.extend(reversed(children))
1830
for trans_id in children:
1831
ordered_ids.append((trans_id, parent_file_id))
1834
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1835
# This may not be a maximally efficient implementation, but it is
1836
# reasonably straightforward. An implementation that grafts the
1837
# TreeTransform changes onto the tree's iter_entries_by_dir results
1838
# might be more efficient, but requires tricky inferences about stack
1840
ordered_ids = self._list_files_by_dir()
1841
for entry, trans_id in self._make_inv_entries(ordered_ids,
1842
specific_file_ids, yield_parents=yield_parents):
1843
yield unicode(self._final_paths.get_path(trans_id)), entry
1845
def _iter_entries_for_dir(self, dir_path):
1846
"""Return path, entry for items in a directory without recursing down."""
1847
dir_file_id = self.path2id(dir_path)
1849
for file_id in self.iter_children(dir_file_id):
1850
trans_id = self._transform.trans_id_file_id(file_id)
1851
ordered_ids.append((trans_id, file_id))
1852
for entry, trans_id in self._make_inv_entries(ordered_ids):
1853
yield unicode(self._final_paths.get_path(trans_id)), entry
1855
def list_files(self, include_root=False, from_dir=None, recursive=True):
1856
"""See WorkingTree.list_files."""
1857
# XXX This should behave like WorkingTree.list_files, but is really
1858
# more like RevisionTree.list_files.
1862
prefix = from_dir + '/'
1863
entries = self.iter_entries_by_dir()
1864
for path, entry in entries:
1865
if entry.name == '' and not include_root:
1868
if not path.startswith(prefix):
1870
path = path[len(prefix):]
1871
yield path, 'V', entry.kind, entry.file_id, entry
1873
if from_dir is None and include_root is True:
1874
root_entry = inventory.make_entry('directory', '',
1875
ROOT_PARENT, self.get_root_id())
1876
yield '', 'V', 'directory', root_entry.file_id, root_entry
1877
entries = self._iter_entries_for_dir(from_dir or '')
1878
for path, entry in entries:
1879
yield path, 'V', entry.kind, entry.file_id, entry
1881
def kind(self, file_id):
1882
trans_id = self._transform.trans_id_file_id(file_id)
1883
return self._transform.final_kind(trans_id)
1885
def stored_kind(self, file_id):
1886
trans_id = self._transform.trans_id_file_id(file_id)
1888
return self._transform._new_contents[trans_id]
1890
return self._transform._tree.stored_kind(file_id)
1892
def get_file_mtime(self, file_id, path=None):
1893
"""See Tree.get_file_mtime"""
1894
if not self._content_change(file_id):
1895
return self._transform._tree.get_file_mtime(file_id)
1896
return self._stat_limbo_file(file_id).st_mtime
1898
def _file_size(self, entry, stat_value):
1899
return self.get_file_size(entry.file_id)
1901
def get_file_size(self, file_id):
1902
"""See Tree.get_file_size"""
1903
if self.kind(file_id) == 'file':
1904
return self._transform._tree.get_file_size(file_id)
1908
def get_file_sha1(self, file_id, path=None, stat_value=None):
1909
trans_id = self._transform.trans_id_file_id(file_id)
1910
kind = self._transform._new_contents.get(trans_id)
1912
return self._transform._tree.get_file_sha1(file_id)
1914
fileobj = self.get_file(file_id)
1916
return sha_file(fileobj)
1920
def is_executable(self, file_id, path=None):
1923
trans_id = self._transform.trans_id_file_id(file_id)
1925
return self._transform._new_executability[trans_id]
1928
return self._transform._tree.is_executable(file_id, path)
1930
if e.errno == errno.ENOENT:
1933
except errors.NoSuchId:
1936
def path_content_summary(self, path):
1937
trans_id = self._path2trans_id(path)
1938
tt = self._transform
1939
tree_path = tt._tree_id_paths.get(trans_id)
1940
kind = tt._new_contents.get(trans_id)
1942
if tree_path is None or trans_id in tt._removed_contents:
1943
return 'missing', None, None, None
1944
summary = tt._tree.path_content_summary(tree_path)
1945
kind, size, executable, link_or_sha1 = summary
1948
limbo_name = tt._limbo_name(trans_id)
1949
if trans_id in tt._new_reference_revision:
1950
kind = 'tree-reference'
1952
statval = os.lstat(limbo_name)
1953
size = statval.st_size
1954
if not supports_executable():
1957
executable = statval.st_mode & S_IEXEC
1961
if kind == 'symlink':
1962
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1963
if supports_executable():
1964
executable = tt._new_executability.get(trans_id, executable)
1965
return kind, size, executable, link_or_sha1
1967
def iter_changes(self, from_tree, include_unchanged=False,
1968
specific_files=None, pb=None, extra_trees=None,
1969
require_versioned=True, want_unversioned=False):
1970
"""See InterTree.iter_changes.
1972
This has a fast path that is only used when the from_tree matches
1973
the transform tree, and no fancy options are supplied.
1975
if (from_tree is not self._transform._tree or include_unchanged or
1976
specific_files or want_unversioned):
1977
return tree.InterTree(from_tree, self).iter_changes(
1978
include_unchanged=include_unchanged,
1979
specific_files=specific_files,
1981
extra_trees=extra_trees,
1982
require_versioned=require_versioned,
1983
want_unversioned=want_unversioned)
1984
if want_unversioned:
1985
raise ValueError('want_unversioned is not supported')
1986
return self._transform.iter_changes()
1988
def get_file(self, file_id, path=None):
1989
"""See Tree.get_file"""
1990
if not self._content_change(file_id):
1991
return self._transform._tree.get_file(file_id, path)
1992
trans_id = self._transform.trans_id_file_id(file_id)
1993
name = self._transform._limbo_name(trans_id)
1994
return open(name, 'rb')
1996
def get_file_with_stat(self, file_id, path=None):
1997
return self.get_file(file_id, path), None
1999
def annotate_iter(self, file_id,
2000
default_revision=_mod_revision.CURRENT_REVISION):
2001
changes = self._iter_changes_cache.get(file_id)
2005
changed_content, versioned, kind = (changes[2], changes[3],
2009
get_old = (kind[0] == 'file' and versioned[0])
2011
old_annotation = self._transform._tree.annotate_iter(file_id,
2012
default_revision=default_revision)
2016
return old_annotation
2017
if not changed_content:
2018
return old_annotation
2019
# TODO: This is doing something similar to what WT.annotate_iter is
2020
# doing, however it fails slightly because it doesn't know what
2021
# the *other* revision_id is, so it doesn't know how to give the
2022
# other as the origin for some lines, they all get
2023
# 'default_revision'
2024
# It would be nice to be able to use the new Annotator based
2025
# approach, as well.
2026
return annotate.reannotate([old_annotation],
2027
self.get_file(file_id).readlines(),
2030
def get_symlink_target(self, file_id):
2031
"""See Tree.get_symlink_target"""
2032
if not self._content_change(file_id):
2033
return self._transform._tree.get_symlink_target(file_id)
2034
trans_id = self._transform.trans_id_file_id(file_id)
2035
name = self._transform._limbo_name(trans_id)
2036
return osutils.readlink(name)
2038
def walkdirs(self, prefix=''):
2039
pending = [self._transform.root]
2040
while len(pending) > 0:
2041
parent_id = pending.pop()
2044
prefix = prefix.rstrip('/')
2045
parent_path = self._final_paths.get_path(parent_id)
2046
parent_file_id = self._transform.final_file_id(parent_id)
2047
for child_id in self._all_children(parent_id):
2048
path_from_root = self._final_paths.get_path(child_id)
2049
basename = self._transform.final_name(child_id)
2050
file_id = self._transform.final_file_id(child_id)
2052
kind = self._transform.final_kind(child_id)
2053
versioned_kind = kind
2056
versioned_kind = self._transform._tree.stored_kind(file_id)
2057
if versioned_kind == 'directory':
2058
subdirs.append(child_id)
2059
children.append((path_from_root, basename, kind, None,
2060
file_id, versioned_kind))
2062
if parent_path.startswith(prefix):
2063
yield (parent_path, parent_file_id), children
2064
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2067
def get_parent_ids(self):
2068
return self._parent_ids
2070
def set_parent_ids(self, parent_ids):
2071
self._parent_ids = parent_ids
2073
def get_revision_tree(self, revision_id):
2074
return self._transform._tree.get_revision_tree(revision_id)
2077
def joinpath(parent, child):
2078
"""Join tree-relative paths, handling the tree root specially"""
2079
if parent is None or parent == "":
2082
return pathjoin(parent, child)
2085
class FinalPaths(object):
2086
"""Make path calculation cheap by memoizing paths.
2088
The underlying tree must not be manipulated between calls, or else
2089
the results will likely be incorrect.
2091
def __init__(self, transform):
2092
object.__init__(self)
2093
self._known_paths = {}
2094
self.transform = transform
2096
def _determine_path(self, trans_id):
2097
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2099
name = self.transform.final_name(trans_id)
2100
parent_id = self.transform.final_parent(trans_id)
2101
if parent_id == self.transform.root:
2104
return pathjoin(self.get_path(parent_id), name)
2106
def get_path(self, trans_id):
2107
"""Find the final path associated with a trans_id"""
2108
if trans_id not in self._known_paths:
2109
self._known_paths[trans_id] = self._determine_path(trans_id)
2110
return self._known_paths[trans_id]
2112
def get_paths(self, trans_ids):
2113
return [(self.get_path(t), t) for t in trans_ids]
2117
def topology_sorted_ids(tree):
2118
"""Determine the topological order of the ids in a tree"""
2119
file_ids = list(tree)
2120
file_ids.sort(key=tree.id2path)
2124
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2125
delta_from_tree=False):
2126
"""Create working tree for a branch, using a TreeTransform.
2128
This function should be used on empty trees, having a tree root at most.
2129
(see merge and revert functionality for working with existing trees)
2131
Existing files are handled like so:
2133
- Existing bzrdirs take precedence over creating new items. They are
2134
created as '%s.diverted' % name.
2135
- Otherwise, if the content on disk matches the content we are building,
2136
it is silently replaced.
2137
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2139
:param tree: The tree to convert wt into a copy of
2140
:param wt: The working tree that files will be placed into
2141
:param accelerator_tree: A tree which can be used for retrieving file
2142
contents more quickly than tree itself, i.e. a workingtree. tree
2143
will be used for cases where accelerator_tree's content is different.
2144
:param hardlink: If true, hard-link files to accelerator_tree, where
2145
possible. accelerator_tree must implement abspath, i.e. be a
2147
:param delta_from_tree: If true, build_tree may use the input Tree to
2148
generate the inventory delta.
2150
wt.lock_tree_write()
2154
if accelerator_tree is not None:
2155
accelerator_tree.lock_read()
2157
return _build_tree(tree, wt, accelerator_tree, hardlink,
2160
if accelerator_tree is not None:
2161
accelerator_tree.unlock()
2168
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2169
"""See build_tree."""
2170
for num, _unused in enumerate(wt.all_file_ids()):
2171
if num > 0: # more than just a root
2172
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2173
existing_files = set()
2174
for dir, files in wt.walkdirs():
2175
existing_files.update(f[0] for f in files)
2177
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2178
pp = ProgressPhase("Build phase", 2, top_pb)
2179
if tree.inventory.root is not None:
2180
# This is kind of a hack: we should be altering the root
2181
# as part of the regular tree shape diff logic.
2182
# The conditional test here is to avoid doing an
2183
# expensive operation (flush) every time the root id
2184
# is set within the tree, nor setting the root and thus
2185
# marking the tree as dirty, because we use two different
2186
# idioms here: tree interfaces and inventory interfaces.
2187
if wt.get_root_id() != tree.get_root_id():
2188
wt.set_root_id(tree.get_root_id())
2190
tt = TreeTransform(wt)
2194
file_trans_id[wt.get_root_id()] = \
2195
tt.trans_id_tree_file_id(wt.get_root_id())
2196
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2198
deferred_contents = []
2200
total = len(tree.inventory)
2202
precomputed_delta = []
2204
precomputed_delta = None
2205
for num, (tree_path, entry) in \
2206
enumerate(tree.inventory.iter_entries_by_dir()):
2207
pb.update("Building tree", num - len(deferred_contents), total)
2208
if entry.parent_id is None:
2211
file_id = entry.file_id
2213
precomputed_delta.append((None, tree_path, file_id, entry))
2214
if tree_path in existing_files:
2215
target_path = wt.abspath(tree_path)
2216
kind = file_kind(target_path)
2217
if kind == "directory":
2219
bzrdir.BzrDir.open(target_path)
2220
except errors.NotBranchError:
2224
if (file_id not in divert and
2225
_content_match(tree, entry, file_id, kind,
2227
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2228
if kind == 'directory':
2230
parent_id = file_trans_id[entry.parent_id]
2231
if entry.kind == 'file':
2232
# We *almost* replicate new_by_entry, so that we can defer
2233
# getting the file text, and get them all at once.
2234
trans_id = tt.create_path(entry.name, parent_id)
2235
file_trans_id[file_id] = trans_id
2236
tt.version_file(file_id, trans_id)
2237
executable = tree.is_executable(file_id, tree_path)
2239
tt.set_executability(executable, trans_id)
2240
trans_data = (trans_id, tree_path)
2241
deferred_contents.append((file_id, trans_data))
2243
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2246
new_trans_id = file_trans_id[file_id]
2247
old_parent = tt.trans_id_tree_path(tree_path)
2248
_reparent_children(tt, old_parent, new_trans_id)
2249
offset = num + 1 - len(deferred_contents)
2250
_create_files(tt, tree, deferred_contents, pb, offset,
2251
accelerator_tree, hardlink)
2255
divert_trans = set(file_trans_id[f] for f in divert)
2256
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2257
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2258
if len(raw_conflicts) > 0:
2259
precomputed_delta = None
2260
conflicts = cook_conflicts(raw_conflicts, tt)
2261
for conflict in conflicts:
2264
wt.add_conflicts(conflicts)
2265
except errors.UnsupportedOperation:
2267
result = tt.apply(no_conflicts=True,
2268
precomputed_delta=precomputed_delta)
2275
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2277
total = len(desired_files) + offset
2279
if accelerator_tree is None:
2280
new_desired_files = desired_files
2282
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2283
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2284
in iter if not (c or e[0] != e[1]))
2285
new_desired_files = []
2287
for file_id, (trans_id, tree_path) in desired_files:
2288
accelerator_path = unchanged.get(file_id)
2289
if accelerator_path is None:
2290
new_desired_files.append((file_id, (trans_id, tree_path)))
2292
pb.update('Adding file contents', count + offset, total)
2294
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2297
contents = accelerator_tree.get_file(file_id, accelerator_path)
2298
if wt.supports_content_filtering():
2299
filters = wt._content_filter_stack(tree_path)
2300
contents = filtered_output_bytes(contents, filters,
2301
ContentFilterContext(tree_path, tree))
2303
tt.create_file(contents, trans_id)
2307
except AttributeError:
2308
# after filtering, contents may no longer be file-like
2312
for count, ((trans_id, tree_path), contents) in enumerate(
2313
tree.iter_files_bytes(new_desired_files)):
2314
if wt.supports_content_filtering():
2315
filters = wt._content_filter_stack(tree_path)
2316
contents = filtered_output_bytes(contents, filters,
2317
ContentFilterContext(tree_path, tree))
2318
tt.create_file(contents, trans_id)
2319
pb.update('Adding file contents', count + offset, total)
2322
def _reparent_children(tt, old_parent, new_parent):
2323
for child in tt.iter_tree_children(old_parent):
2324
tt.adjust_path(tt.final_name(child), new_parent, child)
2326
def _reparent_transform_children(tt, old_parent, new_parent):
2327
by_parent = tt.by_parent()
2328
for child in by_parent[old_parent]:
2329
tt.adjust_path(tt.final_name(child), new_parent, child)
2330
return by_parent[old_parent]
2332
def _content_match(tree, entry, file_id, kind, target_path):
2333
if entry.kind != kind:
2335
if entry.kind == "directory":
2337
if entry.kind == "file":
2338
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2340
elif entry.kind == "symlink":
2341
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2346
def resolve_checkout(tt, conflicts, divert):
2347
new_conflicts = set()
2348
for c_type, conflict in ((c[0], c) for c in conflicts):
2349
# Anything but a 'duplicate' would indicate programmer error
2350
if c_type != 'duplicate':
2351
raise AssertionError(c_type)
2352
# Now figure out which is new and which is old
2353
if tt.new_contents(conflict[1]):
2354
new_file = conflict[1]
2355
old_file = conflict[2]
2357
new_file = conflict[2]
2358
old_file = conflict[1]
2360
# We should only get here if the conflict wasn't completely
2362
final_parent = tt.final_parent(old_file)
2363
if new_file in divert:
2364
new_name = tt.final_name(old_file)+'.diverted'
2365
tt.adjust_path(new_name, final_parent, new_file)
2366
new_conflicts.add((c_type, 'Diverted to',
2367
new_file, old_file))
2369
new_name = tt.final_name(old_file)+'.moved'
2370
tt.adjust_path(new_name, final_parent, old_file)
2371
new_conflicts.add((c_type, 'Moved existing file to',
2372
old_file, new_file))
2373
return new_conflicts
2376
def new_by_entry(tt, entry, parent_id, tree):
2377
"""Create a new file according to its inventory entry"""
2381
contents = tree.get_file(entry.file_id).readlines()
2382
executable = tree.is_executable(entry.file_id)
2383
return tt.new_file(name, parent_id, contents, entry.file_id,
2385
elif kind in ('directory', 'tree-reference'):
2386
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2387
if kind == 'tree-reference':
2388
tt.set_tree_reference(entry.reference_revision, trans_id)
2390
elif kind == 'symlink':
2391
target = tree.get_symlink_target(entry.file_id)
2392
return tt.new_symlink(name, parent_id, target, entry.file_id)
2394
raise errors.BadFileKindError(name, kind)
2397
@deprecated_function(deprecated_in((1, 9, 0)))
2398
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2399
"""Create new file contents according to an inventory entry.
2401
DEPRECATED. Use create_from_tree instead.
2403
if entry.kind == "file":
2405
lines = tree.get_file(entry.file_id).readlines()
2406
tt.create_file(lines, trans_id, mode_id=mode_id)
2407
elif entry.kind == "symlink":
2408
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2409
elif entry.kind == "directory":
2410
tt.create_directory(trans_id)
2413
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2414
"""Create new file contents according to tree contents."""
2415
kind = tree.kind(file_id)
2416
if kind == 'directory':
2417
tt.create_directory(trans_id)
2418
elif kind == "file":
2420
tree_file = tree.get_file(file_id)
2422
bytes = tree_file.readlines()
2425
tt.create_file(bytes, trans_id)
2426
elif kind == "symlink":
2427
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2429
raise AssertionError('Unknown kind %r' % kind)
2432
def create_entry_executability(tt, entry, trans_id):
2433
"""Set the executability of a trans_id according to an inventory entry"""
2434
if entry.kind == "file":
2435
tt.set_executability(entry.executable, trans_id)
2438
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2439
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2442
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2443
"""Produce a backup-style name that appears to be available"""
2447
yield "%s.~%d~" % (name, counter)
2449
for new_name in name_gen():
2450
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2454
def _entry_changes(file_id, entry, working_tree):
2455
"""Determine in which ways the inventory entry has changed.
2457
Returns booleans: has_contents, content_mod, meta_mod
2458
has_contents means there are currently contents, but they differ
2459
contents_mod means contents need to be modified
2460
meta_mod means the metadata needs to be modified
2462
cur_entry = working_tree.inventory[file_id]
2464
working_kind = working_tree.kind(file_id)
2467
has_contents = False
2470
if has_contents is True:
2471
if entry.kind != working_kind:
2472
contents_mod, meta_mod = True, False
2474
cur_entry._read_tree_state(working_tree.id2path(file_id),
2476
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2477
cur_entry._forget_tree_state()
2478
return has_contents, contents_mod, meta_mod
2481
def revert(working_tree, target_tree, filenames, backups=False,
2482
pb=DummyProgress(), change_reporter=None):
2483
"""Revert a working tree's contents to those of a target tree."""
2484
target_tree.lock_read()
2485
tt = TreeTransform(working_tree, pb)
2487
pp = ProgressPhase("Revert phase", 3, pb)
2488
conflicts, merge_modified = _prepare_revert_transform(
2489
working_tree, target_tree, tt, filenames, backups, pp)
2491
change_reporter = delta._ChangeReporter(
2492
unversioned_filter=working_tree.is_ignored)
2493
delta.report_changes(tt.iter_changes(), change_reporter)
2494
for conflict in conflicts:
2498
working_tree.set_merge_modified(merge_modified)
2500
target_tree.unlock()
2506
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2507
backups, pp, basis_tree=None,
2508
merge_modified=None):
2510
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2512
if merge_modified is None:
2513
merge_modified = working_tree.merge_modified()
2514
merge_modified = _alter_files(working_tree, target_tree, tt,
2515
child_pb, filenames, backups,
2516
merge_modified, basis_tree)
2520
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2522
raw_conflicts = resolve_conflicts(tt, child_pb,
2523
lambda t, c: conflict_pass(t, c, target_tree))
2526
conflicts = cook_conflicts(raw_conflicts, tt)
2527
return conflicts, merge_modified
2530
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2531
backups, merge_modified, basis_tree=None):
2532
if basis_tree is not None:
2533
basis_tree.lock_read()
2534
change_list = target_tree.iter_changes(working_tree,
2535
specific_files=specific_files, pb=pb)
2536
if target_tree.get_root_id() is None:
2542
for id_num, (file_id, path, changed_content, versioned, parent, name,
2543
kind, executable) in enumerate(change_list):
2544
if skip_root and file_id[0] is not None and parent[0] is None:
2546
trans_id = tt.trans_id_file_id(file_id)
2549
keep_content = False
2550
if kind[0] == 'file' and (backups or kind[1] is None):
2551
wt_sha1 = working_tree.get_file_sha1(file_id)
2552
if merge_modified.get(file_id) != wt_sha1:
2553
# acquire the basis tree lazily to prevent the
2554
# expense of accessing it when it's not needed ?
2555
# (Guessing, RBC, 200702)
2556
if basis_tree is None:
2557
basis_tree = working_tree.basis_tree()
2558
basis_tree.lock_read()
2559
if file_id in basis_tree:
2560
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2562
elif kind[1] is None and not versioned[1]:
2564
if kind[0] is not None:
2565
if not keep_content:
2566
tt.delete_contents(trans_id)
2567
elif kind[1] is not None:
2568
parent_trans_id = tt.trans_id_file_id(parent[0])
2569
by_parent = tt.by_parent()
2570
backup_name = _get_backup_name(name[0], by_parent,
2571
parent_trans_id, tt)
2572
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2573
new_trans_id = tt.create_path(name[0], parent_trans_id)
2574
if versioned == (True, True):
2575
tt.unversion_file(trans_id)
2576
tt.version_file(file_id, new_trans_id)
2577
# New contents should have the same unix perms as old
2580
trans_id = new_trans_id
2581
if kind[1] in ('directory', 'tree-reference'):
2582
tt.create_directory(trans_id)
2583
if kind[1] == 'tree-reference':
2584
revision = target_tree.get_reference_revision(file_id,
2586
tt.set_tree_reference(revision, trans_id)
2587
elif kind[1] == 'symlink':
2588
tt.create_symlink(target_tree.get_symlink_target(file_id),
2590
elif kind[1] == 'file':
2591
deferred_files.append((file_id, (trans_id, mode_id)))
2592
if basis_tree is None:
2593
basis_tree = working_tree.basis_tree()
2594
basis_tree.lock_read()
2595
new_sha1 = target_tree.get_file_sha1(file_id)
2596
if (file_id in basis_tree and new_sha1 ==
2597
basis_tree.get_file_sha1(file_id)):
2598
if file_id in merge_modified:
2599
del merge_modified[file_id]
2601
merge_modified[file_id] = new_sha1
2603
# preserve the execute bit when backing up
2604
if keep_content and executable[0] == executable[1]:
2605
tt.set_executability(executable[1], trans_id)
2606
elif kind[1] is not None:
2607
raise AssertionError(kind[1])
2608
if versioned == (False, True):
2609
tt.version_file(file_id, trans_id)
2610
if versioned == (True, False):
2611
tt.unversion_file(trans_id)
2612
if (name[1] is not None and
2613
(name[0] != name[1] or parent[0] != parent[1])):
2614
if name[1] == '' and parent[1] is None:
2615
parent_trans = ROOT_PARENT
2617
parent_trans = tt.trans_id_file_id(parent[1])
2618
tt.adjust_path(name[1], parent_trans, trans_id)
2619
if executable[0] != executable[1] and kind[1] == "file":
2620
tt.set_executability(executable[1], trans_id)
2621
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2623
tt.create_file(bytes, trans_id, mode_id)
2625
if basis_tree is not None:
2627
return merge_modified
2630
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2631
"""Make many conflict-resolution attempts, but die if they fail"""
2632
if pass_func is None:
2633
pass_func = conflict_pass
2634
new_conflicts = set()
2637
pb.update('Resolution pass', n+1, 10)
2638
conflicts = tt.find_conflicts()
2639
if len(conflicts) == 0:
2640
return new_conflicts
2641
new_conflicts.update(pass_func(tt, conflicts))
2642
raise MalformedTransform(conflicts=conflicts)
2647
def conflict_pass(tt, conflicts, path_tree=None):
2648
"""Resolve some classes of conflicts.
2650
:param tt: The transform to resolve conflicts in
2651
:param conflicts: The conflicts to resolve
2652
:param path_tree: A Tree to get supplemental paths from
2654
new_conflicts = set()
2655
for c_type, conflict in ((c[0], c) for c in conflicts):
2656
if c_type == 'duplicate id':
2657
tt.unversion_file(conflict[1])
2658
new_conflicts.add((c_type, 'Unversioned existing file',
2659
conflict[1], conflict[2], ))
2660
elif c_type == 'duplicate':
2661
# files that were renamed take precedence
2662
final_parent = tt.final_parent(conflict[1])
2663
if tt.path_changed(conflict[1]):
2664
existing_file, new_file = conflict[2], conflict[1]
2666
existing_file, new_file = conflict[1], conflict[2]
2667
new_name = tt.final_name(existing_file)+'.moved'
2668
tt.adjust_path(new_name, final_parent, existing_file)
2669
new_conflicts.add((c_type, 'Moved existing file to',
2670
existing_file, new_file))
2671
elif c_type == 'parent loop':
2672
# break the loop by undoing one of the ops that caused the loop
2674
while not tt.path_changed(cur):
2675
cur = tt.final_parent(cur)
2676
new_conflicts.add((c_type, 'Cancelled move', cur,
2677
tt.final_parent(cur),))
2678
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2680
elif c_type == 'missing parent':
2681
trans_id = conflict[1]
2683
tt.cancel_deletion(trans_id)
2684
new_conflicts.add(('deleting parent', 'Not deleting',
2689
tt.final_name(trans_id)
2691
if path_tree is not None:
2692
file_id = tt.final_file_id(trans_id)
2694
file_id = tt.inactive_file_id(trans_id)
2695
entry = path_tree.inventory[file_id]
2696
# special-case the other tree root (move its
2697
# children to current root)
2698
if entry.parent_id is None:
2700
moved = _reparent_transform_children(
2701
tt, trans_id, tt.root)
2703
new_conflicts.add((c_type, 'Moved to root',
2706
parent_trans_id = tt.trans_id_file_id(
2708
tt.adjust_path(entry.name, parent_trans_id,
2711
tt.create_directory(trans_id)
2712
new_conflicts.add((c_type, 'Created directory', trans_id))
2713
elif c_type == 'unversioned parent':
2714
file_id = tt.inactive_file_id(conflict[1])
2715
# special-case the other tree root (move its children instead)
2716
if path_tree and file_id in path_tree:
2717
if path_tree.inventory[file_id].parent_id is None:
2719
tt.version_file(file_id, conflict[1])
2720
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2721
elif c_type == 'non-directory parent':
2722
parent_id = conflict[1]
2723
parent_parent = tt.final_parent(parent_id)
2724
parent_name = tt.final_name(parent_id)
2725
parent_file_id = tt.final_file_id(parent_id)
2726
new_parent_id = tt.new_directory(parent_name + '.new',
2727
parent_parent, parent_file_id)
2728
_reparent_transform_children(tt, parent_id, new_parent_id)
2729
if parent_file_id is not None:
2730
tt.unversion_file(parent_id)
2731
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2732
elif c_type == 'versioning no contents':
2733
tt.cancel_versioning(conflict[1])
2734
return new_conflicts
2737
def cook_conflicts(raw_conflicts, tt):
2738
"""Generate a list of cooked conflicts, sorted by file path"""
2739
from bzrlib.conflicts import Conflict
2740
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2741
return sorted(conflict_iter, key=Conflict.sort_key)
2744
def iter_cook_conflicts(raw_conflicts, tt):
2745
from bzrlib.conflicts import Conflict
2747
for conflict in raw_conflicts:
2748
c_type = conflict[0]
2749
action = conflict[1]
2750
modified_path = fp.get_path(conflict[2])
2751
modified_id = tt.final_file_id(conflict[2])
2752
if len(conflict) == 3:
2753
yield Conflict.factory(c_type, action=action, path=modified_path,
2754
file_id=modified_id)
2757
conflicting_path = fp.get_path(conflict[3])
2758
conflicting_id = tt.final_file_id(conflict[3])
2759
yield Conflict.factory(c_type, action=action, path=modified_path,
2760
file_id=modified_id,
2761
conflict_path=conflicting_path,
2762
conflict_file_id=conflicting_id)
2765
class _FileMover(object):
2766
"""Moves and deletes files for TreeTransform, tracking operations"""
2769
self.past_renames = []
2770
self.pending_deletions = []
2772
def rename(self, from_, to):
2773
"""Rename a file from one path to another. Functions like os.rename"""
2775
os.rename(from_, to)
2777
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2778
raise errors.FileExists(to, str(e))
2780
self.past_renames.append((from_, to))
2782
def pre_delete(self, from_, to):
2783
"""Rename a file out of the way and mark it for deletion.
2785
Unlike os.unlink, this works equally well for files and directories.
2786
:param from_: The current file path
2787
:param to: A temporary path for the file
2789
self.rename(from_, to)
2790
self.pending_deletions.append(to)
2793
"""Reverse all renames that have been performed"""
2794
for from_, to in reversed(self.past_renames):
2795
os.rename(to, from_)
2796
# after rollback, don't reuse _FileMover
2798
pending_deletions = None
2800
def apply_deletions(self):
2801
"""Apply all marked deletions"""
2802
for path in self.pending_deletions:
2804
# after apply_deletions, don't reuse _FileMover
2806
pending_deletions = None
added
removed
bzrlib/transform.py
