1
# Copyright (C) 2006-2010 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
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
33
revision as _mod_revision,
37
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
38
ReusingTransform, NotVersionedError, CantMoveRoot,
39
ExistingLimbo, ImmortalLimbo, NoFinalPath,
41
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
42
from bzrlib.inventory import InventoryEntry
43
from bzrlib.osutils import (
53
from bzrlib.progress import ProgressPhase
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, warning
59
from bzrlib import tree
61
import bzrlib.urlutils as urlutils
64
ROOT_PARENT = "root-parent"
67
def unique_add(map, key, value):
69
raise DuplicateKey(key=key)
73
class _TransformResults(object):
74
def __init__(self, modified_paths, rename_count):
76
self.modified_paths = modified_paths
77
self.rename_count = rename_count
80
class TreeTransformBase(object):
81
"""The base class for TreeTransform and its kin."""
83
def __init__(self, tree, pb=None,
87
:param tree: The tree that will be transformed, but not necessarily
90
:param case_sensitive: If True, the target of the transform is
91
case sensitive, not just case preserving.
96
# mapping of trans_id -> new basename
98
# mapping of trans_id -> new parent trans_id
100
# mapping of trans_id with new contents -> new file_kind
101
self._new_contents = {}
102
# Set of trans_ids whose contents will be removed
103
self._removed_contents = set()
104
# Mapping of trans_id -> new execute-bit value
105
self._new_executability = {}
106
# Mapping of trans_id -> new tree-reference value
107
self._new_reference_revision = {}
108
# Mapping of trans_id -> new file_id
110
# Mapping of old file-id -> trans_id
111
self._non_present_ids = {}
112
# Mapping of new file_id -> trans_id
114
# Set of trans_ids that will be removed
115
self._removed_id = set()
116
# Mapping of path in old tree -> trans_id
117
self._tree_path_ids = {}
118
# Mapping trans_id -> path in old tree
119
self._tree_id_paths = {}
120
# The trans_id that will be used as the tree root
121
root_id = tree.get_root_id()
122
if root_id is not None:
123
self._new_root = self.trans_id_tree_file_id(root_id)
125
self._new_root = None
126
# Indictor of whether the transform has been applied
130
# Whether the target is case sensitive
131
self._case_sensitive_target = case_sensitive
132
# A counter of how many files have been renamed
133
self.rename_count = 0
136
"""Release the working tree lock, if held.
138
This is required if apply has not been invoked, but can be invoked
141
if self._tree is None:
146
def __get_root(self):
147
return self._new_root
149
root = property(__get_root)
151
def _assign_id(self):
152
"""Produce a new tranform id"""
153
new_id = "new-%s" % self._id_number
157
def create_path(self, name, parent):
158
"""Assign a transaction id to a new path"""
159
trans_id = self._assign_id()
160
unique_add(self._new_name, trans_id, name)
161
unique_add(self._new_parent, trans_id, parent)
164
def adjust_path(self, name, parent, trans_id):
165
"""Change the path that is assigned to a transaction id."""
167
raise ValueError("Parent trans-id may not be None")
168
if trans_id == self._new_root:
170
self._new_name[trans_id] = name
171
self._new_parent[trans_id] = parent
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 fixup_new_roots(self):
206
"""Reinterpret requests to change the root directory
208
Instead of creating a root directory, or moving an existing directory,
209
all the attributes and children of the new root are applied to the
210
existing root directory.
212
This means that the old root trans-id becomes obsolete, so it is
213
recommended only to invoke this after the root trans-id has become
216
new_roots = [k for k, v in self._new_parent.iteritems() if v is
218
if len(new_roots) < 1:
220
if len(new_roots) != 1:
221
raise ValueError('A tree cannot have two roots!')
222
if self._new_root is None:
223
self._new_root = new_roots[0]
225
old_new_root = new_roots[0]
226
# TODO: What to do if a old_new_root is present, but self._new_root is
227
# not listed as being removed? This code explicitly unversions
228
# the old root and versions it with the new file_id. Though that
229
# seems like an incomplete delta
231
# unversion the new root's directory.
232
file_id = self.final_file_id(old_new_root)
233
if old_new_root in self._new_id:
234
self.cancel_versioning(old_new_root)
236
self.unversion_file(old_new_root)
237
# if, at this stage, root still has an old file_id, zap it so we can
238
# stick a new one in.
239
if (self.tree_file_id(self._new_root) is not None and
240
self._new_root not in self._removed_id):
241
self.unversion_file(self._new_root)
242
self.version_file(file_id, self._new_root)
244
# Now move children of new root into old root directory.
245
# Ensure all children are registered with the transaction, but don't
246
# use directly-- some tree children have new parents
247
list(self.iter_tree_children(old_new_root))
248
# Move all children of new root into old root directory.
249
for child in self.by_parent().get(old_new_root, []):
250
self.adjust_path(self.final_name(child), self._new_root, child)
252
# Ensure old_new_root has no directory.
253
if old_new_root in self._new_contents:
254
self.cancel_creation(old_new_root)
256
self.delete_contents(old_new_root)
258
# prevent deletion of root directory.
259
if self._new_root in self._removed_contents:
260
self.cancel_deletion(self._new_root)
262
# destroy path info for old_new_root.
263
del self._new_parent[old_new_root]
264
del self._new_name[old_new_root]
266
def trans_id_tree_file_id(self, inventory_id):
267
"""Determine the transaction id of a working tree file.
269
This reflects only files that already exist, not ones that will be
270
added by transactions.
272
if inventory_id is None:
273
raise ValueError('None is not a valid file id')
274
path = self._tree.id2path(inventory_id)
275
return self.trans_id_tree_path(path)
277
def trans_id_file_id(self, file_id):
278
"""Determine or set the transaction id associated with a file ID.
279
A new id is only created for file_ids that were never present. If
280
a transaction has been unversioned, it is deliberately still returned.
281
(this will likely lead to an unversioned parent conflict.)
284
raise ValueError('None is not a valid file id')
285
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
286
return self._r_new_id[file_id]
289
self._tree.iter_entries_by_dir([file_id]).next()
290
except StopIteration:
291
if file_id in self._non_present_ids:
292
return self._non_present_ids[file_id]
294
trans_id = self._assign_id()
295
self._non_present_ids[file_id] = trans_id
298
return self.trans_id_tree_file_id(file_id)
300
def trans_id_tree_path(self, path):
301
"""Determine (and maybe set) the transaction ID for a tree path."""
302
path = self.canonical_path(path)
303
if path not in self._tree_path_ids:
304
self._tree_path_ids[path] = self._assign_id()
305
self._tree_id_paths[self._tree_path_ids[path]] = path
306
return self._tree_path_ids[path]
308
def get_tree_parent(self, trans_id):
309
"""Determine id of the parent in the tree."""
310
path = self._tree_id_paths[trans_id]
313
return self.trans_id_tree_path(os.path.dirname(path))
315
def delete_contents(self, trans_id):
316
"""Schedule the contents of a path entry for deletion"""
317
# Ensure that the object exists in the WorkingTree, this will raise an
318
# exception if there is a problem
319
self.tree_kind(trans_id)
320
self._removed_contents.add(trans_id)
322
def cancel_deletion(self, trans_id):
323
"""Cancel a scheduled deletion"""
324
self._removed_contents.remove(trans_id)
326
def unversion_file(self, trans_id):
327
"""Schedule a path entry to become unversioned"""
328
self._removed_id.add(trans_id)
330
def delete_versioned(self, trans_id):
331
"""Delete and unversion a versioned file"""
332
self.delete_contents(trans_id)
333
self.unversion_file(trans_id)
335
def set_executability(self, executability, trans_id):
336
"""Schedule setting of the 'execute' bit
337
To unschedule, set to None
339
if executability is None:
340
del self._new_executability[trans_id]
342
unique_add(self._new_executability, trans_id, executability)
344
def set_tree_reference(self, revision_id, trans_id):
345
"""Set the reference associated with a directory"""
346
unique_add(self._new_reference_revision, trans_id, revision_id)
348
def version_file(self, file_id, trans_id):
349
"""Schedule a file to become versioned."""
352
unique_add(self._new_id, trans_id, file_id)
353
unique_add(self._r_new_id, file_id, trans_id)
355
def cancel_versioning(self, trans_id):
356
"""Undo a previous versioning of a file"""
357
file_id = self._new_id[trans_id]
358
del self._new_id[trans_id]
359
del self._r_new_id[file_id]
361
def new_paths(self, filesystem_only=False):
362
"""Determine the paths of all new and changed files.
364
:param filesystem_only: if True, only calculate values for files
365
that require renames or execute bit changes.
369
stale_ids = self._needs_rename.difference(self._new_name)
370
stale_ids.difference_update(self._new_parent)
371
stale_ids.difference_update(self._new_contents)
372
stale_ids.difference_update(self._new_id)
373
needs_rename = self._needs_rename.difference(stale_ids)
374
id_sets = (needs_rename, self._new_executability)
376
id_sets = (self._new_name, self._new_parent, self._new_contents,
377
self._new_id, self._new_executability)
378
for id_set in id_sets:
379
new_ids.update(id_set)
380
return sorted(FinalPaths(self).get_paths(new_ids))
382
def _inventory_altered(self):
383
"""Get the trans_ids and paths of files needing new inv entries."""
385
for id_set in [self._new_name, self._new_parent, self._new_id,
386
self._new_executability]:
387
new_ids.update(id_set)
388
changed_kind = set(self._removed_contents)
389
changed_kind.intersection_update(self._new_contents)
390
changed_kind.difference_update(new_ids)
391
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
393
new_ids.update(changed_kind)
394
return sorted(FinalPaths(self).get_paths(new_ids))
396
def final_kind(self, trans_id):
397
"""Determine the final file kind, after any changes applied.
399
Raises NoSuchFile if the file does not exist/has no contents.
400
(It is conceivable that a path would be created without the
401
corresponding contents insertion command)
403
if trans_id in self._new_contents:
404
return self._new_contents[trans_id]
405
elif trans_id in self._removed_contents:
406
raise NoSuchFile(None)
408
return self.tree_kind(trans_id)
410
def tree_file_id(self, trans_id):
411
"""Determine the file id associated with the trans_id in the tree"""
413
path = self._tree_id_paths[trans_id]
415
# the file is a new, unversioned file, or invalid trans_id
417
# the file is old; the old id is still valid
418
if self._new_root == trans_id:
419
return self._tree.get_root_id()
420
return self._tree.path2id(path)
422
def final_file_id(self, trans_id):
423
"""Determine the file id after any changes are applied, or None.
425
None indicates that the file will not be versioned after changes are
429
return self._new_id[trans_id]
431
if trans_id in self._removed_id:
433
return self.tree_file_id(trans_id)
435
def inactive_file_id(self, trans_id):
436
"""Return the inactive file_id associated with a transaction id.
437
That is, the one in the tree or in non_present_ids.
438
The file_id may actually be active, too.
440
file_id = self.tree_file_id(trans_id)
441
if file_id is not None:
443
for key, value in self._non_present_ids.iteritems():
444
if value == trans_id:
447
def final_parent(self, trans_id):
448
"""Determine the parent file_id, after any changes are applied.
450
ROOT_PARENT is returned for the tree root.
453
return self._new_parent[trans_id]
455
return self.get_tree_parent(trans_id)
457
def final_name(self, trans_id):
458
"""Determine the final filename, after all changes are applied."""
460
return self._new_name[trans_id]
463
return os.path.basename(self._tree_id_paths[trans_id])
465
raise NoFinalPath(trans_id, self)
468
"""Return a map of parent: children for known parents.
470
Only new paths and parents of tree files with assigned ids are used.
473
items = list(self._new_parent.iteritems())
474
items.extend((t, self.final_parent(t)) for t in
475
self._tree_id_paths.keys())
476
for trans_id, parent_id in items:
477
if parent_id not in by_parent:
478
by_parent[parent_id] = set()
479
by_parent[parent_id].add(trans_id)
482
def path_changed(self, trans_id):
483
"""Return True if a trans_id's path has changed."""
484
return (trans_id in self._new_name) or (trans_id in self._new_parent)
486
def new_contents(self, trans_id):
487
return (trans_id in self._new_contents)
489
def find_conflicts(self):
490
"""Find any violations of inventory or filesystem invariants"""
491
if self._done is True:
492
raise ReusingTransform()
494
# ensure all children of all existent parents are known
495
# all children of non-existent parents are known, by definition.
496
self._add_tree_children()
497
by_parent = self.by_parent()
498
conflicts.extend(self._unversioned_parents(by_parent))
499
conflicts.extend(self._parent_loops())
500
conflicts.extend(self._duplicate_entries(by_parent))
501
conflicts.extend(self._duplicate_ids())
502
conflicts.extend(self._parent_type_conflicts(by_parent))
503
conflicts.extend(self._improper_versioning())
504
conflicts.extend(self._executability_conflicts())
505
conflicts.extend(self._overwrite_conflicts())
508
def _check_malformed(self):
509
conflicts = self.find_conflicts()
510
if len(conflicts) != 0:
511
raise MalformedTransform(conflicts=conflicts)
513
def _add_tree_children(self):
514
"""Add all the children of all active parents to the known paths.
516
Active parents are those which gain children, and those which are
517
removed. This is a necessary first step in detecting conflicts.
519
parents = self.by_parent().keys()
520
parents.extend([t for t in self._removed_contents if
521
self.tree_kind(t) == 'directory'])
522
for trans_id in self._removed_id:
523
file_id = self.tree_file_id(trans_id)
524
if file_id is not None:
525
if self._tree.inventory[file_id].kind == 'directory':
526
parents.append(trans_id)
527
elif self.tree_kind(trans_id) == 'directory':
528
parents.append(trans_id)
530
for parent_id in parents:
531
# ensure that all children are registered with the transaction
532
list(self.iter_tree_children(parent_id))
534
def has_named_child(self, by_parent, parent_id, name):
536
children = by_parent[parent_id]
539
for child in children:
540
if self.final_name(child) == name:
543
path = self._tree_id_paths[parent_id]
546
childpath = joinpath(path, name)
547
child_id = self._tree_path_ids.get(childpath)
549
return lexists(self._tree.abspath(childpath))
551
if self.final_parent(child_id) != parent_id:
553
if child_id in self._removed_contents:
554
# XXX What about dangling file-ids?
559
def _parent_loops(self):
560
"""No entry should be its own ancestor"""
562
for trans_id in self._new_parent:
565
while parent_id is not ROOT_PARENT:
568
parent_id = self.final_parent(parent_id)
571
if parent_id == trans_id:
572
conflicts.append(('parent loop', trans_id))
573
if parent_id in seen:
577
def _unversioned_parents(self, by_parent):
578
"""If parent directories are versioned, children must be versioned."""
580
for parent_id, children in by_parent.iteritems():
581
if parent_id is ROOT_PARENT:
583
if self.final_file_id(parent_id) is not None:
585
for child_id in children:
586
if self.final_file_id(child_id) is not None:
587
conflicts.append(('unversioned parent', parent_id))
591
def _improper_versioning(self):
592
"""Cannot version a file with no contents, or a bad type.
594
However, existing entries with no contents are okay.
597
for trans_id in self._new_id.iterkeys():
599
kind = self.final_kind(trans_id)
601
conflicts.append(('versioning no contents', trans_id))
603
if not InventoryEntry.versionable_kind(kind):
604
conflicts.append(('versioning bad kind', trans_id, kind))
607
def _executability_conflicts(self):
608
"""Check for bad executability changes.
610
Only versioned files may have their executability set, because
611
1. only versioned entries can have executability under windows
612
2. only files can be executable. (The execute bit on a directory
613
does not indicate searchability)
616
for trans_id in self._new_executability:
617
if self.final_file_id(trans_id) is None:
618
conflicts.append(('unversioned executability', trans_id))
621
non_file = self.final_kind(trans_id) != "file"
625
conflicts.append(('non-file executability', trans_id))
628
def _overwrite_conflicts(self):
629
"""Check for overwrites (not permitted on Win32)"""
631
for trans_id in self._new_contents:
633
self.tree_kind(trans_id)
636
if trans_id not in self._removed_contents:
637
conflicts.append(('overwrite', trans_id,
638
self.final_name(trans_id)))
641
def _duplicate_entries(self, by_parent):
642
"""No directory may have two entries with the same name."""
644
if (self._new_name, self._new_parent) == ({}, {}):
646
for children in by_parent.itervalues():
647
name_ids = [(self.final_name(t), t) for t in children]
648
if not self._case_sensitive_target:
649
name_ids = [(n.lower(), t) for n, t in name_ids]
653
for name, trans_id in name_ids:
655
kind = self.final_kind(trans_id)
658
file_id = self.final_file_id(trans_id)
659
if kind is None and file_id is None:
661
if name == last_name:
662
conflicts.append(('duplicate', last_trans_id, trans_id,
665
last_trans_id = trans_id
668
def _duplicate_ids(self):
669
"""Each inventory id may only be used once"""
671
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
673
all_ids = self._tree.all_file_ids()
674
active_tree_ids = all_ids.difference(removed_tree_ids)
675
for trans_id, file_id in self._new_id.iteritems():
676
if file_id in active_tree_ids:
677
old_trans_id = self.trans_id_tree_file_id(file_id)
678
conflicts.append(('duplicate id', old_trans_id, trans_id))
681
def _parent_type_conflicts(self, by_parent):
682
"""parents must have directory 'contents'."""
684
for parent_id, children in by_parent.iteritems():
685
if parent_id is ROOT_PARENT:
687
if not self._any_contents(children):
689
for child in children:
691
self.final_kind(child)
695
kind = self.final_kind(parent_id)
699
conflicts.append(('missing parent', parent_id))
700
elif kind != "directory":
701
conflicts.append(('non-directory parent', parent_id))
704
def _any_contents(self, trans_ids):
705
"""Return true if any of the trans_ids, will have contents."""
706
for trans_id in trans_ids:
708
kind = self.final_kind(trans_id)
714
def _set_executability(self, path, trans_id):
715
"""Set the executability of versioned files """
716
if supports_executable():
717
new_executability = self._new_executability[trans_id]
718
abspath = self._tree.abspath(path)
719
current_mode = os.stat(abspath).st_mode
720
if new_executability:
723
to_mode = current_mode | (0100 & ~umask)
724
# Enable x-bit for others only if they can read it.
725
if current_mode & 0004:
726
to_mode |= 0001 & ~umask
727
if current_mode & 0040:
728
to_mode |= 0010 & ~umask
730
to_mode = current_mode & ~0111
731
os.chmod(abspath, to_mode)
733
def _new_entry(self, name, parent_id, file_id):
734
"""Helper function to create a new filesystem entry."""
735
trans_id = self.create_path(name, parent_id)
736
if file_id is not None:
737
self.version_file(file_id, trans_id)
740
def new_file(self, name, parent_id, contents, file_id=None,
742
"""Convenience method to create files.
744
name is the name of the file to create.
745
parent_id is the transaction id of the parent directory of the file.
746
contents is an iterator of bytestrings, which will be used to produce
748
:param file_id: The inventory ID of the file, if it is to be versioned.
749
:param executable: Only valid when a file_id has been supplied.
751
trans_id = self._new_entry(name, parent_id, file_id)
752
# TODO: rather than scheduling a set_executable call,
753
# have create_file create the file with the right mode.
754
self.create_file(contents, trans_id)
755
if executable is not None:
756
self.set_executability(executable, trans_id)
759
def new_directory(self, name, parent_id, file_id=None):
760
"""Convenience method to create directories.
762
name is the name of the directory to create.
763
parent_id is the transaction id of the parent directory of the
765
file_id is the inventory ID of the directory, if it is to be versioned.
767
trans_id = self._new_entry(name, parent_id, file_id)
768
self.create_directory(trans_id)
771
def new_symlink(self, name, parent_id, target, file_id=None):
772
"""Convenience method to create symbolic link.
774
name is the name of the symlink to create.
775
parent_id is the transaction id of the parent directory of the symlink.
776
target is a bytestring of the target of the symlink.
777
file_id is the inventory ID of the file, if it is to be versioned.
779
trans_id = self._new_entry(name, parent_id, file_id)
780
self.create_symlink(target, trans_id)
783
def _affected_ids(self):
784
"""Return the set of transform ids affected by the transform"""
785
trans_ids = set(self._removed_id)
786
trans_ids.update(self._new_id.keys())
787
trans_ids.update(self._removed_contents)
788
trans_ids.update(self._new_contents.keys())
789
trans_ids.update(self._new_executability.keys())
790
trans_ids.update(self._new_name.keys())
791
trans_ids.update(self._new_parent.keys())
794
def _get_file_id_maps(self):
795
"""Return mapping of file_ids to trans_ids in the to and from states"""
796
trans_ids = self._affected_ids()
799
# Build up two dicts: trans_ids associated with file ids in the
800
# FROM state, vs the TO state.
801
for trans_id in trans_ids:
802
from_file_id = self.tree_file_id(trans_id)
803
if from_file_id is not None:
804
from_trans_ids[from_file_id] = trans_id
805
to_file_id = self.final_file_id(trans_id)
806
if to_file_id is not None:
807
to_trans_ids[to_file_id] = trans_id
808
return from_trans_ids, to_trans_ids
810
def _from_file_data(self, from_trans_id, from_versioned, file_id):
811
"""Get data about a file in the from (tree) state
813
Return a (name, parent, kind, executable) tuple
815
from_path = self._tree_id_paths.get(from_trans_id)
817
# get data from working tree if versioned
818
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
819
from_name = from_entry.name
820
from_parent = from_entry.parent_id
823
if from_path is None:
824
# File does not exist in FROM state
828
# File exists, but is not versioned. Have to use path-
830
from_name = os.path.basename(from_path)
831
tree_parent = self.get_tree_parent(from_trans_id)
832
from_parent = self.tree_file_id(tree_parent)
833
if from_path is not None:
834
from_kind, from_executable, from_stats = \
835
self._tree._comparison_data(from_entry, from_path)
838
from_executable = False
839
return from_name, from_parent, from_kind, from_executable
841
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
842
"""Get data about a file in the to (target) state
844
Return a (name, parent, kind, executable) tuple
846
to_name = self.final_name(to_trans_id)
848
to_kind = self.final_kind(to_trans_id)
851
to_parent = self.final_file_id(self.final_parent(to_trans_id))
852
if to_trans_id in self._new_executability:
853
to_executable = self._new_executability[to_trans_id]
854
elif to_trans_id == from_trans_id:
855
to_executable = from_executable
857
to_executable = False
858
return to_name, to_parent, to_kind, to_executable
860
def iter_changes(self):
861
"""Produce output in the same format as Tree.iter_changes.
863
Will produce nonsensical results if invoked while inventory/filesystem
864
conflicts (as reported by TreeTransform.find_conflicts()) are present.
866
This reads the Transform, but only reproduces changes involving a
867
file_id. Files that are not versioned in either of the FROM or TO
868
states are not reflected.
870
final_paths = FinalPaths(self)
871
from_trans_ids, to_trans_ids = self._get_file_id_maps()
873
# Now iterate through all active file_ids
874
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
876
from_trans_id = from_trans_ids.get(file_id)
877
# find file ids, and determine versioning state
878
if from_trans_id is None:
879
from_versioned = False
880
from_trans_id = to_trans_ids[file_id]
882
from_versioned = True
883
to_trans_id = to_trans_ids.get(file_id)
884
if to_trans_id is None:
886
to_trans_id = from_trans_id
890
from_name, from_parent, from_kind, from_executable = \
891
self._from_file_data(from_trans_id, from_versioned, file_id)
893
to_name, to_parent, to_kind, to_executable = \
894
self._to_file_data(to_trans_id, from_trans_id, from_executable)
896
if not from_versioned:
899
from_path = self._tree_id_paths.get(from_trans_id)
903
to_path = final_paths.get_path(to_trans_id)
904
if from_kind != to_kind:
906
elif to_kind in ('file', 'symlink') and (
907
to_trans_id != from_trans_id or
908
to_trans_id in self._new_contents):
910
if (not modified and from_versioned == to_versioned and
911
from_parent==to_parent and from_name == to_name and
912
from_executable == to_executable):
914
results.append((file_id, (from_path, to_path), modified,
915
(from_versioned, to_versioned),
916
(from_parent, to_parent),
917
(from_name, to_name),
918
(from_kind, to_kind),
919
(from_executable, to_executable)))
920
return iter(sorted(results, key=lambda x:x[1]))
922
def get_preview_tree(self):
923
"""Return a tree representing the result of the transform.
925
The tree is a snapshot, and altering the TreeTransform will invalidate
928
return _PreviewTree(self)
930
def commit(self, branch, message, merge_parents=None, strict=False):
931
"""Commit the result of this TreeTransform to a branch.
933
:param branch: The branch to commit to.
934
:param message: The message to attach to the commit.
935
:param merge_parents: Additional parents specified by pending merges.
936
:return: The revision_id of the revision committed.
938
self._check_malformed()
940
unversioned = set(self._new_contents).difference(set(self._new_id))
941
for trans_id in unversioned:
942
if self.final_file_id(trans_id) is None:
943
raise errors.StrictCommitFailed()
945
revno, last_rev_id = branch.last_revision_info()
946
if last_rev_id == _mod_revision.NULL_REVISION:
947
if merge_parents is not None:
948
raise ValueError('Cannot supply merge parents for first'
952
parent_ids = [last_rev_id]
953
if merge_parents is not None:
954
parent_ids.extend(merge_parents)
955
if self._tree.get_revision_id() != last_rev_id:
956
raise ValueError('TreeTransform not based on branch basis: %s' %
957
self._tree.get_revision_id())
958
builder = branch.get_commit_builder(parent_ids)
959
preview = self.get_preview_tree()
960
list(builder.record_iter_changes(preview, last_rev_id,
961
self.iter_changes()))
962
builder.finish_inventory()
963
revision_id = builder.commit(message)
964
branch.set_last_revision_info(revno + 1, revision_id)
967
def _text_parent(self, trans_id):
968
file_id = self.tree_file_id(trans_id)
970
if file_id is None or self._tree.kind(file_id) != 'file':
972
except errors.NoSuchFile:
976
def _get_parents_texts(self, trans_id):
977
"""Get texts for compression parents of this file."""
978
file_id = self._text_parent(trans_id)
981
return (self._tree.get_file_text(file_id),)
983
def _get_parents_lines(self, trans_id):
984
"""Get lines for compression parents of this file."""
985
file_id = self._text_parent(trans_id)
988
return (self._tree.get_file_lines(file_id),)
990
def serialize(self, serializer):
991
"""Serialize this TreeTransform.
993
:param serializer: A Serialiser like pack.ContainerSerializer.
995
new_name = dict((k, v.encode('utf-8')) for k, v in
996
self._new_name.items())
997
new_executability = dict((k, int(v)) for k, v in
998
self._new_executability.items())
999
tree_path_ids = dict((k.encode('utf-8'), v)
1000
for k, v in self._tree_path_ids.items())
1002
'_id_number': self._id_number,
1003
'_new_name': new_name,
1004
'_new_parent': self._new_parent,
1005
'_new_executability': new_executability,
1006
'_new_id': self._new_id,
1007
'_tree_path_ids': tree_path_ids,
1008
'_removed_id': list(self._removed_id),
1009
'_removed_contents': list(self._removed_contents),
1010
'_non_present_ids': self._non_present_ids,
1012
yield serializer.bytes_record(bencode.bencode(attribs),
1014
for trans_id, kind in self._new_contents.items():
1016
lines = osutils.chunks_to_lines(
1017
self._read_file_chunks(trans_id))
1018
parents = self._get_parents_lines(trans_id)
1019
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1020
content = ''.join(mpdiff.to_patch())
1021
if kind == 'directory':
1023
if kind == 'symlink':
1024
content = self._read_symlink_target(trans_id)
1025
yield serializer.bytes_record(content, ((trans_id, kind),))
1027
def deserialize(self, records):
1028
"""Deserialize a stored TreeTransform.
1030
:param records: An iterable of (names, content) tuples, as per
1031
pack.ContainerPushParser.
1033
names, content = records.next()
1034
attribs = bencode.bdecode(content)
1035
self._id_number = attribs['_id_number']
1036
self._new_name = dict((k, v.decode('utf-8'))
1037
for k, v in attribs['_new_name'].items())
1038
self._new_parent = attribs['_new_parent']
1039
self._new_executability = dict((k, bool(v)) for k, v in
1040
attribs['_new_executability'].items())
1041
self._new_id = attribs['_new_id']
1042
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1043
self._tree_path_ids = {}
1044
self._tree_id_paths = {}
1045
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1046
path = bytepath.decode('utf-8')
1047
self._tree_path_ids[path] = trans_id
1048
self._tree_id_paths[trans_id] = path
1049
self._removed_id = set(attribs['_removed_id'])
1050
self._removed_contents = set(attribs['_removed_contents'])
1051
self._non_present_ids = attribs['_non_present_ids']
1052
for ((trans_id, kind),), content in records:
1054
mpdiff = multiparent.MultiParent.from_patch(content)
1055
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1056
self.create_file(lines, trans_id)
1057
if kind == 'directory':
1058
self.create_directory(trans_id)
1059
if kind == 'symlink':
1060
self.create_symlink(content.decode('utf-8'), trans_id)
1063
class DiskTreeTransform(TreeTransformBase):
1064
"""Tree transform storing its contents on disk."""
1066
def __init__(self, tree, limbodir, pb=None,
1067
case_sensitive=True):
1069
:param tree: The tree that will be transformed, but not necessarily
1071
:param limbodir: A directory where new files can be stored until
1072
they are installed in their proper places
1074
:param case_sensitive: If True, the target of the transform is
1075
case sensitive, not just case preserving.
1077
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1078
self._limbodir = limbodir
1079
self._deletiondir = None
1080
# A mapping of transform ids to their limbo filename
1081
self._limbo_files = {}
1082
# A mapping of transform ids to a set of the transform ids of children
1083
# that their limbo directory has
1084
self._limbo_children = {}
1085
# Map transform ids to maps of child filename to child transform id
1086
self._limbo_children_names = {}
1087
# List of transform ids that need to be renamed from limbo into place
1088
self._needs_rename = set()
1089
self._creation_mtime = None
1092
"""Release the working tree lock, if held, clean up limbo dir.
1094
This is required if apply has not been invoked, but can be invoked
1097
if self._tree is None:
1100
entries = [(self._limbo_name(t), t, k) for t, k in
1101
self._new_contents.iteritems()]
1102
entries.sort(reverse=True)
1103
for path, trans_id, kind in entries:
1106
delete_any(self._limbodir)
1108
# We don't especially care *why* the dir is immortal.
1109
raise ImmortalLimbo(self._limbodir)
1111
if self._deletiondir is not None:
1112
delete_any(self._deletiondir)
1114
raise errors.ImmortalPendingDeletion(self._deletiondir)
1116
TreeTransformBase.finalize(self)
1118
def _limbo_name(self, trans_id):
1119
"""Generate the limbo name of a file"""
1120
limbo_name = self._limbo_files.get(trans_id)
1121
if limbo_name is None:
1122
limbo_name = self._generate_limbo_path(trans_id)
1123
self._limbo_files[trans_id] = limbo_name
1126
def _generate_limbo_path(self, trans_id):
1127
"""Generate a limbo path using the trans_id as the relative path.
1129
This is suitable as a fallback, and when the transform should not be
1130
sensitive to the path encoding of the limbo directory.
1132
self._needs_rename.add(trans_id)
1133
return pathjoin(self._limbodir, trans_id)
1135
def adjust_path(self, name, parent, trans_id):
1136
previous_parent = self._new_parent.get(trans_id)
1137
previous_name = self._new_name.get(trans_id)
1138
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1139
if (trans_id in self._limbo_files and
1140
trans_id not in self._needs_rename):
1141
self._rename_in_limbo([trans_id])
1142
if previous_parent != parent:
1143
self._limbo_children[previous_parent].remove(trans_id)
1144
if previous_parent != parent or previous_name != name:
1145
del self._limbo_children_names[previous_parent][previous_name]
1147
def _rename_in_limbo(self, trans_ids):
1148
"""Fix limbo names so that the right final path is produced.
1150
This means we outsmarted ourselves-- we tried to avoid renaming
1151
these files later by creating them with their final names in their
1152
final parents. But now the previous name or parent is no longer
1153
suitable, so we have to rename them.
1155
Even for trans_ids that have no new contents, we must remove their
1156
entries from _limbo_files, because they are now stale.
1158
for trans_id in trans_ids:
1159
old_path = self._limbo_files.pop(trans_id)
1160
if trans_id not in self._new_contents:
1162
new_path = self._limbo_name(trans_id)
1163
os.rename(old_path, new_path)
1164
for descendant in self._limbo_descendants(trans_id):
1165
desc_path = self._limbo_files[descendant]
1166
desc_path = new_path + desc_path[len(old_path):]
1167
self._limbo_files[descendant] = desc_path
1169
def _limbo_descendants(self, trans_id):
1170
"""Return the set of trans_ids whose limbo paths descend from this."""
1171
descendants = set(self._limbo_children.get(trans_id, []))
1172
for descendant in list(descendants):
1173
descendants.update(self._limbo_descendants(descendant))
1176
def create_file(self, contents, trans_id, mode_id=None):
1177
"""Schedule creation of a new file.
1181
Contents is an iterator of strings, all of which will be written
1182
to the target destination.
1184
New file takes the permissions of any existing file with that id,
1185
unless mode_id is specified.
1187
name = self._limbo_name(trans_id)
1188
f = open(name, 'wb')
1191
unique_add(self._new_contents, trans_id, 'file')
1193
# Clean up the file, it never got registered so
1194
# TreeTransform.finalize() won't clean it up.
1199
f.writelines(contents)
1202
self._set_mtime(name)
1203
self._set_mode(trans_id, mode_id, S_ISREG)
1205
def _read_file_chunks(self, trans_id):
1206
cur_file = open(self._limbo_name(trans_id), 'rb')
1208
return cur_file.readlines()
1212
def _read_symlink_target(self, trans_id):
1213
return os.readlink(self._limbo_name(trans_id))
1215
def _set_mtime(self, path):
1216
"""All files that are created get the same mtime.
1218
This time is set by the first object to be created.
1220
if self._creation_mtime is None:
1221
self._creation_mtime = time.time()
1222
os.utime(path, (self._creation_mtime, self._creation_mtime))
1224
def create_hardlink(self, path, trans_id):
1225
"""Schedule creation of a hard link"""
1226
name = self._limbo_name(trans_id)
1230
if e.errno != errno.EPERM:
1232
raise errors.HardLinkNotSupported(path)
1234
unique_add(self._new_contents, trans_id, 'file')
1236
# Clean up the file, it never got registered so
1237
# TreeTransform.finalize() won't clean it up.
1241
def create_directory(self, trans_id):
1242
"""Schedule creation of a new directory.
1244
See also new_directory.
1246
os.mkdir(self._limbo_name(trans_id))
1247
unique_add(self._new_contents, trans_id, 'directory')
1249
def create_symlink(self, target, trans_id):
1250
"""Schedule creation of a new symbolic link.
1252
target is a bytestring.
1253
See also new_symlink.
1256
os.symlink(target, self._limbo_name(trans_id))
1257
unique_add(self._new_contents, trans_id, 'symlink')
1260
path = FinalPaths(self).get_path(trans_id)
1263
raise UnableCreateSymlink(path=path)
1265
def cancel_creation(self, trans_id):
1266
"""Cancel the creation of new file contents."""
1267
del self._new_contents[trans_id]
1268
children = self._limbo_children.get(trans_id)
1269
# if this is a limbo directory with children, move them before removing
1271
if children is not None:
1272
self._rename_in_limbo(children)
1273
del self._limbo_children[trans_id]
1274
del self._limbo_children_names[trans_id]
1275
delete_any(self._limbo_name(trans_id))
1278
class TreeTransform(DiskTreeTransform):
1279
"""Represent a tree transformation.
1281
This object is designed to support incremental generation of the transform,
1284
However, it gives optimum performance when parent directories are created
1285
before their contents. The transform is then able to put child files
1286
directly in their parent directory, avoiding later renames.
1288
It is easy to produce malformed transforms, but they are generally
1289
harmless. Attempting to apply a malformed transform will cause an
1290
exception to be raised before any modifications are made to the tree.
1292
Many kinds of malformed transforms can be corrected with the
1293
resolve_conflicts function. The remaining ones indicate programming error,
1294
such as trying to create a file with no path.
1296
Two sets of file creation methods are supplied. Convenience methods are:
1301
These are composed of the low-level methods:
1303
* create_file or create_directory or create_symlink
1307
Transform/Transaction ids
1308
-------------------------
1309
trans_ids are temporary ids assigned to all files involved in a transform.
1310
It's possible, even common, that not all files in the Tree have trans_ids.
1312
trans_ids are used because filenames and file_ids are not good enough
1313
identifiers; filenames change, and not all files have file_ids. File-ids
1314
are also associated with trans-ids, so that moving a file moves its
1317
trans_ids are only valid for the TreeTransform that generated them.
1321
Limbo is a temporary directory use to hold new versions of files.
1322
Files are added to limbo by create_file, create_directory, create_symlink,
1323
and their convenience variants (new_*). Files may be removed from limbo
1324
using cancel_creation. Files are renamed from limbo into their final
1325
location as part of TreeTransform.apply
1327
Limbo must be cleaned up, by either calling TreeTransform.apply or
1328
calling TreeTransform.finalize.
1330
Files are placed into limbo inside their parent directories, where
1331
possible. This reduces subsequent renames, and makes operations involving
1332
lots of files faster. This optimization is only possible if the parent
1333
directory is created *before* creating any of its children, so avoid
1334
creating children before parents, where possible.
1338
This temporary directory is used by _FileMover for storing files that are
1339
about to be deleted. In case of rollback, the files will be restored.
1340
FileMover does not delete files until it is sure that a rollback will not
1343
def __init__(self, tree, pb=None):
1344
"""Note: a tree_write lock is taken on the tree.
1346
Use TreeTransform.finalize() to release the lock (can be omitted if
1347
TreeTransform.apply() called).
1349
tree.lock_tree_write()
1352
limbodir = urlutils.local_path_from_url(
1353
tree._transport.abspath('limbo'))
1357
if e.errno == errno.EEXIST:
1358
raise ExistingLimbo(limbodir)
1359
deletiondir = urlutils.local_path_from_url(
1360
tree._transport.abspath('pending-deletion'))
1362
os.mkdir(deletiondir)
1364
if e.errno == errno.EEXIST:
1365
raise errors.ExistingPendingDeletion(deletiondir)
1370
# Cache of realpath results, to speed up canonical_path
1371
self._realpaths = {}
1372
# Cache of relpath results, to speed up canonical_path
1374
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1375
tree.case_sensitive)
1376
self._deletiondir = deletiondir
1378
def canonical_path(self, path):
1379
"""Get the canonical tree-relative path"""
1380
# don't follow final symlinks
1381
abs = self._tree.abspath(path)
1382
if abs in self._relpaths:
1383
return self._relpaths[abs]
1384
dirname, basename = os.path.split(abs)
1385
if dirname not in self._realpaths:
1386
self._realpaths[dirname] = os.path.realpath(dirname)
1387
dirname = self._realpaths[dirname]
1388
abs = pathjoin(dirname, basename)
1389
if dirname in self._relpaths:
1390
relpath = pathjoin(self._relpaths[dirname], basename)
1391
relpath = relpath.rstrip('/\\')
1393
relpath = self._tree.relpath(abs)
1394
self._relpaths[abs] = relpath
1397
def tree_kind(self, trans_id):
1398
"""Determine the file kind in the working tree.
1400
Raises NoSuchFile if the file does not exist
1402
path = self._tree_id_paths.get(trans_id)
1404
raise NoSuchFile(None)
1406
return file_kind(self._tree.abspath(path))
1408
if e.errno != errno.ENOENT:
1411
raise NoSuchFile(path)
1413
def _set_mode(self, trans_id, mode_id, typefunc):
1414
"""Set the mode of new file contents.
1415
The mode_id is the existing file to get the mode from (often the same
1416
as trans_id). The operation is only performed if there's a mode match
1417
according to typefunc.
1422
old_path = self._tree_id_paths[mode_id]
1426
mode = os.stat(self._tree.abspath(old_path)).st_mode
1428
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1429
# Either old_path doesn't exist, or the parent of the
1430
# target is not a directory (but will be one eventually)
1431
# Either way, we know it doesn't exist *right now*
1432
# See also bug #248448
1437
os.chmod(self._limbo_name(trans_id), mode)
1439
def iter_tree_children(self, parent_id):
1440
"""Iterate through the entry's tree children, if any"""
1442
path = self._tree_id_paths[parent_id]
1446
children = os.listdir(self._tree.abspath(path))
1448
if not (osutils._is_error_enotdir(e)
1449
or e.errno in (errno.ENOENT, errno.ESRCH)):
1453
for child in children:
1454
childpath = joinpath(path, child)
1455
if self._tree.is_control_filename(childpath):
1457
yield self.trans_id_tree_path(childpath)
1459
def _generate_limbo_path(self, trans_id):
1460
"""Generate a limbo path using the final path if possible.
1462
This optimizes the performance of applying the tree transform by
1463
avoiding renames. These renames can be avoided only when the parent
1464
directory is already scheduled for creation.
1466
If the final path cannot be used, falls back to using the trans_id as
1469
parent = self._new_parent.get(trans_id)
1470
# if the parent directory is already in limbo (e.g. when building a
1471
# tree), choose a limbo name inside the parent, to reduce further
1473
use_direct_path = False
1474
if self._new_contents.get(parent) == 'directory':
1475
filename = self._new_name.get(trans_id)
1476
if filename is not None:
1477
if parent not in self._limbo_children:
1478
self._limbo_children[parent] = set()
1479
self._limbo_children_names[parent] = {}
1480
use_direct_path = True
1481
# the direct path can only be used if no other file has
1482
# already taken this pathname, i.e. if the name is unused, or
1483
# if it is already associated with this trans_id.
1484
elif self._case_sensitive_target:
1485
if (self._limbo_children_names[parent].get(filename)
1486
in (trans_id, None)):
1487
use_direct_path = True
1489
for l_filename, l_trans_id in\
1490
self._limbo_children_names[parent].iteritems():
1491
if l_trans_id == trans_id:
1493
if l_filename.lower() == filename.lower():
1496
use_direct_path = True
1498
if not use_direct_path:
1499
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1501
limbo_name = pathjoin(self._limbo_files[parent], filename)
1502
self._limbo_children[parent].add(trans_id)
1503
self._limbo_children_names[parent][filename] = trans_id
1507
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1508
"""Apply all changes to the inventory and filesystem.
1510
If filesystem or inventory conflicts are present, MalformedTransform
1513
If apply succeeds, finalize is not necessary.
1515
:param no_conflicts: if True, the caller guarantees there are no
1516
conflicts, so no check is made.
1517
:param precomputed_delta: An inventory delta to use instead of
1519
:param _mover: Supply an alternate FileMover, for testing
1521
if not no_conflicts:
1522
self._check_malformed()
1523
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1525
if precomputed_delta is None:
1526
child_pb.update('Apply phase', 0, 2)
1527
inventory_delta = self._generate_inventory_delta()
1530
inventory_delta = precomputed_delta
1533
mover = _FileMover()
1537
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1538
self._apply_removals(mover)
1539
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1540
modified_paths = self._apply_insertions(mover)
1545
mover.apply_deletions()
1548
self._tree.apply_inventory_delta(inventory_delta)
1551
return _TransformResults(modified_paths, self.rename_count)
1553
def _generate_inventory_delta(self):
1554
"""Generate an inventory delta for the current transform."""
1555
inventory_delta = []
1556
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1557
new_paths = self._inventory_altered()
1558
total_entries = len(new_paths) + len(self._removed_id)
1560
for num, trans_id in enumerate(self._removed_id):
1562
child_pb.update('removing file', num, total_entries)
1563
if trans_id == self._new_root:
1564
file_id = self._tree.get_root_id()
1566
file_id = self.tree_file_id(trans_id)
1567
# File-id isn't really being deleted, just moved
1568
if file_id in self._r_new_id:
1570
path = self._tree_id_paths[trans_id]
1571
inventory_delta.append((path, None, file_id, None))
1572
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1574
entries = self._tree.iter_entries_by_dir(
1575
new_path_file_ids.values())
1576
old_paths = dict((e.file_id, p) for p, e in entries)
1578
for num, (path, trans_id) in enumerate(new_paths):
1580
child_pb.update('adding file',
1581
num + len(self._removed_id), total_entries)
1582
file_id = new_path_file_ids[trans_id]
1587
kind = self.final_kind(trans_id)
1589
kind = self._tree.stored_kind(file_id)
1590
parent_trans_id = self.final_parent(trans_id)
1591
parent_file_id = new_path_file_ids.get(parent_trans_id)
1592
if parent_file_id is None:
1593
parent_file_id = self.final_file_id(parent_trans_id)
1594
if trans_id in self._new_reference_revision:
1595
new_entry = inventory.TreeReference(
1597
self._new_name[trans_id],
1598
self.final_file_id(self._new_parent[trans_id]),
1599
None, self._new_reference_revision[trans_id])
1601
new_entry = inventory.make_entry(kind,
1602
self.final_name(trans_id),
1603
parent_file_id, file_id)
1604
old_path = old_paths.get(new_entry.file_id)
1605
new_executability = self._new_executability.get(trans_id)
1606
if new_executability is not None:
1607
new_entry.executable = new_executability
1608
inventory_delta.append(
1609
(old_path, path, new_entry.file_id, new_entry))
1612
return inventory_delta
1614
def _apply_removals(self, mover):
1615
"""Perform tree operations that remove directory/inventory names.
1617
That is, delete files that are to be deleted, and put any files that
1618
need renaming into limbo. This must be done in strict child-to-parent
1621
If inventory_delta is None, no inventory delta generation is performed.
1623
tree_paths = list(self._tree_path_ids.iteritems())
1624
tree_paths.sort(reverse=True)
1625
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1627
for num, data in enumerate(tree_paths):
1628
path, trans_id = data
1629
child_pb.update('removing file', num, len(tree_paths))
1630
full_path = self._tree.abspath(path)
1631
if trans_id in self._removed_contents:
1632
delete_path = os.path.join(self._deletiondir, trans_id)
1633
mover.pre_delete(full_path, delete_path)
1634
elif (trans_id in self._new_name
1635
or trans_id in self._new_parent):
1637
mover.rename(full_path, self._limbo_name(trans_id))
1639
if e.errno != errno.ENOENT:
1642
self.rename_count += 1
1646
def _apply_insertions(self, mover):
1647
"""Perform tree operations that insert directory/inventory names.
1649
That is, create any files that need to be created, and restore from
1650
limbo any files that needed renaming. This must be done in strict
1651
parent-to-child order.
1653
If inventory_delta is None, no inventory delta is calculated, and
1654
no list of modified paths is returned.
1656
new_paths = self.new_paths(filesystem_only=True)
1658
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1660
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1662
for num, (path, trans_id) in enumerate(new_paths):
1664
child_pb.update('adding file', num, len(new_paths))
1665
full_path = self._tree.abspath(path)
1666
if trans_id in self._needs_rename:
1668
mover.rename(self._limbo_name(trans_id), full_path)
1670
# We may be renaming a dangling inventory id
1671
if e.errno != errno.ENOENT:
1674
self.rename_count += 1
1675
if (trans_id in self._new_contents or
1676
self.path_changed(trans_id)):
1677
if trans_id in self._new_contents:
1678
modified_paths.append(full_path)
1679
if trans_id in self._new_executability:
1680
self._set_executability(path, trans_id)
1683
self._new_contents.clear()
1684
return modified_paths
1687
class TransformPreview(DiskTreeTransform):
1688
"""A TreeTransform for generating preview trees.
1690
Unlike TreeTransform, this version works when the input tree is a
1691
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1692
unversioned files in the input tree.
1695
def __init__(self, tree, pb=None, case_sensitive=True):
1697
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1698
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1700
def canonical_path(self, path):
1703
def tree_kind(self, trans_id):
1704
path = self._tree_id_paths.get(trans_id)
1706
raise NoSuchFile(None)
1707
file_id = self._tree.path2id(path)
1708
return self._tree.kind(file_id)
1710
def _set_mode(self, trans_id, mode_id, typefunc):
1711
"""Set the mode of new file contents.
1712
The mode_id is the existing file to get the mode from (often the same
1713
as trans_id). The operation is only performed if there's a mode match
1714
according to typefunc.
1716
# is it ok to ignore this? probably
1719
def iter_tree_children(self, parent_id):
1720
"""Iterate through the entry's tree children, if any"""
1722
path = self._tree_id_paths[parent_id]
1725
file_id = self.tree_file_id(parent_id)
1728
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1729
children = getattr(entry, 'children', {})
1730
for child in children:
1731
childpath = joinpath(path, child)
1732
yield self.trans_id_tree_path(childpath)
1735
class _PreviewTree(tree.Tree):
1736
"""Partial implementation of Tree to support show_diff_trees"""
1738
def __init__(self, transform):
1739
self._transform = transform
1740
self._final_paths = FinalPaths(transform)
1741
self.__by_parent = None
1742
self._parent_ids = []
1743
self._all_children_cache = {}
1744
self._path2trans_id_cache = {}
1745
self._final_name_cache = {}
1746
self._iter_changes_cache = dict((c[0], c) for c in
1747
self._transform.iter_changes())
1749
def _content_change(self, file_id):
1750
"""Return True if the content of this file changed"""
1751
changes = self._iter_changes_cache.get(file_id)
1752
# changes[2] is true if the file content changed. See
1753
# InterTree.iter_changes.
1754
return (changes is not None and changes[2])
1756
def _get_repository(self):
1757
repo = getattr(self._transform._tree, '_repository', None)
1759
repo = self._transform._tree.branch.repository
1762
def _iter_parent_trees(self):
1763
for revision_id in self.get_parent_ids():
1765
yield self.revision_tree(revision_id)
1766
except errors.NoSuchRevisionInTree:
1767
yield self._get_repository().revision_tree(revision_id)
1769
def _get_file_revision(self, file_id, vf, tree_revision):
1770
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1771
self._iter_parent_trees()]
1772
vf.add_lines((file_id, tree_revision), parent_keys,
1773
self.get_file(file_id).readlines())
1774
repo = self._get_repository()
1775
base_vf = repo.texts
1776
if base_vf not in vf.fallback_versionedfiles:
1777
vf.fallback_versionedfiles.append(base_vf)
1778
return tree_revision
1780
def _stat_limbo_file(self, file_id):
1781
trans_id = self._transform.trans_id_file_id(file_id)
1782
name = self._transform._limbo_name(trans_id)
1783
return os.lstat(name)
1786
def _by_parent(self):
1787
if self.__by_parent is None:
1788
self.__by_parent = self._transform.by_parent()
1789
return self.__by_parent
1791
def _comparison_data(self, entry, path):
1792
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1793
if kind == 'missing':
1797
file_id = self._transform.final_file_id(self._path2trans_id(path))
1798
executable = self.is_executable(file_id, path)
1799
return kind, executable, None
1801
def lock_read(self):
1802
# Perhaps in theory, this should lock the TreeTransform?
1809
def inventory(self):
1810
"""This Tree does not use inventory as its backing data."""
1811
raise NotImplementedError(_PreviewTree.inventory)
1813
def get_root_id(self):
1814
return self._transform.final_file_id(self._transform.root)
1816
def all_file_ids(self):
1817
tree_ids = set(self._transform._tree.all_file_ids())
1818
tree_ids.difference_update(self._transform.tree_file_id(t)
1819
for t in self._transform._removed_id)
1820
tree_ids.update(self._transform._new_id.values())
1824
return iter(self.all_file_ids())
1826
def _has_id(self, file_id, fallback_check):
1827
if file_id in self._transform._r_new_id:
1829
elif file_id in set([self._transform.tree_file_id(trans_id) for
1830
trans_id in self._transform._removed_id]):
1833
return fallback_check(file_id)
1835
def has_id(self, file_id):
1836
return self._has_id(file_id, self._transform._tree.has_id)
1838
def has_or_had_id(self, file_id):
1839
return self._has_id(file_id, self._transform._tree.has_or_had_id)
1841
def _path2trans_id(self, path):
1842
# We must not use None here, because that is a valid value to store.
1843
trans_id = self._path2trans_id_cache.get(path, object)
1844
if trans_id is not object:
1846
segments = splitpath(path)
1847
cur_parent = self._transform.root
1848
for cur_segment in segments:
1849
for child in self._all_children(cur_parent):
1850
final_name = self._final_name_cache.get(child)
1851
if final_name is None:
1852
final_name = self._transform.final_name(child)
1853
self._final_name_cache[child] = final_name
1854
if final_name == cur_segment:
1858
self._path2trans_id_cache[path] = None
1860
self._path2trans_id_cache[path] = cur_parent
1863
def path2id(self, path):
1864
return self._transform.final_file_id(self._path2trans_id(path))
1866
def id2path(self, file_id):
1867
trans_id = self._transform.trans_id_file_id(file_id)
1869
return self._final_paths._determine_path(trans_id)
1871
raise errors.NoSuchId(self, file_id)
1873
def _all_children(self, trans_id):
1874
children = self._all_children_cache.get(trans_id)
1875
if children is not None:
1877
children = set(self._transform.iter_tree_children(trans_id))
1878
# children in the _new_parent set are provided by _by_parent.
1879
children.difference_update(self._transform._new_parent.keys())
1880
children.update(self._by_parent.get(trans_id, []))
1881
self._all_children_cache[trans_id] = children
1884
def iter_children(self, file_id):
1885
trans_id = self._transform.trans_id_file_id(file_id)
1886
for child_trans_id in self._all_children(trans_id):
1887
yield self._transform.final_file_id(child_trans_id)
1890
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1891
in self._transform._tree.extras())
1892
possible_extras.update(self._transform._new_contents)
1893
possible_extras.update(self._transform._removed_id)
1894
for trans_id in possible_extras:
1895
if self._transform.final_file_id(trans_id) is None:
1896
yield self._final_paths._determine_path(trans_id)
1898
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
1899
yield_parents=False):
1900
for trans_id, parent_file_id in ordered_entries:
1901
file_id = self._transform.final_file_id(trans_id)
1904
if (specific_file_ids is not None
1905
and file_id not in specific_file_ids):
1908
kind = self._transform.final_kind(trans_id)
1910
kind = self._transform._tree.stored_kind(file_id)
1911
new_entry = inventory.make_entry(
1913
self._transform.final_name(trans_id),
1914
parent_file_id, file_id)
1915
yield new_entry, trans_id
1917
def _list_files_by_dir(self):
1918
todo = [ROOT_PARENT]
1920
while len(todo) > 0:
1922
parent_file_id = self._transform.final_file_id(parent)
1923
children = list(self._all_children(parent))
1924
paths = dict(zip(children, self._final_paths.get_paths(children)))
1925
children.sort(key=paths.get)
1926
todo.extend(reversed(children))
1927
for trans_id in children:
1928
ordered_ids.append((trans_id, parent_file_id))
1931
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
1932
# This may not be a maximally efficient implementation, but it is
1933
# reasonably straightforward. An implementation that grafts the
1934
# TreeTransform changes onto the tree's iter_entries_by_dir results
1935
# might be more efficient, but requires tricky inferences about stack
1937
ordered_ids = self._list_files_by_dir()
1938
for entry, trans_id in self._make_inv_entries(ordered_ids,
1939
specific_file_ids, yield_parents=yield_parents):
1940
yield unicode(self._final_paths.get_path(trans_id)), entry
1942
def _iter_entries_for_dir(self, dir_path):
1943
"""Return path, entry for items in a directory without recursing down."""
1944
dir_file_id = self.path2id(dir_path)
1946
for file_id in self.iter_children(dir_file_id):
1947
trans_id = self._transform.trans_id_file_id(file_id)
1948
ordered_ids.append((trans_id, file_id))
1949
for entry, trans_id in self._make_inv_entries(ordered_ids):
1950
yield unicode(self._final_paths.get_path(trans_id)), entry
1952
def list_files(self, include_root=False, from_dir=None, recursive=True):
1953
"""See WorkingTree.list_files."""
1954
# XXX This should behave like WorkingTree.list_files, but is really
1955
# more like RevisionTree.list_files.
1959
prefix = from_dir + '/'
1960
entries = self.iter_entries_by_dir()
1961
for path, entry in entries:
1962
if entry.name == '' and not include_root:
1965
if not path.startswith(prefix):
1967
path = path[len(prefix):]
1968
yield path, 'V', entry.kind, entry.file_id, entry
1970
if from_dir is None and include_root is True:
1971
root_entry = inventory.make_entry('directory', '',
1972
ROOT_PARENT, self.get_root_id())
1973
yield '', 'V', 'directory', root_entry.file_id, root_entry
1974
entries = self._iter_entries_for_dir(from_dir or '')
1975
for path, entry in entries:
1976
yield path, 'V', entry.kind, entry.file_id, entry
1978
def kind(self, file_id):
1979
trans_id = self._transform.trans_id_file_id(file_id)
1980
return self._transform.final_kind(trans_id)
1982
def stored_kind(self, file_id):
1983
trans_id = self._transform.trans_id_file_id(file_id)
1985
return self._transform._new_contents[trans_id]
1987
return self._transform._tree.stored_kind(file_id)
1989
def get_file_mtime(self, file_id, path=None):
1990
"""See Tree.get_file_mtime"""
1991
if not self._content_change(file_id):
1992
return self._transform._tree.get_file_mtime(file_id)
1993
return self._stat_limbo_file(file_id).st_mtime
1995
def _file_size(self, entry, stat_value):
1996
return self.get_file_size(entry.file_id)
1998
def get_file_size(self, file_id):
1999
"""See Tree.get_file_size"""
2000
if self.kind(file_id) == 'file':
2001
return self._transform._tree.get_file_size(file_id)
2005
def get_file_sha1(self, file_id, path=None, stat_value=None):
2006
trans_id = self._transform.trans_id_file_id(file_id)
2007
kind = self._transform._new_contents.get(trans_id)
2009
return self._transform._tree.get_file_sha1(file_id)
2011
fileobj = self.get_file(file_id)
2013
return sha_file(fileobj)
2017
def is_executable(self, file_id, path=None):
2020
trans_id = self._transform.trans_id_file_id(file_id)
2022
return self._transform._new_executability[trans_id]
2025
return self._transform._tree.is_executable(file_id, path)
2027
if e.errno == errno.ENOENT:
2030
except errors.NoSuchId:
2033
def path_content_summary(self, path):
2034
trans_id = self._path2trans_id(path)
2035
tt = self._transform
2036
tree_path = tt._tree_id_paths.get(trans_id)
2037
kind = tt._new_contents.get(trans_id)
2039
if tree_path is None or trans_id in tt._removed_contents:
2040
return 'missing', None, None, None
2041
summary = tt._tree.path_content_summary(tree_path)
2042
kind, size, executable, link_or_sha1 = summary
2045
limbo_name = tt._limbo_name(trans_id)
2046
if trans_id in tt._new_reference_revision:
2047
kind = 'tree-reference'
2049
statval = os.lstat(limbo_name)
2050
size = statval.st_size
2051
if not supports_executable():
2054
executable = statval.st_mode & S_IEXEC
2058
if kind == 'symlink':
2059
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2060
executable = tt._new_executability.get(trans_id, executable)
2061
return kind, size, executable, link_or_sha1
2063
def iter_changes(self, from_tree, include_unchanged=False,
2064
specific_files=None, pb=None, extra_trees=None,
2065
require_versioned=True, want_unversioned=False):
2066
"""See InterTree.iter_changes.
2068
This has a fast path that is only used when the from_tree matches
2069
the transform tree, and no fancy options are supplied.
2071
if (from_tree is not self._transform._tree or include_unchanged or
2072
specific_files or want_unversioned):
2073
return tree.InterTree(from_tree, self).iter_changes(
2074
include_unchanged=include_unchanged,
2075
specific_files=specific_files,
2077
extra_trees=extra_trees,
2078
require_versioned=require_versioned,
2079
want_unversioned=want_unversioned)
2080
if want_unversioned:
2081
raise ValueError('want_unversioned is not supported')
2082
return self._transform.iter_changes()
2084
def get_file(self, file_id, path=None):
2085
"""See Tree.get_file"""
2086
if not self._content_change(file_id):
2087
return self._transform._tree.get_file(file_id, path)
2088
trans_id = self._transform.trans_id_file_id(file_id)
2089
name = self._transform._limbo_name(trans_id)
2090
return open(name, 'rb')
2092
def get_file_with_stat(self, file_id, path=None):
2093
return self.get_file(file_id, path), None
2095
def annotate_iter(self, file_id,
2096
default_revision=_mod_revision.CURRENT_REVISION):
2097
changes = self._iter_changes_cache.get(file_id)
2101
changed_content, versioned, kind = (changes[2], changes[3],
2105
get_old = (kind[0] == 'file' and versioned[0])
2107
old_annotation = self._transform._tree.annotate_iter(file_id,
2108
default_revision=default_revision)
2112
return old_annotation
2113
if not changed_content:
2114
return old_annotation
2115
# TODO: This is doing something similar to what WT.annotate_iter is
2116
# doing, however it fails slightly because it doesn't know what
2117
# the *other* revision_id is, so it doesn't know how to give the
2118
# other as the origin for some lines, they all get
2119
# 'default_revision'
2120
# It would be nice to be able to use the new Annotator based
2121
# approach, as well.
2122
return annotate.reannotate([old_annotation],
2123
self.get_file(file_id).readlines(),
2126
def get_symlink_target(self, file_id):
2127
"""See Tree.get_symlink_target"""
2128
if not self._content_change(file_id):
2129
return self._transform._tree.get_symlink_target(file_id)
2130
trans_id = self._transform.trans_id_file_id(file_id)
2131
name = self._transform._limbo_name(trans_id)
2132
return osutils.readlink(name)
2134
def walkdirs(self, prefix=''):
2135
pending = [self._transform.root]
2136
while len(pending) > 0:
2137
parent_id = pending.pop()
2140
prefix = prefix.rstrip('/')
2141
parent_path = self._final_paths.get_path(parent_id)
2142
parent_file_id = self._transform.final_file_id(parent_id)
2143
for child_id in self._all_children(parent_id):
2144
path_from_root = self._final_paths.get_path(child_id)
2145
basename = self._transform.final_name(child_id)
2146
file_id = self._transform.final_file_id(child_id)
2148
kind = self._transform.final_kind(child_id)
2149
versioned_kind = kind
2152
versioned_kind = self._transform._tree.stored_kind(file_id)
2153
if versioned_kind == 'directory':
2154
subdirs.append(child_id)
2155
children.append((path_from_root, basename, kind, None,
2156
file_id, versioned_kind))
2158
if parent_path.startswith(prefix):
2159
yield (parent_path, parent_file_id), children
2160
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2163
def get_parent_ids(self):
2164
return self._parent_ids
2166
def set_parent_ids(self, parent_ids):
2167
self._parent_ids = parent_ids
2169
def get_revision_tree(self, revision_id):
2170
return self._transform._tree.get_revision_tree(revision_id)
2173
def joinpath(parent, child):
2174
"""Join tree-relative paths, handling the tree root specially"""
2175
if parent is None or parent == "":
2178
return pathjoin(parent, child)
2181
class FinalPaths(object):
2182
"""Make path calculation cheap by memoizing paths.
2184
The underlying tree must not be manipulated between calls, or else
2185
the results will likely be incorrect.
2187
def __init__(self, transform):
2188
object.__init__(self)
2189
self._known_paths = {}
2190
self.transform = transform
2192
def _determine_path(self, trans_id):
2193
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2195
name = self.transform.final_name(trans_id)
2196
parent_id = self.transform.final_parent(trans_id)
2197
if parent_id == self.transform.root:
2200
return pathjoin(self.get_path(parent_id), name)
2202
def get_path(self, trans_id):
2203
"""Find the final path associated with a trans_id"""
2204
if trans_id not in self._known_paths:
2205
self._known_paths[trans_id] = self._determine_path(trans_id)
2206
return self._known_paths[trans_id]
2208
def get_paths(self, trans_ids):
2209
return [(self.get_path(t), t) for t in trans_ids]
2213
def topology_sorted_ids(tree):
2214
"""Determine the topological order of the ids in a tree"""
2215
file_ids = list(tree)
2216
file_ids.sort(key=tree.id2path)
2220
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2221
delta_from_tree=False):
2222
"""Create working tree for a branch, using a TreeTransform.
2224
This function should be used on empty trees, having a tree root at most.
2225
(see merge and revert functionality for working with existing trees)
2227
Existing files are handled like so:
2229
- Existing bzrdirs take precedence over creating new items. They are
2230
created as '%s.diverted' % name.
2231
- Otherwise, if the content on disk matches the content we are building,
2232
it is silently replaced.
2233
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2235
:param tree: The tree to convert wt into a copy of
2236
:param wt: The working tree that files will be placed into
2237
:param accelerator_tree: A tree which can be used for retrieving file
2238
contents more quickly than tree itself, i.e. a workingtree. tree
2239
will be used for cases where accelerator_tree's content is different.
2240
:param hardlink: If true, hard-link files to accelerator_tree, where
2241
possible. accelerator_tree must implement abspath, i.e. be a
2243
:param delta_from_tree: If true, build_tree may use the input Tree to
2244
generate the inventory delta.
2246
wt.lock_tree_write()
2250
if accelerator_tree is not None:
2251
accelerator_tree.lock_read()
2253
return _build_tree(tree, wt, accelerator_tree, hardlink,
2256
if accelerator_tree is not None:
2257
accelerator_tree.unlock()
2264
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2265
"""See build_tree."""
2266
for num, _unused in enumerate(wt.all_file_ids()):
2267
if num > 0: # more than just a root
2268
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2269
existing_files = set()
2270
for dir, files in wt.walkdirs():
2271
existing_files.update(f[0] for f in files)
2273
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2274
pp = ProgressPhase("Build phase", 2, top_pb)
2275
if tree.inventory.root is not None:
2276
# This is kind of a hack: we should be altering the root
2277
# as part of the regular tree shape diff logic.
2278
# The conditional test here is to avoid doing an
2279
# expensive operation (flush) every time the root id
2280
# is set within the tree, nor setting the root and thus
2281
# marking the tree as dirty, because we use two different
2282
# idioms here: tree interfaces and inventory interfaces.
2283
if wt.get_root_id() != tree.get_root_id():
2284
wt.set_root_id(tree.get_root_id())
2286
tt = TreeTransform(wt)
2290
file_trans_id[wt.get_root_id()] = \
2291
tt.trans_id_tree_file_id(wt.get_root_id())
2292
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2294
deferred_contents = []
2296
total = len(tree.inventory)
2298
precomputed_delta = []
2300
precomputed_delta = None
2301
for num, (tree_path, entry) in \
2302
enumerate(tree.inventory.iter_entries_by_dir()):
2303
pb.update("Building tree", num - len(deferred_contents), total)
2304
if entry.parent_id is None:
2307
file_id = entry.file_id
2309
precomputed_delta.append((None, tree_path, file_id, entry))
2310
if tree_path in existing_files:
2311
target_path = wt.abspath(tree_path)
2312
kind = file_kind(target_path)
2313
if kind == "directory":
2315
bzrdir.BzrDir.open(target_path)
2316
except errors.NotBranchError:
2320
if (file_id not in divert and
2321
_content_match(tree, entry, file_id, kind,
2323
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2324
if kind == 'directory':
2326
parent_id = file_trans_id[entry.parent_id]
2327
if entry.kind == 'file':
2328
# We *almost* replicate new_by_entry, so that we can defer
2329
# getting the file text, and get them all at once.
2330
trans_id = tt.create_path(entry.name, parent_id)
2331
file_trans_id[file_id] = trans_id
2332
tt.version_file(file_id, trans_id)
2333
executable = tree.is_executable(file_id, tree_path)
2335
tt.set_executability(executable, trans_id)
2336
trans_data = (trans_id, tree_path)
2337
deferred_contents.append((file_id, trans_data))
2339
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2342
new_trans_id = file_trans_id[file_id]
2343
old_parent = tt.trans_id_tree_path(tree_path)
2344
_reparent_children(tt, old_parent, new_trans_id)
2345
offset = num + 1 - len(deferred_contents)
2346
_create_files(tt, tree, deferred_contents, pb, offset,
2347
accelerator_tree, hardlink)
2351
divert_trans = set(file_trans_id[f] for f in divert)
2352
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2353
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2354
if len(raw_conflicts) > 0:
2355
precomputed_delta = None
2356
conflicts = cook_conflicts(raw_conflicts, tt)
2357
for conflict in conflicts:
2360
wt.add_conflicts(conflicts)
2361
except errors.UnsupportedOperation:
2363
result = tt.apply(no_conflicts=True,
2364
precomputed_delta=precomputed_delta)
2371
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2373
total = len(desired_files) + offset
2375
if accelerator_tree is None:
2376
new_desired_files = desired_files
2378
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2379
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2380
in iter if not (c or e[0] != e[1])]
2381
if accelerator_tree.supports_content_filtering():
2382
unchanged = [(f, p) for (f, p) in unchanged
2383
if not accelerator_tree.iter_search_rules([p]).next()]
2384
unchanged = dict(unchanged)
2385
new_desired_files = []
2387
for file_id, (trans_id, tree_path) in desired_files:
2388
accelerator_path = unchanged.get(file_id)
2389
if accelerator_path is None:
2390
new_desired_files.append((file_id, (trans_id, tree_path)))
2392
pb.update('Adding file contents', count + offset, total)
2394
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2397
contents = accelerator_tree.get_file(file_id, accelerator_path)
2398
if wt.supports_content_filtering():
2399
filters = wt._content_filter_stack(tree_path)
2400
contents = filtered_output_bytes(contents, filters,
2401
ContentFilterContext(tree_path, tree))
2403
tt.create_file(contents, trans_id)
2407
except AttributeError:
2408
# after filtering, contents may no longer be file-like
2412
for count, ((trans_id, tree_path), contents) in enumerate(
2413
tree.iter_files_bytes(new_desired_files)):
2414
if wt.supports_content_filtering():
2415
filters = wt._content_filter_stack(tree_path)
2416
contents = filtered_output_bytes(contents, filters,
2417
ContentFilterContext(tree_path, tree))
2418
tt.create_file(contents, trans_id)
2419
pb.update('Adding file contents', count + offset, total)
2422
def _reparent_children(tt, old_parent, new_parent):
2423
for child in tt.iter_tree_children(old_parent):
2424
tt.adjust_path(tt.final_name(child), new_parent, child)
2426
def _reparent_transform_children(tt, old_parent, new_parent):
2427
by_parent = tt.by_parent()
2428
for child in by_parent[old_parent]:
2429
tt.adjust_path(tt.final_name(child), new_parent, child)
2430
return by_parent[old_parent]
2432
def _content_match(tree, entry, file_id, kind, target_path):
2433
if entry.kind != kind:
2435
if entry.kind == "directory":
2437
if entry.kind == "file":
2438
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2440
elif entry.kind == "symlink":
2441
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2446
def resolve_checkout(tt, conflicts, divert):
2447
new_conflicts = set()
2448
for c_type, conflict in ((c[0], c) for c in conflicts):
2449
# Anything but a 'duplicate' would indicate programmer error
2450
if c_type != 'duplicate':
2451
raise AssertionError(c_type)
2452
# Now figure out which is new and which is old
2453
if tt.new_contents(conflict[1]):
2454
new_file = conflict[1]
2455
old_file = conflict[2]
2457
new_file = conflict[2]
2458
old_file = conflict[1]
2460
# We should only get here if the conflict wasn't completely
2462
final_parent = tt.final_parent(old_file)
2463
if new_file in divert:
2464
new_name = tt.final_name(old_file)+'.diverted'
2465
tt.adjust_path(new_name, final_parent, new_file)
2466
new_conflicts.add((c_type, 'Diverted to',
2467
new_file, old_file))
2469
new_name = tt.final_name(old_file)+'.moved'
2470
tt.adjust_path(new_name, final_parent, old_file)
2471
new_conflicts.add((c_type, 'Moved existing file to',
2472
old_file, new_file))
2473
return new_conflicts
2476
def new_by_entry(tt, entry, parent_id, tree):
2477
"""Create a new file according to its inventory entry"""
2481
contents = tree.get_file(entry.file_id).readlines()
2482
executable = tree.is_executable(entry.file_id)
2483
return tt.new_file(name, parent_id, contents, entry.file_id,
2485
elif kind in ('directory', 'tree-reference'):
2486
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2487
if kind == 'tree-reference':
2488
tt.set_tree_reference(entry.reference_revision, trans_id)
2490
elif kind == 'symlink':
2491
target = tree.get_symlink_target(entry.file_id)
2492
return tt.new_symlink(name, parent_id, target, entry.file_id)
2494
raise errors.BadFileKindError(name, kind)
2497
@deprecated_function(deprecated_in((1, 9, 0)))
2498
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2499
"""Create new file contents according to an inventory entry.
2501
DEPRECATED. Use create_from_tree instead.
2503
if entry.kind == "file":
2505
lines = tree.get_file(entry.file_id).readlines()
2506
tt.create_file(lines, trans_id, mode_id=mode_id)
2507
elif entry.kind == "symlink":
2508
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2509
elif entry.kind == "directory":
2510
tt.create_directory(trans_id)
2513
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2514
filter_tree_path=None):
2515
"""Create new file contents according to tree contents.
2517
:param filter_tree_path: the tree path to use to lookup
2518
content filters to apply to the bytes output in the working tree.
2519
This only applies if the working tree supports content filtering.
2521
kind = tree.kind(file_id)
2522
if kind == 'directory':
2523
tt.create_directory(trans_id)
2524
elif kind == "file":
2526
tree_file = tree.get_file(file_id)
2528
bytes = tree_file.readlines()
2532
if wt.supports_content_filtering() and filter_tree_path is not None:
2533
filters = wt._content_filter_stack(filter_tree_path)
2534
bytes = filtered_output_bytes(bytes, filters,
2535
ContentFilterContext(filter_tree_path, tree))
2536
tt.create_file(bytes, trans_id)
2537
elif kind == "symlink":
2538
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2540
raise AssertionError('Unknown kind %r' % kind)
2543
def create_entry_executability(tt, entry, trans_id):
2544
"""Set the executability of a trans_id according to an inventory entry"""
2545
if entry.kind == "file":
2546
tt.set_executability(entry.executable, trans_id)
2549
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2550
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2553
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2554
"""Produce a backup-style name that appears to be available"""
2558
yield "%s.~%d~" % (name, counter)
2560
for new_name in name_gen():
2561
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2565
def _entry_changes(file_id, entry, working_tree):
2566
"""Determine in which ways the inventory entry has changed.
2568
Returns booleans: has_contents, content_mod, meta_mod
2569
has_contents means there are currently contents, but they differ
2570
contents_mod means contents need to be modified
2571
meta_mod means the metadata needs to be modified
2573
cur_entry = working_tree.inventory[file_id]
2575
working_kind = working_tree.kind(file_id)
2578
has_contents = False
2581
if has_contents is True:
2582
if entry.kind != working_kind:
2583
contents_mod, meta_mod = True, False
2585
cur_entry._read_tree_state(working_tree.id2path(file_id),
2587
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2588
cur_entry._forget_tree_state()
2589
return has_contents, contents_mod, meta_mod
2592
def revert(working_tree, target_tree, filenames, backups=False,
2593
pb=None, change_reporter=None):
2594
"""Revert a working tree's contents to those of a target tree."""
2595
target_tree.lock_read()
2596
pb = ui.ui_factory.nested_progress_bar()
2597
tt = TreeTransform(working_tree, pb)
2599
pp = ProgressPhase("Revert phase", 3, pb)
2600
conflicts, merge_modified = _prepare_revert_transform(
2601
working_tree, target_tree, tt, filenames, backups, pp)
2603
change_reporter = delta._ChangeReporter(
2604
unversioned_filter=working_tree.is_ignored)
2605
delta.report_changes(tt.iter_changes(), change_reporter)
2606
for conflict in conflicts:
2610
working_tree.set_merge_modified(merge_modified)
2612
target_tree.unlock()
2618
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2619
backups, pp, basis_tree=None,
2620
merge_modified=None):
2621
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2623
if merge_modified is None:
2624
merge_modified = working_tree.merge_modified()
2625
merge_modified = _alter_files(working_tree, target_tree, tt,
2626
child_pb, filenames, backups,
2627
merge_modified, basis_tree)
2630
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2632
raw_conflicts = resolve_conflicts(tt, child_pb,
2633
lambda t, c: conflict_pass(t, c, target_tree))
2636
conflicts = cook_conflicts(raw_conflicts, tt)
2637
return conflicts, merge_modified
2640
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2641
backups, merge_modified, basis_tree=None):
2642
if basis_tree is not None:
2643
basis_tree.lock_read()
2644
change_list = target_tree.iter_changes(working_tree,
2645
specific_files=specific_files, pb=pb)
2646
if target_tree.get_root_id() is None:
2652
for id_num, (file_id, path, changed_content, versioned, parent, name,
2653
kind, executable) in enumerate(change_list):
2654
if skip_root and file_id[0] is not None and parent[0] is None:
2656
trans_id = tt.trans_id_file_id(file_id)
2659
keep_content = False
2660
if kind[0] == 'file' and (backups or kind[1] is None):
2661
wt_sha1 = working_tree.get_file_sha1(file_id)
2662
if merge_modified.get(file_id) != wt_sha1:
2663
# acquire the basis tree lazily to prevent the
2664
# expense of accessing it when it's not needed ?
2665
# (Guessing, RBC, 200702)
2666
if basis_tree is None:
2667
basis_tree = working_tree.basis_tree()
2668
basis_tree.lock_read()
2669
if file_id in basis_tree:
2670
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2672
elif kind[1] is None and not versioned[1]:
2674
if kind[0] is not None:
2675
if not keep_content:
2676
tt.delete_contents(trans_id)
2677
elif kind[1] is not None:
2678
parent_trans_id = tt.trans_id_file_id(parent[0])
2679
by_parent = tt.by_parent()
2680
backup_name = _get_backup_name(name[0], by_parent,
2681
parent_trans_id, tt)
2682
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2683
new_trans_id = tt.create_path(name[0], parent_trans_id)
2684
if versioned == (True, True):
2685
tt.unversion_file(trans_id)
2686
tt.version_file(file_id, new_trans_id)
2687
# New contents should have the same unix perms as old
2690
trans_id = new_trans_id
2691
if kind[1] in ('directory', 'tree-reference'):
2692
tt.create_directory(trans_id)
2693
if kind[1] == 'tree-reference':
2694
revision = target_tree.get_reference_revision(file_id,
2696
tt.set_tree_reference(revision, trans_id)
2697
elif kind[1] == 'symlink':
2698
tt.create_symlink(target_tree.get_symlink_target(file_id),
2700
elif kind[1] == 'file':
2701
deferred_files.append((file_id, (trans_id, mode_id)))
2702
if basis_tree is None:
2703
basis_tree = working_tree.basis_tree()
2704
basis_tree.lock_read()
2705
new_sha1 = target_tree.get_file_sha1(file_id)
2706
if (file_id in basis_tree and new_sha1 ==
2707
basis_tree.get_file_sha1(file_id)):
2708
if file_id in merge_modified:
2709
del merge_modified[file_id]
2711
merge_modified[file_id] = new_sha1
2713
# preserve the execute bit when backing up
2714
if keep_content and executable[0] == executable[1]:
2715
tt.set_executability(executable[1], trans_id)
2716
elif kind[1] is not None:
2717
raise AssertionError(kind[1])
2718
if versioned == (False, True):
2719
tt.version_file(file_id, trans_id)
2720
if versioned == (True, False):
2721
tt.unversion_file(trans_id)
2722
if (name[1] is not None and
2723
(name[0] != name[1] or parent[0] != parent[1])):
2724
if name[1] == '' and parent[1] is None:
2725
parent_trans = ROOT_PARENT
2727
parent_trans = tt.trans_id_file_id(parent[1])
2728
if parent[0] is None and versioned[0]:
2729
tt.adjust_root_path(name[1], parent_trans)
2731
tt.adjust_path(name[1], parent_trans, trans_id)
2732
if executable[0] != executable[1] and kind[1] == "file":
2733
tt.set_executability(executable[1], trans_id)
2734
if working_tree.supports_content_filtering():
2735
for index, ((trans_id, mode_id), bytes) in enumerate(
2736
target_tree.iter_files_bytes(deferred_files)):
2737
file_id = deferred_files[index][0]
2738
# We're reverting a tree to the target tree so using the
2739
# target tree to find the file path seems the best choice
2740
# here IMO - Ian C 27/Oct/2009
2741
filter_tree_path = target_tree.id2path(file_id)
2742
filters = working_tree._content_filter_stack(filter_tree_path)
2743
bytes = filtered_output_bytes(bytes, filters,
2744
ContentFilterContext(filter_tree_path, working_tree))
2745
tt.create_file(bytes, trans_id, mode_id)
2747
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2749
tt.create_file(bytes, trans_id, mode_id)
2750
tt.fixup_new_roots()
2752
if basis_tree is not None:
2754
return merge_modified
2757
def resolve_conflicts(tt, pb=None, pass_func=None):
2758
"""Make many conflict-resolution attempts, but die if they fail"""
2759
if pass_func is None:
2760
pass_func = conflict_pass
2761
new_conflicts = set()
2762
pb = ui.ui_factory.nested_progress_bar()
2765
pb.update('Resolution pass', n+1, 10)
2766
conflicts = tt.find_conflicts()
2767
if len(conflicts) == 0:
2768
return new_conflicts
2769
new_conflicts.update(pass_func(tt, conflicts))
2770
raise MalformedTransform(conflicts=conflicts)
2775
def conflict_pass(tt, conflicts, path_tree=None):
2776
"""Resolve some classes of conflicts.
2778
:param tt: The transform to resolve conflicts in
2779
:param conflicts: The conflicts to resolve
2780
:param path_tree: A Tree to get supplemental paths from
2782
new_conflicts = set()
2783
for c_type, conflict in ((c[0], c) for c in conflicts):
2784
if c_type == 'duplicate id':
2785
tt.unversion_file(conflict[1])
2786
new_conflicts.add((c_type, 'Unversioned existing file',
2787
conflict[1], conflict[2], ))
2788
elif c_type == 'duplicate':
2789
# files that were renamed take precedence
2790
final_parent = tt.final_parent(conflict[1])
2791
if tt.path_changed(conflict[1]):
2792
existing_file, new_file = conflict[2], conflict[1]
2794
existing_file, new_file = conflict[1], conflict[2]
2795
new_name = tt.final_name(existing_file)+'.moved'
2796
tt.adjust_path(new_name, final_parent, existing_file)
2797
new_conflicts.add((c_type, 'Moved existing file to',
2798
existing_file, new_file))
2799
elif c_type == 'parent loop':
2800
# break the loop by undoing one of the ops that caused the loop
2802
while not tt.path_changed(cur):
2803
cur = tt.final_parent(cur)
2804
new_conflicts.add((c_type, 'Cancelled move', cur,
2805
tt.final_parent(cur),))
2806
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2808
elif c_type == 'missing parent':
2809
trans_id = conflict[1]
2811
tt.cancel_deletion(trans_id)
2812
new_conflicts.add(('deleting parent', 'Not deleting',
2817
tt.final_name(trans_id)
2819
if path_tree is not None:
2820
file_id = tt.final_file_id(trans_id)
2822
file_id = tt.inactive_file_id(trans_id)
2823
entry = path_tree.inventory[file_id]
2824
# special-case the other tree root (move its
2825
# children to current root)
2826
if entry.parent_id is None:
2828
moved = _reparent_transform_children(
2829
tt, trans_id, tt.root)
2831
new_conflicts.add((c_type, 'Moved to root',
2834
parent_trans_id = tt.trans_id_file_id(
2836
tt.adjust_path(entry.name, parent_trans_id,
2839
tt.create_directory(trans_id)
2840
new_conflicts.add((c_type, 'Created directory', trans_id))
2841
elif c_type == 'unversioned parent':
2842
file_id = tt.inactive_file_id(conflict[1])
2843
# special-case the other tree root (move its children instead)
2844
if path_tree and file_id in path_tree:
2845
if path_tree.inventory[file_id].parent_id is None:
2847
tt.version_file(file_id, conflict[1])
2848
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2849
elif c_type == 'non-directory parent':
2850
parent_id = conflict[1]
2851
parent_parent = tt.final_parent(parent_id)
2852
parent_name = tt.final_name(parent_id)
2853
parent_file_id = tt.final_file_id(parent_id)
2854
new_parent_id = tt.new_directory(parent_name + '.new',
2855
parent_parent, parent_file_id)
2856
_reparent_transform_children(tt, parent_id, new_parent_id)
2857
if parent_file_id is not None:
2858
tt.unversion_file(parent_id)
2859
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2860
elif c_type == 'versioning no contents':
2861
tt.cancel_versioning(conflict[1])
2862
return new_conflicts
2865
def cook_conflicts(raw_conflicts, tt):
2866
"""Generate a list of cooked conflicts, sorted by file path"""
2867
from bzrlib.conflicts import Conflict
2868
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2869
return sorted(conflict_iter, key=Conflict.sort_key)
2872
def iter_cook_conflicts(raw_conflicts, tt):
2873
from bzrlib.conflicts import Conflict
2875
for conflict in raw_conflicts:
2876
c_type = conflict[0]
2877
action = conflict[1]
2878
modified_path = fp.get_path(conflict[2])
2879
modified_id = tt.final_file_id(conflict[2])
2880
if len(conflict) == 3:
2881
yield Conflict.factory(c_type, action=action, path=modified_path,
2882
file_id=modified_id)
2885
conflicting_path = fp.get_path(conflict[3])
2886
conflicting_id = tt.final_file_id(conflict[3])
2887
yield Conflict.factory(c_type, action=action, path=modified_path,
2888
file_id=modified_id,
2889
conflict_path=conflicting_path,
2890
conflict_file_id=conflicting_id)
2893
class _FileMover(object):
2894
"""Moves and deletes files for TreeTransform, tracking operations"""
2897
self.past_renames = []
2898
self.pending_deletions = []
2900
def rename(self, from_, to):
2901
"""Rename a file from one path to another. Functions like os.rename"""
2903
os.rename(from_, to)
2905
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2906
raise errors.FileExists(to, str(e))
2908
self.past_renames.append((from_, to))
2910
def pre_delete(self, from_, to):
2911
"""Rename a file out of the way and mark it for deletion.
2913
Unlike os.unlink, this works equally well for files and directories.
2914
:param from_: The current file path
2915
:param to: A temporary path for the file
2917
self.rename(from_, to)
2918
self.pending_deletions.append(to)
2921
"""Reverse all renames that have been performed"""
2922
for from_, to in reversed(self.past_renames):
2923
os.rename(to, from_)
2924
# after rollback, don't reuse _FileMover
2926
pending_deletions = None
2928
def apply_deletions(self):
2929
"""Apply all marked deletions"""
2930
for path in self.pending_deletions:
2932
# after apply_deletions, don't reuse _FileMover
2934
pending_deletions = None
added
removed
bzrlib/transform.py
