1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from stat import S_ISREG
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
31
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
32
ReusingTransform, NotVersionedError, CantMoveRoot,
33
ExistingLimbo, ImmortalLimbo, NoFinalPath,
35
from bzrlib.inventory import InventoryEntry
36
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
37
delete_any, has_symlinks)
38
from bzrlib.progress import DummyProgress, ProgressPhase
39
from bzrlib.symbol_versioning import (
44
from bzrlib.trace import mutter, warning
45
from bzrlib import tree
47
import bzrlib.urlutils as urlutils
50
ROOT_PARENT = "root-parent"
53
def unique_add(map, key, value):
55
raise DuplicateKey(key=key)
59
class _TransformResults(object):
60
def __init__(self, modified_paths, rename_count):
62
self.modified_paths = modified_paths
63
self.rename_count = rename_count
66
class TreeTransformBase(object):
67
"""The base class for TreeTransform and TreeTransformBase"""
69
def __init__(self, tree, limbodir, pb=DummyProgress(),
73
:param tree: The tree that will be transformed, but not necessarily
75
:param limbodir: A directory where new files can be stored until
76
they are installed in their proper places
77
:param pb: A ProgressBar indicating how much progress is being made
78
:param case_sensitive: If True, the target of the transform is
79
case sensitive, not just case preserving.
83
self._limbodir = limbodir
84
self._deletiondir = None
86
# mapping of trans_id -> new basename
88
# mapping of trans_id -> new parent trans_id
90
# mapping of trans_id with new contents -> new file_kind
91
self._new_contents = {}
92
# A mapping of transform ids to their limbo filename
93
self._limbo_files = {}
94
# A mapping of transform ids to a set of the transform ids of children
95
# that their limbo directory has
96
self._limbo_children = {}
97
# Map transform ids to maps of child filename to child transform id
98
self._limbo_children_names = {}
99
# List of transform ids that need to be renamed from limbo into place
100
self._needs_rename = set()
101
# Set of trans_ids whose contents will be removed
102
self._removed_contents = set()
103
# Mapping of trans_id -> new execute-bit value
104
self._new_executability = {}
105
# Mapping of trans_id -> new tree-reference value
106
self._new_reference_revision = {}
107
# Mapping of trans_id -> new file_id
109
# Mapping of old file-id -> trans_id
110
self._non_present_ids = {}
111
# Mapping of new file_id -> trans_id
113
# Set of file_ids that will be removed
114
self._removed_id = set()
115
# Mapping of path in old tree -> trans_id
116
self._tree_path_ids = {}
117
# Mapping trans_id -> path in old tree
118
self._tree_id_paths = {}
119
# Cache of realpath results, to speed up canonical_path
121
# Cache of relpath results, to speed up canonical_path
123
# The trans_id that will be used as the tree root
124
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
125
# Indictor of whether the transform has been applied
129
# Whether the target is case sensitive
130
self._case_sensitive_target = case_sensitive
131
# A counter of how many files have been renamed
132
self.rename_count = 0
134
def __get_root(self):
135
return self._new_root
137
root = property(__get_root)
140
"""Release the working tree lock, if held, clean up limbo dir.
142
This is required if apply has not been invoked, but can be invoked
145
if self._tree is None:
148
entries = [(self._limbo_name(t), t, k) for t, k in
149
self._new_contents.iteritems()]
150
entries.sort(reverse=True)
151
for path, trans_id, kind in entries:
152
if kind == "directory":
157
os.rmdir(self._limbodir)
159
# We don't especially care *why* the dir is immortal.
160
raise ImmortalLimbo(self._limbodir)
162
if self._deletiondir is not None:
163
os.rmdir(self._deletiondir)
165
raise errors.ImmortalPendingDeletion(self._deletiondir)
170
def _assign_id(self):
171
"""Produce a new tranform id"""
172
new_id = "new-%s" % self._id_number
176
def create_path(self, name, parent):
177
"""Assign a transaction id to a new path"""
178
trans_id = self._assign_id()
179
unique_add(self._new_name, trans_id, name)
180
unique_add(self._new_parent, trans_id, parent)
183
def adjust_path(self, name, parent, trans_id):
184
"""Change the path that is assigned to a transaction id."""
185
if trans_id == self._new_root:
187
previous_parent = self._new_parent.get(trans_id)
188
previous_name = self._new_name.get(trans_id)
189
self._new_name[trans_id] = name
190
self._new_parent[trans_id] = parent
191
if (trans_id in self._limbo_files and
192
trans_id not in self._needs_rename):
193
self._rename_in_limbo([trans_id])
194
self._limbo_children[previous_parent].remove(trans_id)
195
del self._limbo_children_names[previous_parent][previous_name]
197
def _rename_in_limbo(self, trans_ids):
198
"""Fix limbo names so that the right final path is produced.
200
This means we outsmarted ourselves-- we tried to avoid renaming
201
these files later by creating them with their final names in their
202
final parents. But now the previous name or parent is no longer
203
suitable, so we have to rename them.
205
Even for trans_ids that have no new contents, we must remove their
206
entries from _limbo_files, because they are now stale.
208
for trans_id in trans_ids:
209
old_path = self._limbo_files.pop(trans_id)
210
if trans_id not in self._new_contents:
212
new_path = self._limbo_name(trans_id)
213
os.rename(old_path, new_path)
215
def adjust_root_path(self, name, parent):
216
"""Emulate moving the root by moving all children, instead.
218
We do this by undoing the association of root's transaction id with the
219
current tree. This allows us to create a new directory with that
220
transaction id. We unversion the root directory and version the
221
physically new directory, and hope someone versions the tree root
224
old_root = self._new_root
225
old_root_file_id = self.final_file_id(old_root)
226
# force moving all children of root
227
for child_id in self.iter_tree_children(old_root):
228
if child_id != parent:
229
self.adjust_path(self.final_name(child_id),
230
self.final_parent(child_id), child_id)
231
file_id = self.final_file_id(child_id)
232
if file_id is not None:
233
self.unversion_file(child_id)
234
self.version_file(file_id, child_id)
236
# the physical root needs a new transaction id
237
self._tree_path_ids.pop("")
238
self._tree_id_paths.pop(old_root)
239
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
240
if parent == old_root:
241
parent = self._new_root
242
self.adjust_path(name, parent, old_root)
243
self.create_directory(old_root)
244
self.version_file(old_root_file_id, old_root)
245
self.unversion_file(self._new_root)
247
def trans_id_tree_file_id(self, inventory_id):
248
"""Determine the transaction id of a working tree file.
250
This reflects only files that already exist, not ones that will be
251
added by transactions.
253
path = self._tree.inventory.id2path(inventory_id)
254
return self.trans_id_tree_path(path)
256
def trans_id_file_id(self, file_id):
257
"""Determine or set the transaction id associated with a file ID.
258
A new id is only created for file_ids that were never present. If
259
a transaction has been unversioned, it is deliberately still returned.
260
(this will likely lead to an unversioned parent conflict.)
262
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
263
return self._r_new_id[file_id]
264
elif file_id in self._tree.inventory:
265
return self.trans_id_tree_file_id(file_id)
266
elif file_id in self._non_present_ids:
267
return self._non_present_ids[file_id]
269
trans_id = self._assign_id()
270
self._non_present_ids[file_id] = trans_id
273
def canonical_path(self, path):
274
"""Get the canonical tree-relative path"""
275
# don't follow final symlinks
276
abs = self._tree.abspath(path)
277
if abs in self._relpaths:
278
return self._relpaths[abs]
279
dirname, basename = os.path.split(abs)
280
if dirname not in self._realpaths:
281
self._realpaths[dirname] = os.path.realpath(dirname)
282
dirname = self._realpaths[dirname]
283
abs = pathjoin(dirname, basename)
284
if dirname in self._relpaths:
285
relpath = pathjoin(self._relpaths[dirname], basename)
286
relpath = relpath.rstrip('/\\')
288
relpath = self._tree.relpath(abs)
289
self._relpaths[abs] = relpath
292
def trans_id_tree_path(self, path):
293
"""Determine (and maybe set) the transaction ID for a tree path."""
294
path = self.canonical_path(path)
295
if path not in self._tree_path_ids:
296
self._tree_path_ids[path] = self._assign_id()
297
self._tree_id_paths[self._tree_path_ids[path]] = path
298
return self._tree_path_ids[path]
300
def get_tree_parent(self, trans_id):
301
"""Determine id of the parent in the tree."""
302
path = self._tree_id_paths[trans_id]
305
return self.trans_id_tree_path(os.path.dirname(path))
307
def create_file(self, contents, trans_id, mode_id=None):
308
"""Schedule creation of a new file.
312
Contents is an iterator of strings, all of which will be written
313
to the target destination.
315
New file takes the permissions of any existing file with that id,
316
unless mode_id is specified.
318
name = self._limbo_name(trans_id)
322
unique_add(self._new_contents, trans_id, 'file')
324
# Clean up the file, it never got registered so
325
# TreeTransform.finalize() won't clean it up.
330
f.writelines(contents)
333
self._set_mode(trans_id, mode_id, S_ISREG)
335
def _set_mode(self, trans_id, mode_id, typefunc):
336
"""Set the mode of new file contents.
337
The mode_id is the existing file to get the mode from (often the same
338
as trans_id). The operation is only performed if there's a mode match
339
according to typefunc.
344
old_path = self._tree_id_paths[mode_id]
348
mode = os.stat(self._tree.abspath(old_path)).st_mode
350
if e.errno == errno.ENOENT:
355
os.chmod(self._limbo_name(trans_id), mode)
357
def create_hardlink(self, path, trans_id):
358
"""Schedule creation of a hard link"""
359
name = self._limbo_name(trans_id)
362
unique_add(self._new_contents, trans_id, 'file')
364
# Clean up the file, it never got registered so
365
# TreeTransform.finalize() won't clean it up.
369
def create_directory(self, trans_id):
370
"""Schedule creation of a new directory.
372
See also new_directory.
374
os.mkdir(self._limbo_name(trans_id))
375
unique_add(self._new_contents, trans_id, 'directory')
377
def create_symlink(self, target, trans_id):
378
"""Schedule creation of a new symbolic link.
380
target is a bytestring.
381
See also new_symlink.
384
os.symlink(target, self._limbo_name(trans_id))
385
unique_add(self._new_contents, trans_id, 'symlink')
388
path = FinalPaths(self).get_path(trans_id)
391
raise UnableCreateSymlink(path=path)
393
def cancel_creation(self, trans_id):
394
"""Cancel the creation of new file contents."""
395
del self._new_contents[trans_id]
396
children = self._limbo_children.get(trans_id)
397
# if this is a limbo directory with children, move them before removing
399
if children is not None:
400
self._rename_in_limbo(children)
401
del self._limbo_children[trans_id]
402
del self._limbo_children_names[trans_id]
403
delete_any(self._limbo_name(trans_id))
405
def delete_contents(self, trans_id):
406
"""Schedule the contents of a path entry for deletion"""
407
self.tree_kind(trans_id)
408
self._removed_contents.add(trans_id)
410
def cancel_deletion(self, trans_id):
411
"""Cancel a scheduled deletion"""
412
self._removed_contents.remove(trans_id)
414
def unversion_file(self, trans_id):
415
"""Schedule a path entry to become unversioned"""
416
self._removed_id.add(trans_id)
418
def delete_versioned(self, trans_id):
419
"""Delete and unversion a versioned file"""
420
self.delete_contents(trans_id)
421
self.unversion_file(trans_id)
423
def set_executability(self, executability, trans_id):
424
"""Schedule setting of the 'execute' bit
425
To unschedule, set to None
427
if executability is None:
428
del self._new_executability[trans_id]
430
unique_add(self._new_executability, trans_id, executability)
432
def set_tree_reference(self, revision_id, trans_id):
433
"""Set the reference associated with a directory"""
434
unique_add(self._new_reference_revision, trans_id, revision_id)
436
def version_file(self, file_id, trans_id):
437
"""Schedule a file to become versioned."""
438
assert file_id is not None
439
unique_add(self._new_id, trans_id, file_id)
440
unique_add(self._r_new_id, file_id, trans_id)
442
def cancel_versioning(self, trans_id):
443
"""Undo a previous versioning of a file"""
444
file_id = self._new_id[trans_id]
445
del self._new_id[trans_id]
446
del self._r_new_id[file_id]
449
"""Determine the paths of all new and changed files"""
451
fp = FinalPaths(self)
452
for id_set in (self._new_name, self._new_parent, self._new_contents,
453
self._new_id, self._new_executability):
454
new_ids.update(id_set)
455
new_paths = [(fp.get_path(t), t) for t in new_ids]
459
def tree_kind(self, trans_id):
460
"""Determine the file kind in the working tree.
462
Raises NoSuchFile if the file does not exist
464
path = self._tree_id_paths.get(trans_id)
466
raise NoSuchFile(None)
468
return file_kind(self._tree.abspath(path))
470
if e.errno != errno.ENOENT:
473
raise NoSuchFile(path)
475
def final_kind(self, trans_id):
476
"""Determine the final file kind, after any changes applied.
478
Raises NoSuchFile if the file does not exist/has no contents.
479
(It is conceivable that a path would be created without the
480
corresponding contents insertion command)
482
if trans_id in self._new_contents:
483
return self._new_contents[trans_id]
484
elif trans_id in self._removed_contents:
485
raise NoSuchFile(None)
487
return self.tree_kind(trans_id)
489
def tree_file_id(self, trans_id):
490
"""Determine the file id associated with the trans_id in the tree"""
492
path = self._tree_id_paths[trans_id]
494
# the file is a new, unversioned file, or invalid trans_id
496
# the file is old; the old id is still valid
497
if self._new_root == trans_id:
498
return self._tree.get_root_id()
499
return self._tree.inventory.path2id(path)
501
def final_file_id(self, trans_id):
502
"""Determine the file id after any changes are applied, or None.
504
None indicates that the file will not be versioned after changes are
508
# there is a new id for this file
509
assert self._new_id[trans_id] is not None
510
return self._new_id[trans_id]
512
if trans_id in self._removed_id:
514
return self.tree_file_id(trans_id)
516
def inactive_file_id(self, trans_id):
517
"""Return the inactive file_id associated with a transaction id.
518
That is, the one in the tree or in non_present_ids.
519
The file_id may actually be active, too.
521
file_id = self.tree_file_id(trans_id)
522
if file_id is not None:
524
for key, value in self._non_present_ids.iteritems():
525
if value == trans_id:
528
def final_parent(self, trans_id):
529
"""Determine the parent file_id, after any changes are applied.
531
ROOT_PARENT is returned for the tree root.
534
return self._new_parent[trans_id]
536
return self.get_tree_parent(trans_id)
538
def final_name(self, trans_id):
539
"""Determine the final filename, after all changes are applied."""
541
return self._new_name[trans_id]
544
return os.path.basename(self._tree_id_paths[trans_id])
546
raise NoFinalPath(trans_id, self)
549
"""Return a map of parent: children for known parents.
551
Only new paths and parents of tree files with assigned ids are used.
554
items = list(self._new_parent.iteritems())
555
items.extend((t, self.final_parent(t)) for t in
556
self._tree_id_paths.keys())
557
for trans_id, parent_id in items:
558
if parent_id not in by_parent:
559
by_parent[parent_id] = set()
560
by_parent[parent_id].add(trans_id)
563
def path_changed(self, trans_id):
564
"""Return True if a trans_id's path has changed."""
565
return (trans_id in self._new_name) or (trans_id in self._new_parent)
567
def new_contents(self, trans_id):
568
return (trans_id in self._new_contents)
570
def find_conflicts(self):
571
"""Find any violations of inventory or filesystem invariants"""
572
if self._done is True:
573
raise ReusingTransform()
575
# ensure all children of all existent parents are known
576
# all children of non-existent parents are known, by definition.
577
self._add_tree_children()
578
by_parent = self.by_parent()
579
conflicts.extend(self._unversioned_parents(by_parent))
580
conflicts.extend(self._parent_loops())
581
conflicts.extend(self._duplicate_entries(by_parent))
582
conflicts.extend(self._duplicate_ids())
583
conflicts.extend(self._parent_type_conflicts(by_parent))
584
conflicts.extend(self._improper_versioning())
585
conflicts.extend(self._executability_conflicts())
586
conflicts.extend(self._overwrite_conflicts())
589
def _add_tree_children(self):
590
"""Add all the children of all active parents to the known paths.
592
Active parents are those which gain children, and those which are
593
removed. This is a necessary first step in detecting conflicts.
595
parents = self.by_parent().keys()
596
parents.extend([t for t in self._removed_contents if
597
self.tree_kind(t) == 'directory'])
598
for trans_id in self._removed_id:
599
file_id = self.tree_file_id(trans_id)
600
if file_id is not None:
601
if self._tree.inventory[file_id].kind == 'directory':
602
parents.append(trans_id)
603
elif self.tree_kind(trans_id) == 'directory':
604
parents.append(trans_id)
606
for parent_id in parents:
607
# ensure that all children are registered with the transaction
608
list(self.iter_tree_children(parent_id))
610
def iter_tree_children(self, parent_id):
611
"""Iterate through the entry's tree children, if any"""
613
path = self._tree_id_paths[parent_id]
617
children = os.listdir(self._tree.abspath(path))
619
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
623
for child in children:
624
childpath = joinpath(path, child)
625
if self._tree.is_control_filename(childpath):
627
yield self.trans_id_tree_path(childpath)
629
def has_named_child(self, by_parent, parent_id, name):
631
children = by_parent[parent_id]
634
for child in children:
635
if self.final_name(child) == name:
638
path = self._tree_id_paths[parent_id]
641
childpath = joinpath(path, name)
642
child_id = self._tree_path_ids.get(childpath)
644
return lexists(self._tree.abspath(childpath))
646
if self.final_parent(child_id) != parent_id:
648
if child_id in self._removed_contents:
649
# XXX What about dangling file-ids?
654
def _parent_loops(self):
655
"""No entry should be its own ancestor"""
657
for trans_id in self._new_parent:
660
while parent_id is not ROOT_PARENT:
663
parent_id = self.final_parent(parent_id)
666
if parent_id == trans_id:
667
conflicts.append(('parent loop', trans_id))
668
if parent_id in seen:
672
def _unversioned_parents(self, by_parent):
673
"""If parent directories are versioned, children must be versioned."""
675
for parent_id, children in by_parent.iteritems():
676
if parent_id is ROOT_PARENT:
678
if self.final_file_id(parent_id) is not None:
680
for child_id in children:
681
if self.final_file_id(child_id) is not None:
682
conflicts.append(('unversioned parent', parent_id))
686
def _improper_versioning(self):
687
"""Cannot version a file with no contents, or a bad type.
689
However, existing entries with no contents are okay.
692
for trans_id in self._new_id.iterkeys():
694
kind = self.final_kind(trans_id)
696
conflicts.append(('versioning no contents', trans_id))
698
if not InventoryEntry.versionable_kind(kind):
699
conflicts.append(('versioning bad kind', trans_id, kind))
702
def _executability_conflicts(self):
703
"""Check for bad executability changes.
705
Only versioned files may have their executability set, because
706
1. only versioned entries can have executability under windows
707
2. only files can be executable. (The execute bit on a directory
708
does not indicate searchability)
711
for trans_id in self._new_executability:
712
if self.final_file_id(trans_id) is None:
713
conflicts.append(('unversioned executability', trans_id))
716
non_file = self.final_kind(trans_id) != "file"
720
conflicts.append(('non-file executability', trans_id))
723
def _overwrite_conflicts(self):
724
"""Check for overwrites (not permitted on Win32)"""
726
for trans_id in self._new_contents:
728
self.tree_kind(trans_id)
731
if trans_id not in self._removed_contents:
732
conflicts.append(('overwrite', trans_id,
733
self.final_name(trans_id)))
736
def _duplicate_entries(self, by_parent):
737
"""No directory may have two entries with the same name."""
739
if (self._new_name, self._new_parent) == ({}, {}):
741
for children in by_parent.itervalues():
742
name_ids = [(self.final_name(t), t) for t in children]
743
if not self._case_sensitive_target:
744
name_ids = [(n.lower(), t) for n, t in name_ids]
748
for name, trans_id in name_ids:
750
kind = self.final_kind(trans_id)
753
file_id = self.final_file_id(trans_id)
754
if kind is None and file_id is None:
756
if name == last_name:
757
conflicts.append(('duplicate', last_trans_id, trans_id,
760
last_trans_id = trans_id
763
def _duplicate_ids(self):
764
"""Each inventory id may only be used once"""
766
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
768
active_tree_ids = set((f for f in self._tree.inventory if
769
f not in removed_tree_ids))
770
for trans_id, file_id in self._new_id.iteritems():
771
if file_id in active_tree_ids:
772
old_trans_id = self.trans_id_tree_file_id(file_id)
773
conflicts.append(('duplicate id', old_trans_id, trans_id))
776
def _parent_type_conflicts(self, by_parent):
777
"""parents must have directory 'contents'."""
779
for parent_id, children in by_parent.iteritems():
780
if parent_id is ROOT_PARENT:
782
if not self._any_contents(children):
784
for child in children:
786
self.final_kind(child)
790
kind = self.final_kind(parent_id)
794
conflicts.append(('missing parent', parent_id))
795
elif kind != "directory":
796
conflicts.append(('non-directory parent', parent_id))
799
def _any_contents(self, trans_ids):
800
"""Return true if any of the trans_ids, will have contents."""
801
for trans_id in trans_ids:
803
kind = self.final_kind(trans_id)
809
def _limbo_name(self, trans_id):
810
"""Generate the limbo name of a file"""
811
limbo_name = self._limbo_files.get(trans_id)
812
if limbo_name is not None:
814
parent = self._new_parent.get(trans_id)
815
# if the parent directory is already in limbo (e.g. when building a
816
# tree), choose a limbo name inside the parent, to reduce further
818
use_direct_path = False
819
if self._new_contents.get(parent) == 'directory':
820
filename = self._new_name.get(trans_id)
821
if filename is not None:
822
if parent not in self._limbo_children:
823
self._limbo_children[parent] = set()
824
self._limbo_children_names[parent] = {}
825
use_direct_path = True
826
# the direct path can only be used if no other file has
827
# already taken this pathname, i.e. if the name is unused, or
828
# if it is already associated with this trans_id.
829
elif self._case_sensitive_target:
830
if (self._limbo_children_names[parent].get(filename)
831
in (trans_id, None)):
832
use_direct_path = True
834
for l_filename, l_trans_id in\
835
self._limbo_children_names[parent].iteritems():
836
if l_trans_id == trans_id:
838
if l_filename.lower() == filename.lower():
841
use_direct_path = True
844
limbo_name = pathjoin(self._limbo_files[parent], filename)
845
self._limbo_children[parent].add(trans_id)
846
self._limbo_children_names[parent][filename] = trans_id
848
limbo_name = pathjoin(self._limbodir, trans_id)
849
self._needs_rename.add(trans_id)
850
self._limbo_files[trans_id] = limbo_name
853
def _set_executability(self, path, entry, trans_id):
854
"""Set the executability of versioned files """
855
new_executability = self._new_executability[trans_id]
856
entry.executable = new_executability
857
if supports_executable():
858
abspath = self._tree.abspath(path)
859
current_mode = os.stat(abspath).st_mode
860
if new_executability:
863
to_mode = current_mode | (0100 & ~umask)
864
# Enable x-bit for others only if they can read it.
865
if current_mode & 0004:
866
to_mode |= 0001 & ~umask
867
if current_mode & 0040:
868
to_mode |= 0010 & ~umask
870
to_mode = current_mode & ~0111
871
os.chmod(abspath, to_mode)
873
def _new_entry(self, name, parent_id, file_id):
874
"""Helper function to create a new filesystem entry."""
875
trans_id = self.create_path(name, parent_id)
876
if file_id is not None:
877
self.version_file(file_id, trans_id)
880
def new_file(self, name, parent_id, contents, file_id=None,
882
"""Convenience method to create files.
884
name is the name of the file to create.
885
parent_id is the transaction id of the parent directory of the file.
886
contents is an iterator of bytestrings, which will be used to produce
888
:param file_id: The inventory ID of the file, if it is to be versioned.
889
:param executable: Only valid when a file_id has been supplied.
891
trans_id = self._new_entry(name, parent_id, file_id)
892
# TODO: rather than scheduling a set_executable call,
893
# have create_file create the file with the right mode.
894
self.create_file(contents, trans_id)
895
if executable is not None:
896
self.set_executability(executable, trans_id)
899
def new_directory(self, name, parent_id, file_id=None):
900
"""Convenience method to create directories.
902
name is the name of the directory to create.
903
parent_id is the transaction id of the parent directory of the
905
file_id is the inventory ID of the directory, if it is to be versioned.
907
trans_id = self._new_entry(name, parent_id, file_id)
908
self.create_directory(trans_id)
911
def new_symlink(self, name, parent_id, target, file_id=None):
912
"""Convenience method to create symbolic link.
914
name is the name of the symlink to create.
915
parent_id is the transaction id of the parent directory of the symlink.
916
target is a bytestring of the target of the symlink.
917
file_id is the inventory ID of the file, if it is to be versioned.
919
trans_id = self._new_entry(name, parent_id, file_id)
920
self.create_symlink(target, trans_id)
923
def _affected_ids(self):
924
"""Return the set of transform ids affected by the transform"""
925
trans_ids = set(self._removed_id)
926
trans_ids.update(self._new_id.keys())
927
trans_ids.update(self._removed_contents)
928
trans_ids.update(self._new_contents.keys())
929
trans_ids.update(self._new_executability.keys())
930
trans_ids.update(self._new_name.keys())
931
trans_ids.update(self._new_parent.keys())
934
def _get_file_id_maps(self):
935
"""Return mapping of file_ids to trans_ids in the to and from states"""
936
trans_ids = self._affected_ids()
939
# Build up two dicts: trans_ids associated with file ids in the
940
# FROM state, vs the TO state.
941
for trans_id in trans_ids:
942
from_file_id = self.tree_file_id(trans_id)
943
if from_file_id is not None:
944
from_trans_ids[from_file_id] = trans_id
945
to_file_id = self.final_file_id(trans_id)
946
if to_file_id is not None:
947
to_trans_ids[to_file_id] = trans_id
948
return from_trans_ids, to_trans_ids
950
def _from_file_data(self, from_trans_id, from_versioned, file_id):
951
"""Get data about a file in the from (tree) state
953
Return a (name, parent, kind, executable) tuple
955
from_path = self._tree_id_paths.get(from_trans_id)
957
# get data from working tree if versioned
958
from_entry = self._tree.inventory[file_id]
959
from_name = from_entry.name
960
from_parent = from_entry.parent_id
963
if from_path is None:
964
# File does not exist in FROM state
968
# File exists, but is not versioned. Have to use path-
970
from_name = os.path.basename(from_path)
971
tree_parent = self.get_tree_parent(from_trans_id)
972
from_parent = self.tree_file_id(tree_parent)
973
if from_path is not None:
974
from_kind, from_executable, from_stats = \
975
self._tree._comparison_data(from_entry, from_path)
978
from_executable = False
979
return from_name, from_parent, from_kind, from_executable
981
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
982
"""Get data about a file in the to (target) state
984
Return a (name, parent, kind, executable) tuple
986
to_name = self.final_name(to_trans_id)
988
to_kind = self.final_kind(to_trans_id)
991
to_parent = self.final_file_id(self.final_parent(to_trans_id))
992
if to_trans_id in self._new_executability:
993
to_executable = self._new_executability[to_trans_id]
994
elif to_trans_id == from_trans_id:
995
to_executable = from_executable
997
to_executable = False
998
return to_name, to_parent, to_kind, to_executable
1000
def _iter_changes(self):
1001
"""Produce output in the same format as Tree._iter_changes.
1003
Will produce nonsensical results if invoked while inventory/filesystem
1004
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1006
This reads the Transform, but only reproduces changes involving a
1007
file_id. Files that are not versioned in either of the FROM or TO
1008
states are not reflected.
1010
final_paths = FinalPaths(self)
1011
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1013
# Now iterate through all active file_ids
1014
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1016
from_trans_id = from_trans_ids.get(file_id)
1017
# find file ids, and determine versioning state
1018
if from_trans_id is None:
1019
from_versioned = False
1020
from_trans_id = to_trans_ids[file_id]
1022
from_versioned = True
1023
to_trans_id = to_trans_ids.get(file_id)
1024
if to_trans_id is None:
1025
to_versioned = False
1026
to_trans_id = from_trans_id
1030
from_name, from_parent, from_kind, from_executable = \
1031
self._from_file_data(from_trans_id, from_versioned, file_id)
1033
to_name, to_parent, to_kind, to_executable = \
1034
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1036
if not from_versioned:
1039
from_path = self._tree_id_paths.get(from_trans_id)
1040
if not to_versioned:
1043
to_path = final_paths.get_path(to_trans_id)
1044
if from_kind != to_kind:
1046
elif to_kind in ('file', 'symlink') and (
1047
to_trans_id != from_trans_id or
1048
to_trans_id in self._new_contents):
1050
if (not modified and from_versioned == to_versioned and
1051
from_parent==to_parent and from_name == to_name and
1052
from_executable == to_executable):
1054
results.append((file_id, (from_path, to_path), modified,
1055
(from_versioned, to_versioned),
1056
(from_parent, to_parent),
1057
(from_name, to_name),
1058
(from_kind, to_kind),
1059
(from_executable, to_executable)))
1060
return iter(sorted(results, key=lambda x:x[1]))
1062
def get_preview_tree(self):
1063
"""Return a tree representing the result of the transform.
1065
This tree only supports the subset of Tree functionality required
1066
by show_diff_trees. It must only be compared to tt._tree.
1068
return _PreviewTree(self)
1071
class TreeTransform(TreeTransformBase):
1072
"""Represent a tree transformation.
1074
This object is designed to support incremental generation of the transform,
1077
However, it gives optimum performance when parent directories are created
1078
before their contents. The transform is then able to put child files
1079
directly in their parent directory, avoiding later renames.
1081
It is easy to produce malformed transforms, but they are generally
1082
harmless. Attempting to apply a malformed transform will cause an
1083
exception to be raised before any modifications are made to the tree.
1085
Many kinds of malformed transforms can be corrected with the
1086
resolve_conflicts function. The remaining ones indicate programming error,
1087
such as trying to create a file with no path.
1089
Two sets of file creation methods are supplied. Convenience methods are:
1094
These are composed of the low-level methods:
1096
* create_file or create_directory or create_symlink
1100
Transform/Transaction ids
1101
-------------------------
1102
trans_ids are temporary ids assigned to all files involved in a transform.
1103
It's possible, even common, that not all files in the Tree have trans_ids.
1105
trans_ids are used because filenames and file_ids are not good enough
1106
identifiers; filenames change, and not all files have file_ids. File-ids
1107
are also associated with trans-ids, so that moving a file moves its
1110
trans_ids are only valid for the TreeTransform that generated them.
1114
Limbo is a temporary directory use to hold new versions of files.
1115
Files are added to limbo by create_file, create_directory, create_symlink,
1116
and their convenience variants (new_*). Files may be removed from limbo
1117
using cancel_creation. Files are renamed from limbo into their final
1118
location as part of TreeTransform.apply
1120
Limbo must be cleaned up, by either calling TreeTransform.apply or
1121
calling TreeTransform.finalize.
1123
Files are placed into limbo inside their parent directories, where
1124
possible. This reduces subsequent renames, and makes operations involving
1125
lots of files faster. This optimization is only possible if the parent
1126
directory is created *before* creating any of its children, so avoid
1127
creating children before parents, where possible.
1131
This temporary directory is used by _FileMover for storing files that are
1132
about to be deleted. In case of rollback, the files will be restored.
1133
FileMover does not delete files until it is sure that a rollback will not
1136
def __init__(self, tree, pb=DummyProgress()):
1137
"""Note: a tree_write lock is taken on the tree.
1139
Use TreeTransform.finalize() to release the lock (can be omitted if
1140
TreeTransform.apply() called).
1142
tree.lock_tree_write()
1145
control_files = tree._control_files
1146
limbodir = urlutils.local_path_from_url(
1147
control_files.controlfilename('limbo'))
1151
if e.errno == errno.EEXIST:
1152
raise ExistingLimbo(limbodir)
1153
deletiondir = urlutils.local_path_from_url(
1154
control_files.controlfilename('pending-deletion'))
1156
os.mkdir(deletiondir)
1158
if e.errno == errno.EEXIST:
1159
raise errors.ExistingPendingDeletion(deletiondir)
1164
TreeTransformBase.__init__(self, tree, limbodir, pb,
1165
tree.case_sensitive)
1166
self._deletiondir = deletiondir
1168
def apply(self, no_conflicts=False, _mover=None):
1169
"""Apply all changes to the inventory and filesystem.
1171
If filesystem or inventory conflicts are present, MalformedTransform
1174
If apply succeeds, finalize is not necessary.
1176
:param no_conflicts: if True, the caller guarantees there are no
1177
conflicts, so no check is made.
1178
:param _mover: Supply an alternate FileMover, for testing
1180
if not no_conflicts:
1181
conflicts = self.find_conflicts()
1182
if len(conflicts) != 0:
1183
raise MalformedTransform(conflicts=conflicts)
1184
inv = self._tree.inventory
1185
inventory_delta = []
1186
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1189
mover = _FileMover()
1193
child_pb.update('Apply phase', 0, 2)
1194
self._apply_removals(inv, inventory_delta, mover)
1195
child_pb.update('Apply phase', 1, 2)
1196
modified_paths = self._apply_insertions(inv, inventory_delta,
1202
mover.apply_deletions()
1205
self._tree.apply_inventory_delta(inventory_delta)
1208
return _TransformResults(modified_paths, self.rename_count)
1210
def _apply_removals(self, inv, inventory_delta, mover):
1211
"""Perform tree operations that remove directory/inventory names.
1213
That is, delete files that are to be deleted, and put any files that
1214
need renaming into limbo. This must be done in strict child-to-parent
1217
tree_paths = list(self._tree_path_ids.iteritems())
1218
tree_paths.sort(reverse=True)
1219
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1221
for num, data in enumerate(tree_paths):
1222
path, trans_id = data
1223
child_pb.update('removing file', num, len(tree_paths))
1224
full_path = self._tree.abspath(path)
1225
if trans_id in self._removed_contents:
1226
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1228
elif trans_id in self._new_name or trans_id in \
1231
mover.rename(full_path, self._limbo_name(trans_id))
1233
if e.errno != errno.ENOENT:
1236
self.rename_count += 1
1237
if trans_id in self._removed_id:
1238
if trans_id == self._new_root:
1239
file_id = self._tree.get_root_id()
1241
file_id = self.tree_file_id(trans_id)
1242
if file_id is not None:
1243
inventory_delta.append((path, None, file_id, None))
1247
def _apply_insertions(self, inv, inventory_delta, mover):
1248
"""Perform tree operations that insert directory/inventory names.
1250
That is, create any files that need to be created, and restore from
1251
limbo any files that needed renaming. This must be done in strict
1252
parent-to-child order.
1254
new_paths = self.new_paths()
1256
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1259
for num, (path, trans_id) in enumerate(new_paths):
1261
child_pb.update('adding file', num, len(new_paths))
1263
kind = self._new_contents[trans_id]
1265
kind = contents = None
1266
if trans_id in self._new_contents or \
1267
self.path_changed(trans_id):
1268
full_path = self._tree.abspath(path)
1269
if trans_id in self._needs_rename:
1271
mover.rename(self._limbo_name(trans_id), full_path)
1273
# We may be renaming a dangling inventory id
1274
if e.errno != errno.ENOENT:
1277
self.rename_count += 1
1278
if trans_id in self._new_contents:
1279
modified_paths.append(full_path)
1280
completed_new.append(trans_id)
1282
if trans_id in self._new_id:
1284
kind = file_kind(self._tree.abspath(path))
1285
if trans_id in self._new_reference_revision:
1286
new_entry = inventory.TreeReference(
1287
self._new_id[trans_id],
1288
self._new_name[trans_id],
1289
self.final_file_id(self._new_parent[trans_id]),
1290
None, self._new_reference_revision[trans_id])
1292
new_entry = inventory.make_entry(kind,
1293
self.final_name(trans_id),
1294
self.final_file_id(self.final_parent(trans_id)),
1295
self._new_id[trans_id])
1297
if trans_id in self._new_name or trans_id in\
1298
self._new_parent or\
1299
trans_id in self._new_executability:
1300
file_id = self.final_file_id(trans_id)
1301
if file_id is not None:
1302
entry = inv[file_id]
1303
new_entry = entry.copy()
1305
if trans_id in self._new_name or trans_id in\
1307
if new_entry is not None:
1308
new_entry.name = self.final_name(trans_id)
1309
parent = self.final_parent(trans_id)
1310
parent_id = self.final_file_id(parent)
1311
new_entry.parent_id = parent_id
1313
if trans_id in self._new_executability:
1314
self._set_executability(path, new_entry, trans_id)
1315
if new_entry is not None:
1316
if new_entry.file_id in inv:
1317
old_path = inv.id2path(new_entry.file_id)
1320
inventory_delta.append((old_path, path,
1325
for trans_id in completed_new:
1326
del self._new_contents[trans_id]
1327
return modified_paths
1330
class TransformPreview(TreeTransformBase):
1331
"""A TreeTransform for generating preview trees.
1333
Unlike TreeTransform, this version works when the input tree is a
1334
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1335
unversioned files in the input tree.
1338
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1340
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1341
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1343
def canonical_path(self, path):
1346
def tree_kind(self, trans_id):
1347
path = self._tree_id_paths.get(trans_id)
1349
raise NoSuchFile(None)
1350
file_id = self._tree.path2id(path)
1351
return self._tree.kind(file_id)
1353
def _set_mode(self, trans_id, mode_id, typefunc):
1354
"""Set the mode of new file contents.
1355
The mode_id is the existing file to get the mode from (often the same
1356
as trans_id). The operation is only performed if there's a mode match
1357
according to typefunc.
1359
# is it ok to ignore this? probably
1362
def iter_tree_children(self, parent_id):
1363
"""Iterate through the entry's tree children, if any"""
1365
path = self._tree_id_paths[parent_id]
1368
file_id = self.tree_file_id(parent_id)
1369
for child in self._tree.inventory[file_id].children.iterkeys():
1370
childpath = joinpath(path, child)
1371
yield self.trans_id_tree_path(childpath)
1374
class _PreviewTree(object):
1375
"""Partial implementation of Tree to support show_diff_trees"""
1377
def __init__(self, transform):
1378
self._transform = transform
1380
def lock_read(self):
1381
# Perhaps in theory, this should lock the TreeTransform?
1387
def _iter_changes(self, from_tree, include_unchanged=False,
1388
specific_files=None, pb=None, extra_trees=None,
1389
require_versioned=True, want_unversioned=False):
1390
"""See InterTree._iter_changes.
1392
This implementation does not support include_unchanged, specific_files,
1393
or want_unversioned. extra_trees, require_versioned, and pb are
1396
if from_tree is not self._transform._tree:
1397
raise ValueError('from_tree must be transform source tree.')
1398
if include_unchanged:
1399
raise ValueError('include_unchanged is not supported')
1400
if specific_files is not None:
1401
raise ValueError('specific_files is not supported')
1402
if want_unversioned:
1403
raise ValueError('want_unversioned is not supported')
1404
return self._transform._iter_changes()
1406
def kind(self, file_id):
1407
trans_id = self._transform.trans_id_file_id(file_id)
1408
return self._transform.final_kind(trans_id)
1410
def get_file_mtime(self, file_id, path=None):
1411
"""See Tree.get_file_mtime"""
1412
trans_id = self._transform.trans_id_file_id(file_id)
1413
name = self._transform._limbo_name(trans_id)
1414
return os.stat(name).st_mtime
1416
def get_file(self, file_id):
1417
"""See Tree.get_file"""
1418
trans_id = self._transform.trans_id_file_id(file_id)
1419
name = self._transform._limbo_name(trans_id)
1420
return open(name, 'rb')
1422
def get_symlink_target(self, file_id):
1423
"""See Tree.get_symlink_target"""
1424
trans_id = self._transform.trans_id_file_id(file_id)
1425
name = self._transform._limbo_name(trans_id)
1426
return os.readlink(name)
1428
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1429
"""See Tree.paths2ids"""
1433
def joinpath(parent, child):
1434
"""Join tree-relative paths, handling the tree root specially"""
1435
if parent is None or parent == "":
1438
return pathjoin(parent, child)
1441
class FinalPaths(object):
1442
"""Make path calculation cheap by memoizing paths.
1444
The underlying tree must not be manipulated between calls, or else
1445
the results will likely be incorrect.
1447
def __init__(self, transform):
1448
object.__init__(self)
1449
self._known_paths = {}
1450
self.transform = transform
1452
def _determine_path(self, trans_id):
1453
if trans_id == self.transform.root:
1455
name = self.transform.final_name(trans_id)
1456
parent_id = self.transform.final_parent(trans_id)
1457
if parent_id == self.transform.root:
1460
return pathjoin(self.get_path(parent_id), name)
1462
def get_path(self, trans_id):
1463
"""Find the final path associated with a trans_id"""
1464
if trans_id not in self._known_paths:
1465
self._known_paths[trans_id] = self._determine_path(trans_id)
1466
return self._known_paths[trans_id]
1469
def topology_sorted_ids(tree):
1470
"""Determine the topological order of the ids in a tree"""
1471
file_ids = list(tree)
1472
file_ids.sort(key=tree.id2path)
1476
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1477
"""Create working tree for a branch, using a TreeTransform.
1479
This function should be used on empty trees, having a tree root at most.
1480
(see merge and revert functionality for working with existing trees)
1482
Existing files are handled like so:
1484
- Existing bzrdirs take precedence over creating new items. They are
1485
created as '%s.diverted' % name.
1486
- Otherwise, if the content on disk matches the content we are building,
1487
it is silently replaced.
1488
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1490
:param tree: The tree to convert wt into a copy of
1491
:param wt: The working tree that files will be placed into
1492
:param accelerator_tree: A tree which can be used for retrieving file
1493
contents more quickly than tree itself, i.e. a workingtree. tree
1494
will be used for cases where accelerator_tree's content is different.
1495
:param hardlink: If true, hard-link files to accelerator_tree, where
1496
possible. accelerator_tree must implement abspath, i.e. be a
1499
wt.lock_tree_write()
1503
if accelerator_tree is not None:
1504
accelerator_tree.lock_read()
1506
return _build_tree(tree, wt, accelerator_tree, hardlink)
1508
if accelerator_tree is not None:
1509
accelerator_tree.unlock()
1516
def _build_tree(tree, wt, accelerator_tree, hardlink):
1517
"""See build_tree."""
1518
if len(wt.inventory) > 1: # more than just a root
1519
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1521
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1522
pp = ProgressPhase("Build phase", 2, top_pb)
1523
if tree.inventory.root is not None:
1524
# This is kind of a hack: we should be altering the root
1525
# as part of the regular tree shape diff logic.
1526
# The conditional test here is to avoid doing an
1527
# expensive operation (flush) every time the root id
1528
# is set within the tree, nor setting the root and thus
1529
# marking the tree as dirty, because we use two different
1530
# idioms here: tree interfaces and inventory interfaces.
1531
if wt.get_root_id() != tree.get_root_id():
1532
wt.set_root_id(tree.get_root_id())
1534
tt = TreeTransform(wt)
1538
file_trans_id[wt.get_root_id()] = \
1539
tt.trans_id_tree_file_id(wt.get_root_id())
1540
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1542
deferred_contents = []
1544
for num, (tree_path, entry) in \
1545
enumerate(tree.inventory.iter_entries_by_dir()):
1546
pb.update("Building tree", num - len(deferred_contents),
1547
len(tree.inventory))
1548
if entry.parent_id is None:
1551
file_id = entry.file_id
1552
target_path = wt.abspath(tree_path)
1554
kind = file_kind(target_path)
1558
if kind == "directory":
1560
bzrdir.BzrDir.open(target_path)
1561
except errors.NotBranchError:
1565
if (file_id not in divert and
1566
_content_match(tree, entry, file_id, kind,
1568
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1569
if kind == 'directory':
1571
if entry.parent_id not in file_trans_id:
1572
raise AssertionError(
1573
'entry %s parent id %r is not in file_trans_id %r'
1574
% (entry, entry.parent_id, file_trans_id))
1575
parent_id = file_trans_id[entry.parent_id]
1576
if entry.kind == 'file':
1577
# We *almost* replicate new_by_entry, so that we can defer
1578
# getting the file text, and get them all at once.
1579
trans_id = tt.create_path(entry.name, parent_id)
1580
file_trans_id[file_id] = trans_id
1581
tt.version_file(entry.file_id, trans_id)
1582
executable = tree.is_executable(entry.file_id, tree_path)
1583
if executable is not None:
1584
tt.set_executability(executable, trans_id)
1585
deferred_contents.append((entry.file_id, trans_id))
1587
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1590
new_trans_id = file_trans_id[file_id]
1591
old_parent = tt.trans_id_tree_path(tree_path)
1592
_reparent_children(tt, old_parent, new_trans_id)
1593
offset = num +1 - len(deferred_contents)
1594
_create_files(tt, tree, deferred_contents, pb, offset,
1595
accelerator_tree, hardlink)
1599
divert_trans = set(file_trans_id[f] for f in divert)
1600
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1601
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1602
conflicts = cook_conflicts(raw_conflicts, tt)
1603
for conflict in conflicts:
1606
wt.add_conflicts(conflicts)
1607
except errors.UnsupportedOperation:
1609
result = tt.apply(no_conflicts=True)
1616
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1618
total = len(desired_files) + offset
1619
if accelerator_tree is None:
1620
new_desired_files = desired_files
1622
iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
1623
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1624
in iter if not (c or e[0] != e[1]))
1625
new_desired_files = []
1627
for file_id, trans_id in desired_files:
1628
accelerator_path = unchanged.get(file_id)
1629
if accelerator_path is None:
1630
new_desired_files.append((file_id, trans_id))
1632
pb.update('Adding file contents', count+offset, total)
1634
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1637
contents = accelerator_tree.get_file(file_id, accelerator_path)
1639
tt.create_file(contents, trans_id)
1645
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1646
new_desired_files)):
1647
tt.create_file(contents, trans_id)
1648
pb.update('Adding file contents', count+offset, total)
1651
def _reparent_children(tt, old_parent, new_parent):
1652
for child in tt.iter_tree_children(old_parent):
1653
tt.adjust_path(tt.final_name(child), new_parent, child)
1655
def _reparent_transform_children(tt, old_parent, new_parent):
1656
by_parent = tt.by_parent()
1657
for child in by_parent[old_parent]:
1658
tt.adjust_path(tt.final_name(child), new_parent, child)
1660
def _content_match(tree, entry, file_id, kind, target_path):
1661
if entry.kind != kind:
1663
if entry.kind == "directory":
1665
if entry.kind == "file":
1666
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1668
elif entry.kind == "symlink":
1669
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1674
def resolve_checkout(tt, conflicts, divert):
1675
new_conflicts = set()
1676
for c_type, conflict in ((c[0], c) for c in conflicts):
1677
# Anything but a 'duplicate' would indicate programmer error
1678
assert c_type == 'duplicate', c_type
1679
# Now figure out which is new and which is old
1680
if tt.new_contents(conflict[1]):
1681
new_file = conflict[1]
1682
old_file = conflict[2]
1684
new_file = conflict[2]
1685
old_file = conflict[1]
1687
# We should only get here if the conflict wasn't completely
1689
final_parent = tt.final_parent(old_file)
1690
if new_file in divert:
1691
new_name = tt.final_name(old_file)+'.diverted'
1692
tt.adjust_path(new_name, final_parent, new_file)
1693
new_conflicts.add((c_type, 'Diverted to',
1694
new_file, old_file))
1696
new_name = tt.final_name(old_file)+'.moved'
1697
tt.adjust_path(new_name, final_parent, old_file)
1698
new_conflicts.add((c_type, 'Moved existing file to',
1699
old_file, new_file))
1700
return new_conflicts
1703
def new_by_entry(tt, entry, parent_id, tree):
1704
"""Create a new file according to its inventory entry"""
1708
contents = tree.get_file(entry.file_id).readlines()
1709
executable = tree.is_executable(entry.file_id)
1710
return tt.new_file(name, parent_id, contents, entry.file_id,
1712
elif kind in ('directory', 'tree-reference'):
1713
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1714
if kind == 'tree-reference':
1715
tt.set_tree_reference(entry.reference_revision, trans_id)
1717
elif kind == 'symlink':
1718
target = tree.get_symlink_target(entry.file_id)
1719
return tt.new_symlink(name, parent_id, target, entry.file_id)
1721
raise errors.BadFileKindError(name, kind)
1724
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1725
"""Create new file contents according to an inventory entry."""
1726
if entry.kind == "file":
1728
lines = tree.get_file(entry.file_id).readlines()
1729
tt.create_file(lines, trans_id, mode_id=mode_id)
1730
elif entry.kind == "symlink":
1731
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1732
elif entry.kind == "directory":
1733
tt.create_directory(trans_id)
1736
def create_entry_executability(tt, entry, trans_id):
1737
"""Set the executability of a trans_id according to an inventory entry"""
1738
if entry.kind == "file":
1739
tt.set_executability(entry.executable, trans_id)
1742
@deprecated_function(zero_fifteen)
1743
def find_interesting(working_tree, target_tree, filenames):
1744
"""Find the ids corresponding to specified filenames.
1746
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1748
working_tree.lock_read()
1750
target_tree.lock_read()
1752
return working_tree.paths2ids(filenames, [target_tree])
1754
target_tree.unlock()
1756
working_tree.unlock()
1759
@deprecated_function(zero_ninety)
1760
def change_entry(tt, file_id, working_tree, target_tree,
1761
trans_id_file_id, backups, trans_id, by_parent):
1762
"""Replace a file_id's contents with those from a target tree."""
1763
if file_id is None and target_tree is None:
1764
# skip the logic altogether in the deprecation test
1766
e_trans_id = trans_id_file_id(file_id)
1767
entry = target_tree.inventory[file_id]
1768
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1771
mode_id = e_trans_id
1774
tt.delete_contents(e_trans_id)
1776
parent_trans_id = trans_id_file_id(entry.parent_id)
1777
backup_name = get_backup_name(entry, by_parent,
1778
parent_trans_id, tt)
1779
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1780
tt.unversion_file(e_trans_id)
1781
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1782
tt.version_file(file_id, e_trans_id)
1783
trans_id[file_id] = e_trans_id
1784
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1785
create_entry_executability(tt, entry, e_trans_id)
1788
tt.set_executability(entry.executable, e_trans_id)
1789
if tt.final_name(e_trans_id) != entry.name:
1792
parent_id = tt.final_parent(e_trans_id)
1793
parent_file_id = tt.final_file_id(parent_id)
1794
if parent_file_id != entry.parent_id:
1799
parent_trans_id = trans_id_file_id(entry.parent_id)
1800
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1803
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1804
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1807
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1808
"""Produce a backup-style name that appears to be available"""
1812
yield "%s.~%d~" % (name, counter)
1814
for new_name in name_gen():
1815
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1819
def _entry_changes(file_id, entry, working_tree):
1820
"""Determine in which ways the inventory entry has changed.
1822
Returns booleans: has_contents, content_mod, meta_mod
1823
has_contents means there are currently contents, but they differ
1824
contents_mod means contents need to be modified
1825
meta_mod means the metadata needs to be modified
1827
cur_entry = working_tree.inventory[file_id]
1829
working_kind = working_tree.kind(file_id)
1832
has_contents = False
1835
if has_contents is True:
1836
if entry.kind != working_kind:
1837
contents_mod, meta_mod = True, False
1839
cur_entry._read_tree_state(working_tree.id2path(file_id),
1841
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1842
cur_entry._forget_tree_state()
1843
return has_contents, contents_mod, meta_mod
1846
def revert(working_tree, target_tree, filenames, backups=False,
1847
pb=DummyProgress(), change_reporter=None):
1848
"""Revert a working tree's contents to those of a target tree."""
1849
target_tree.lock_read()
1850
tt = TreeTransform(working_tree, pb)
1852
pp = ProgressPhase("Revert phase", 3, pb)
1854
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1856
merge_modified = _alter_files(working_tree, target_tree, tt,
1857
child_pb, filenames, backups)
1861
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1863
raw_conflicts = resolve_conflicts(tt, child_pb,
1864
lambda t, c: conflict_pass(t, c, target_tree))
1867
conflicts = cook_conflicts(raw_conflicts, tt)
1869
change_reporter = delta._ChangeReporter(
1870
unversioned_filter=working_tree.is_ignored)
1871
delta.report_changes(tt._iter_changes(), change_reporter)
1872
for conflict in conflicts:
1876
working_tree.set_merge_modified(merge_modified)
1878
target_tree.unlock()
1884
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1886
merge_modified = working_tree.merge_modified()
1887
change_list = target_tree._iter_changes(working_tree,
1888
specific_files=specific_files, pb=pb)
1889
if target_tree.inventory.root is None:
1896
for id_num, (file_id, path, changed_content, versioned, parent, name,
1897
kind, executable) in enumerate(change_list):
1898
if skip_root and file_id[0] is not None and parent[0] is None:
1900
trans_id = tt.trans_id_file_id(file_id)
1903
keep_content = False
1904
if kind[0] == 'file' and (backups or kind[1] is None):
1905
wt_sha1 = working_tree.get_file_sha1(file_id)
1906
if merge_modified.get(file_id) != wt_sha1:
1907
# acquire the basis tree lazily to prevent the
1908
# expense of accessing it when it's not needed ?
1909
# (Guessing, RBC, 200702)
1910
if basis_tree is None:
1911
basis_tree = working_tree.basis_tree()
1912
basis_tree.lock_read()
1913
if file_id in basis_tree:
1914
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1916
elif kind[1] is None and not versioned[1]:
1918
if kind[0] is not None:
1919
if not keep_content:
1920
tt.delete_contents(trans_id)
1921
elif kind[1] is not None:
1922
parent_trans_id = tt.trans_id_file_id(parent[0])
1923
by_parent = tt.by_parent()
1924
backup_name = _get_backup_name(name[0], by_parent,
1925
parent_trans_id, tt)
1926
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1927
new_trans_id = tt.create_path(name[0], parent_trans_id)
1928
if versioned == (True, True):
1929
tt.unversion_file(trans_id)
1930
tt.version_file(file_id, new_trans_id)
1931
# New contents should have the same unix perms as old
1934
trans_id = new_trans_id
1935
if kind[1] == 'directory':
1936
tt.create_directory(trans_id)
1937
elif kind[1] == 'symlink':
1938
tt.create_symlink(target_tree.get_symlink_target(file_id),
1940
elif kind[1] == 'file':
1941
deferred_files.append((file_id, (trans_id, mode_id)))
1942
if basis_tree is None:
1943
basis_tree = working_tree.basis_tree()
1944
basis_tree.lock_read()
1945
new_sha1 = target_tree.get_file_sha1(file_id)
1946
if (file_id in basis_tree and new_sha1 ==
1947
basis_tree.get_file_sha1(file_id)):
1948
if file_id in merge_modified:
1949
del merge_modified[file_id]
1951
merge_modified[file_id] = new_sha1
1953
# preserve the execute bit when backing up
1954
if keep_content and executable[0] == executable[1]:
1955
tt.set_executability(executable[1], trans_id)
1957
assert kind[1] is None
1958
if versioned == (False, True):
1959
tt.version_file(file_id, trans_id)
1960
if versioned == (True, False):
1961
tt.unversion_file(trans_id)
1962
if (name[1] is not None and
1963
(name[0] != name[1] or parent[0] != parent[1])):
1965
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1966
if executable[0] != executable[1] and kind[1] == "file":
1967
tt.set_executability(executable[1], trans_id)
1968
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1970
tt.create_file(bytes, trans_id, mode_id)
1972
if basis_tree is not None:
1974
return merge_modified
1977
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1978
"""Make many conflict-resolution attempts, but die if they fail"""
1979
if pass_func is None:
1980
pass_func = conflict_pass
1981
new_conflicts = set()
1984
pb.update('Resolution pass', n+1, 10)
1985
conflicts = tt.find_conflicts()
1986
if len(conflicts) == 0:
1987
return new_conflicts
1988
new_conflicts.update(pass_func(tt, conflicts))
1989
raise MalformedTransform(conflicts=conflicts)
1994
def conflict_pass(tt, conflicts, path_tree=None):
1995
"""Resolve some classes of conflicts.
1997
:param tt: The transform to resolve conflicts in
1998
:param conflicts: The conflicts to resolve
1999
:param path_tree: A Tree to get supplemental paths from
2001
new_conflicts = set()
2002
for c_type, conflict in ((c[0], c) for c in conflicts):
2003
if c_type == 'duplicate id':
2004
tt.unversion_file(conflict[1])
2005
new_conflicts.add((c_type, 'Unversioned existing file',
2006
conflict[1], conflict[2], ))
2007
elif c_type == 'duplicate':
2008
# files that were renamed take precedence
2009
final_parent = tt.final_parent(conflict[1])
2010
if tt.path_changed(conflict[1]):
2011
existing_file, new_file = conflict[2], conflict[1]
2013
existing_file, new_file = conflict[1], conflict[2]
2014
new_name = tt.final_name(existing_file)+'.moved'
2015
tt.adjust_path(new_name, final_parent, existing_file)
2016
new_conflicts.add((c_type, 'Moved existing file to',
2017
existing_file, new_file))
2018
elif c_type == 'parent loop':
2019
# break the loop by undoing one of the ops that caused the loop
2021
while not tt.path_changed(cur):
2022
cur = tt.final_parent(cur)
2023
new_conflicts.add((c_type, 'Cancelled move', cur,
2024
tt.final_parent(cur),))
2025
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2027
elif c_type == 'missing parent':
2028
trans_id = conflict[1]
2030
tt.cancel_deletion(trans_id)
2031
new_conflicts.add(('deleting parent', 'Not deleting',
2034
tt.create_directory(trans_id)
2035
new_conflicts.add((c_type, 'Created directory', trans_id))
2037
tt.final_name(trans_id)
2039
if path_tree is not None:
2040
file_id = tt.final_file_id(trans_id)
2041
entry = path_tree.inventory[file_id]
2042
parent_trans_id = tt.trans_id_file_id(entry.parent_id)
2043
tt.adjust_path(entry.name, parent_trans_id, trans_id)
2044
elif c_type == 'unversioned parent':
2045
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
2046
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2047
elif c_type == 'non-directory parent':
2048
parent_id = conflict[1]
2049
parent_parent = tt.final_parent(parent_id)
2050
parent_name = tt.final_name(parent_id)
2051
parent_file_id = tt.final_file_id(parent_id)
2052
new_parent_id = tt.new_directory(parent_name + '.new',
2053
parent_parent, parent_file_id)
2054
_reparent_transform_children(tt, parent_id, new_parent_id)
2055
tt.unversion_file(parent_id)
2056
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2057
return new_conflicts
2060
def cook_conflicts(raw_conflicts, tt):
2061
"""Generate a list of cooked conflicts, sorted by file path"""
2062
from bzrlib.conflicts import Conflict
2063
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2064
return sorted(conflict_iter, key=Conflict.sort_key)
2067
def iter_cook_conflicts(raw_conflicts, tt):
2068
from bzrlib.conflicts import Conflict
2070
for conflict in raw_conflicts:
2071
c_type = conflict[0]
2072
action = conflict[1]
2073
modified_path = fp.get_path(conflict[2])
2074
modified_id = tt.final_file_id(conflict[2])
2075
if len(conflict) == 3:
2076
yield Conflict.factory(c_type, action=action, path=modified_path,
2077
file_id=modified_id)
2080
conflicting_path = fp.get_path(conflict[3])
2081
conflicting_id = tt.final_file_id(conflict[3])
2082
yield Conflict.factory(c_type, action=action, path=modified_path,
2083
file_id=modified_id,
2084
conflict_path=conflicting_path,
2085
conflict_file_id=conflicting_id)
2088
class _FileMover(object):
2089
"""Moves and deletes files for TreeTransform, tracking operations"""
2092
self.past_renames = []
2093
self.pending_deletions = []
2095
def rename(self, from_, to):
2096
"""Rename a file from one path to another. Functions like os.rename"""
2098
os.rename(from_, to)
2100
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2101
raise errors.FileExists(to, str(e))
2103
self.past_renames.append((from_, to))
2105
def pre_delete(self, from_, to):
2106
"""Rename a file out of the way and mark it for deletion.
2108
Unlike os.unlink, this works equally well for files and directories.
2109
:param from_: The current file path
2110
:param to: A temporary path for the file
2112
self.rename(from_, to)
2113
self.pending_deletions.append(to)
2116
"""Reverse all renames that have been performed"""
2117
for from_, to in reversed(self.past_renames):
2118
os.rename(to, from_)
2119
# after rollback, don't reuse _FileMover
2121
pending_deletions = None
2123
def apply_deletions(self):
2124
"""Apply all marked deletions"""
2125
for path in self.pending_deletions:
2127
# after apply_deletions, don't reuse _FileMover
2129
pending_deletions = None
added
removed
bzrlib/transform.py
