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(), """
29
revision as _mod_revision,
32
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
33
ReusingTransform, NotVersionedError, CantMoveRoot,
34
ExistingLimbo, ImmortalLimbo, NoFinalPath,
36
from bzrlib.inventory import InventoryEntry
37
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
38
delete_any, has_symlinks)
39
from bzrlib.progress import DummyProgress, ProgressPhase
40
from bzrlib.symbol_versioning import (
43
from bzrlib.trace import mutter, warning
44
from bzrlib import tree
46
import bzrlib.urlutils as urlutils
49
ROOT_PARENT = "root-parent"
52
def unique_add(map, key, value):
54
raise DuplicateKey(key=key)
58
class _TransformResults(object):
59
def __init__(self, modified_paths, rename_count):
61
self.modified_paths = modified_paths
62
self.rename_count = rename_count
65
class TreeTransformBase(object):
66
"""The base class for TreeTransform and TreeTransformBase"""
68
def __init__(self, tree, limbodir, pb=DummyProgress(),
72
:param tree: The tree that will be transformed, but not necessarily
74
:param limbodir: A directory where new files can be stored until
75
they are installed in their proper places
76
:param pb: A ProgressBar indicating how much progress is being made
77
:param case_sensitive: If True, the target of the transform is
78
case sensitive, not just case preserving.
82
self._limbodir = limbodir
83
self._deletiondir = None
85
# mapping of trans_id -> new basename
87
# mapping of trans_id -> new parent trans_id
89
# mapping of trans_id with new contents -> new file_kind
90
self._new_contents = {}
91
# A mapping of transform ids to their limbo filename
92
self._limbo_files = {}
93
# A mapping of transform ids to a set of the transform ids of children
94
# that their limbo directory has
95
self._limbo_children = {}
96
# Map transform ids to maps of child filename to child transform id
97
self._limbo_children_names = {}
98
# List of transform ids that need to be renamed from limbo into place
99
self._needs_rename = set()
100
# Set of trans_ids whose contents will be removed
101
self._removed_contents = set()
102
# Mapping of trans_id -> new execute-bit value
103
self._new_executability = {}
104
# Mapping of trans_id -> new tree-reference value
105
self._new_reference_revision = {}
106
# Mapping of trans_id -> new file_id
108
# Mapping of old file-id -> trans_id
109
self._non_present_ids = {}
110
# Mapping of new file_id -> trans_id
112
# Set of file_ids that will be removed
113
self._removed_id = set()
114
# Mapping of path in old tree -> trans_id
115
self._tree_path_ids = {}
116
# Mapping trans_id -> path in old tree
117
self._tree_id_paths = {}
118
# Cache of realpath results, to speed up canonical_path
120
# Cache of relpath results, to speed up canonical_path
122
# The trans_id that will be used as the tree root
123
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
124
# Indictor of whether the transform has been applied
128
# Whether the target is case sensitive
129
self._case_sensitive_target = case_sensitive
130
# A counter of how many files have been renamed
131
self.rename_count = 0
133
def __get_root(self):
134
return self._new_root
136
root = property(__get_root)
139
"""Release the working tree lock, if held, clean up limbo dir.
141
This is required if apply has not been invoked, but can be invoked
144
if self._tree is None:
147
entries = [(self._limbo_name(t), t, k) for t, k in
148
self._new_contents.iteritems()]
149
entries.sort(reverse=True)
150
for path, trans_id, kind in entries:
151
if kind == "directory":
156
os.rmdir(self._limbodir)
158
# We don't especially care *why* the dir is immortal.
159
raise ImmortalLimbo(self._limbodir)
161
if self._deletiondir is not None:
162
os.rmdir(self._deletiondir)
164
raise errors.ImmortalPendingDeletion(self._deletiondir)
169
def _assign_id(self):
170
"""Produce a new tranform id"""
171
new_id = "new-%s" % self._id_number
175
def create_path(self, name, parent):
176
"""Assign a transaction id to a new path"""
177
trans_id = self._assign_id()
178
unique_add(self._new_name, trans_id, name)
179
unique_add(self._new_parent, trans_id, parent)
182
def adjust_path(self, name, parent, trans_id):
183
"""Change the path that is assigned to a transaction id."""
184
if trans_id == self._new_root:
186
previous_parent = self._new_parent.get(trans_id)
187
previous_name = self._new_name.get(trans_id)
188
self._new_name[trans_id] = name
189
self._new_parent[trans_id] = parent
190
if (trans_id in self._limbo_files and
191
trans_id not in self._needs_rename):
192
self._rename_in_limbo([trans_id])
193
self._limbo_children[previous_parent].remove(trans_id)
194
del self._limbo_children_names[previous_parent][previous_name]
196
def _rename_in_limbo(self, trans_ids):
197
"""Fix limbo names so that the right final path is produced.
199
This means we outsmarted ourselves-- we tried to avoid renaming
200
these files later by creating them with their final names in their
201
final parents. But now the previous name or parent is no longer
202
suitable, so we have to rename them.
204
Even for trans_ids that have no new contents, we must remove their
205
entries from _limbo_files, because they are now stale.
207
for trans_id in trans_ids:
208
old_path = self._limbo_files.pop(trans_id)
209
if trans_id not in self._new_contents:
211
new_path = self._limbo_name(trans_id)
212
os.rename(old_path, new_path)
214
def adjust_root_path(self, name, parent):
215
"""Emulate moving the root by moving all children, instead.
217
We do this by undoing the association of root's transaction id with the
218
current tree. This allows us to create a new directory with that
219
transaction id. We unversion the root directory and version the
220
physically new directory, and hope someone versions the tree root
223
old_root = self._new_root
224
old_root_file_id = self.final_file_id(old_root)
225
# force moving all children of root
226
for child_id in self.iter_tree_children(old_root):
227
if child_id != parent:
228
self.adjust_path(self.final_name(child_id),
229
self.final_parent(child_id), child_id)
230
file_id = self.final_file_id(child_id)
231
if file_id is not None:
232
self.unversion_file(child_id)
233
self.version_file(file_id, child_id)
235
# the physical root needs a new transaction id
236
self._tree_path_ids.pop("")
237
self._tree_id_paths.pop(old_root)
238
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
239
if parent == old_root:
240
parent = self._new_root
241
self.adjust_path(name, parent, old_root)
242
self.create_directory(old_root)
243
self.version_file(old_root_file_id, old_root)
244
self.unversion_file(self._new_root)
246
def trans_id_tree_file_id(self, inventory_id):
247
"""Determine the transaction id of a working tree file.
249
This reflects only files that already exist, not ones that will be
250
added by transactions.
252
path = self._tree.id2path(inventory_id)
253
return self.trans_id_tree_path(path)
255
def trans_id_file_id(self, file_id):
256
"""Determine or set the transaction id associated with a file ID.
257
A new id is only created for file_ids that were never present. If
258
a transaction has been unversioned, it is deliberately still returned.
259
(this will likely lead to an unversioned parent conflict.)
261
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
262
return self._r_new_id[file_id]
263
elif file_id in self._tree.inventory:
264
return self.trans_id_tree_file_id(file_id)
265
elif file_id in self._non_present_ids:
266
return self._non_present_ids[file_id]
268
trans_id = self._assign_id()
269
self._non_present_ids[file_id] = trans_id
272
def canonical_path(self, path):
273
"""Get the canonical tree-relative path"""
274
# don't follow final symlinks
275
abs = self._tree.abspath(path)
276
if abs in self._relpaths:
277
return self._relpaths[abs]
278
dirname, basename = os.path.split(abs)
279
if dirname not in self._realpaths:
280
self._realpaths[dirname] = os.path.realpath(dirname)
281
dirname = self._realpaths[dirname]
282
abs = pathjoin(dirname, basename)
283
if dirname in self._relpaths:
284
relpath = pathjoin(self._relpaths[dirname], basename)
285
relpath = relpath.rstrip('/\\')
287
relpath = self._tree.relpath(abs)
288
self._relpaths[abs] = relpath
291
def trans_id_tree_path(self, path):
292
"""Determine (and maybe set) the transaction ID for a tree path."""
293
path = self.canonical_path(path)
294
if path not in self._tree_path_ids:
295
self._tree_path_ids[path] = self._assign_id()
296
self._tree_id_paths[self._tree_path_ids[path]] = path
297
return self._tree_path_ids[path]
299
def get_tree_parent(self, trans_id):
300
"""Determine id of the parent in the tree."""
301
path = self._tree_id_paths[trans_id]
304
return self.trans_id_tree_path(os.path.dirname(path))
306
def create_file(self, contents, trans_id, mode_id=None):
307
"""Schedule creation of a new file.
311
Contents is an iterator of strings, all of which will be written
312
to the target destination.
314
New file takes the permissions of any existing file with that id,
315
unless mode_id is specified.
317
name = self._limbo_name(trans_id)
321
unique_add(self._new_contents, trans_id, 'file')
323
# Clean up the file, it never got registered so
324
# TreeTransform.finalize() won't clean it up.
329
f.writelines(contents)
332
self._set_mode(trans_id, mode_id, S_ISREG)
334
def _set_mode(self, trans_id, mode_id, typefunc):
335
"""Set the mode of new file contents.
336
The mode_id is the existing file to get the mode from (often the same
337
as trans_id). The operation is only performed if there's a mode match
338
according to typefunc.
343
old_path = self._tree_id_paths[mode_id]
347
mode = os.stat(self._tree.abspath(old_path)).st_mode
349
if e.errno == errno.ENOENT:
354
os.chmod(self._limbo_name(trans_id), mode)
356
def create_hardlink(self, path, trans_id):
357
"""Schedule creation of a hard link"""
358
name = self._limbo_name(trans_id)
362
if e.errno != errno.EPERM:
364
raise errors.HardLinkNotSupported(path)
366
unique_add(self._new_contents, trans_id, 'file')
368
# Clean up the file, it never got registered so
369
# TreeTransform.finalize() won't clean it up.
373
def create_directory(self, trans_id):
374
"""Schedule creation of a new directory.
376
See also new_directory.
378
os.mkdir(self._limbo_name(trans_id))
379
unique_add(self._new_contents, trans_id, 'directory')
381
def create_symlink(self, target, trans_id):
382
"""Schedule creation of a new symbolic link.
384
target is a bytestring.
385
See also new_symlink.
388
os.symlink(target, self._limbo_name(trans_id))
389
unique_add(self._new_contents, trans_id, 'symlink')
392
path = FinalPaths(self).get_path(trans_id)
395
raise UnableCreateSymlink(path=path)
397
def cancel_creation(self, trans_id):
398
"""Cancel the creation of new file contents."""
399
del self._new_contents[trans_id]
400
children = self._limbo_children.get(trans_id)
401
# if this is a limbo directory with children, move them before removing
403
if children is not None:
404
self._rename_in_limbo(children)
405
del self._limbo_children[trans_id]
406
del self._limbo_children_names[trans_id]
407
delete_any(self._limbo_name(trans_id))
409
def delete_contents(self, trans_id):
410
"""Schedule the contents of a path entry for deletion"""
411
self.tree_kind(trans_id)
412
self._removed_contents.add(trans_id)
414
def cancel_deletion(self, trans_id):
415
"""Cancel a scheduled deletion"""
416
self._removed_contents.remove(trans_id)
418
def unversion_file(self, trans_id):
419
"""Schedule a path entry to become unversioned"""
420
self._removed_id.add(trans_id)
422
def delete_versioned(self, trans_id):
423
"""Delete and unversion a versioned file"""
424
self.delete_contents(trans_id)
425
self.unversion_file(trans_id)
427
def set_executability(self, executability, trans_id):
428
"""Schedule setting of the 'execute' bit
429
To unschedule, set to None
431
if executability is None:
432
del self._new_executability[trans_id]
434
unique_add(self._new_executability, trans_id, executability)
436
def set_tree_reference(self, revision_id, trans_id):
437
"""Set the reference associated with a directory"""
438
unique_add(self._new_reference_revision, trans_id, revision_id)
440
def version_file(self, file_id, trans_id):
441
"""Schedule a file to become versioned."""
444
unique_add(self._new_id, trans_id, file_id)
445
unique_add(self._r_new_id, file_id, trans_id)
447
def cancel_versioning(self, trans_id):
448
"""Undo a previous versioning of a file"""
449
file_id = self._new_id[trans_id]
450
del self._new_id[trans_id]
451
del self._r_new_id[file_id]
454
"""Determine the paths of all new and changed files"""
456
fp = FinalPaths(self)
457
for id_set in (self._new_name, self._new_parent, self._new_contents,
458
self._new_id, self._new_executability):
459
new_ids.update(id_set)
460
new_paths = [(fp.get_path(t), t) for t in new_ids]
464
def tree_kind(self, trans_id):
465
"""Determine the file kind in the working tree.
467
Raises NoSuchFile if the file does not exist
469
path = self._tree_id_paths.get(trans_id)
471
raise NoSuchFile(None)
473
return file_kind(self._tree.abspath(path))
475
if e.errno != errno.ENOENT:
478
raise NoSuchFile(path)
480
def final_kind(self, trans_id):
481
"""Determine the final file kind, after any changes applied.
483
Raises NoSuchFile if the file does not exist/has no contents.
484
(It is conceivable that a path would be created without the
485
corresponding contents insertion command)
487
if trans_id in self._new_contents:
488
return self._new_contents[trans_id]
489
elif trans_id in self._removed_contents:
490
raise NoSuchFile(None)
492
return self.tree_kind(trans_id)
494
def tree_file_id(self, trans_id):
495
"""Determine the file id associated with the trans_id in the tree"""
497
path = self._tree_id_paths[trans_id]
499
# the file is a new, unversioned file, or invalid trans_id
501
# the file is old; the old id is still valid
502
if self._new_root == trans_id:
503
return self._tree.get_root_id()
504
return self._tree.inventory.path2id(path)
506
def final_file_id(self, trans_id):
507
"""Determine the file id after any changes are applied, or None.
509
None indicates that the file will not be versioned after changes are
513
return self._new_id[trans_id]
515
if trans_id in self._removed_id:
517
return self.tree_file_id(trans_id)
519
def inactive_file_id(self, trans_id):
520
"""Return the inactive file_id associated with a transaction id.
521
That is, the one in the tree or in non_present_ids.
522
The file_id may actually be active, too.
524
file_id = self.tree_file_id(trans_id)
525
if file_id is not None:
527
for key, value in self._non_present_ids.iteritems():
528
if value == trans_id:
531
def final_parent(self, trans_id):
532
"""Determine the parent file_id, after any changes are applied.
534
ROOT_PARENT is returned for the tree root.
537
return self._new_parent[trans_id]
539
return self.get_tree_parent(trans_id)
541
def final_name(self, trans_id):
542
"""Determine the final filename, after all changes are applied."""
544
return self._new_name[trans_id]
547
return os.path.basename(self._tree_id_paths[trans_id])
549
raise NoFinalPath(trans_id, self)
552
"""Return a map of parent: children for known parents.
554
Only new paths and parents of tree files with assigned ids are used.
557
items = list(self._new_parent.iteritems())
558
items.extend((t, self.final_parent(t)) for t in
559
self._tree_id_paths.keys())
560
for trans_id, parent_id in items:
561
if parent_id not in by_parent:
562
by_parent[parent_id] = set()
563
by_parent[parent_id].add(trans_id)
566
def path_changed(self, trans_id):
567
"""Return True if a trans_id's path has changed."""
568
return (trans_id in self._new_name) or (trans_id in self._new_parent)
570
def new_contents(self, trans_id):
571
return (trans_id in self._new_contents)
573
def find_conflicts(self):
574
"""Find any violations of inventory or filesystem invariants"""
575
if self._done is True:
576
raise ReusingTransform()
578
# ensure all children of all existent parents are known
579
# all children of non-existent parents are known, by definition.
580
self._add_tree_children()
581
by_parent = self.by_parent()
582
conflicts.extend(self._unversioned_parents(by_parent))
583
conflicts.extend(self._parent_loops())
584
conflicts.extend(self._duplicate_entries(by_parent))
585
conflicts.extend(self._duplicate_ids())
586
conflicts.extend(self._parent_type_conflicts(by_parent))
587
conflicts.extend(self._improper_versioning())
588
conflicts.extend(self._executability_conflicts())
589
conflicts.extend(self._overwrite_conflicts())
592
def _add_tree_children(self):
593
"""Add all the children of all active parents to the known paths.
595
Active parents are those which gain children, and those which are
596
removed. This is a necessary first step in detecting conflicts.
598
parents = self.by_parent().keys()
599
parents.extend([t for t in self._removed_contents if
600
self.tree_kind(t) == 'directory'])
601
for trans_id in self._removed_id:
602
file_id = self.tree_file_id(trans_id)
603
if file_id is not None:
604
if self._tree.inventory[file_id].kind == 'directory':
605
parents.append(trans_id)
606
elif self.tree_kind(trans_id) == 'directory':
607
parents.append(trans_id)
609
for parent_id in parents:
610
# ensure that all children are registered with the transaction
611
list(self.iter_tree_children(parent_id))
613
def iter_tree_children(self, parent_id):
614
"""Iterate through the entry's tree children, if any"""
616
path = self._tree_id_paths[parent_id]
620
children = os.listdir(self._tree.abspath(path))
622
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
626
for child in children:
627
childpath = joinpath(path, child)
628
if self._tree.is_control_filename(childpath):
630
yield self.trans_id_tree_path(childpath)
632
def has_named_child(self, by_parent, parent_id, name):
634
children = by_parent[parent_id]
637
for child in children:
638
if self.final_name(child) == name:
641
path = self._tree_id_paths[parent_id]
644
childpath = joinpath(path, name)
645
child_id = self._tree_path_ids.get(childpath)
647
return lexists(self._tree.abspath(childpath))
649
if self.final_parent(child_id) != parent_id:
651
if child_id in self._removed_contents:
652
# XXX What about dangling file-ids?
657
def _parent_loops(self):
658
"""No entry should be its own ancestor"""
660
for trans_id in self._new_parent:
663
while parent_id is not ROOT_PARENT:
666
parent_id = self.final_parent(parent_id)
669
if parent_id == trans_id:
670
conflicts.append(('parent loop', trans_id))
671
if parent_id in seen:
675
def _unversioned_parents(self, by_parent):
676
"""If parent directories are versioned, children must be versioned."""
678
for parent_id, children in by_parent.iteritems():
679
if parent_id is ROOT_PARENT:
681
if self.final_file_id(parent_id) is not None:
683
for child_id in children:
684
if self.final_file_id(child_id) is not None:
685
conflicts.append(('unversioned parent', parent_id))
689
def _improper_versioning(self):
690
"""Cannot version a file with no contents, or a bad type.
692
However, existing entries with no contents are okay.
695
for trans_id in self._new_id.iterkeys():
697
kind = self.final_kind(trans_id)
699
conflicts.append(('versioning no contents', trans_id))
701
if not InventoryEntry.versionable_kind(kind):
702
conflicts.append(('versioning bad kind', trans_id, kind))
705
def _executability_conflicts(self):
706
"""Check for bad executability changes.
708
Only versioned files may have their executability set, because
709
1. only versioned entries can have executability under windows
710
2. only files can be executable. (The execute bit on a directory
711
does not indicate searchability)
714
for trans_id in self._new_executability:
715
if self.final_file_id(trans_id) is None:
716
conflicts.append(('unversioned executability', trans_id))
719
non_file = self.final_kind(trans_id) != "file"
723
conflicts.append(('non-file executability', trans_id))
726
def _overwrite_conflicts(self):
727
"""Check for overwrites (not permitted on Win32)"""
729
for trans_id in self._new_contents:
731
self.tree_kind(trans_id)
734
if trans_id not in self._removed_contents:
735
conflicts.append(('overwrite', trans_id,
736
self.final_name(trans_id)))
739
def _duplicate_entries(self, by_parent):
740
"""No directory may have two entries with the same name."""
742
if (self._new_name, self._new_parent) == ({}, {}):
744
for children in by_parent.itervalues():
745
name_ids = [(self.final_name(t), t) for t in children]
746
if not self._case_sensitive_target:
747
name_ids = [(n.lower(), t) for n, t in name_ids]
751
for name, trans_id in name_ids:
753
kind = self.final_kind(trans_id)
756
file_id = self.final_file_id(trans_id)
757
if kind is None and file_id is None:
759
if name == last_name:
760
conflicts.append(('duplicate', last_trans_id, trans_id,
763
last_trans_id = trans_id
766
def _duplicate_ids(self):
767
"""Each inventory id may only be used once"""
769
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
771
all_ids = self._tree.all_file_ids()
772
active_tree_ids = all_ids.difference(removed_tree_ids)
773
for trans_id, file_id in self._new_id.iteritems():
774
if file_id in active_tree_ids:
775
old_trans_id = self.trans_id_tree_file_id(file_id)
776
conflicts.append(('duplicate id', old_trans_id, trans_id))
779
def _parent_type_conflicts(self, by_parent):
780
"""parents must have directory 'contents'."""
782
for parent_id, children in by_parent.iteritems():
783
if parent_id is ROOT_PARENT:
785
if not self._any_contents(children):
787
for child in children:
789
self.final_kind(child)
793
kind = self.final_kind(parent_id)
797
conflicts.append(('missing parent', parent_id))
798
elif kind != "directory":
799
conflicts.append(('non-directory parent', parent_id))
802
def _any_contents(self, trans_ids):
803
"""Return true if any of the trans_ids, will have contents."""
804
for trans_id in trans_ids:
806
kind = self.final_kind(trans_id)
812
def _limbo_name(self, trans_id):
813
"""Generate the limbo name of a file"""
814
limbo_name = self._limbo_files.get(trans_id)
815
if limbo_name is not None:
817
parent = self._new_parent.get(trans_id)
818
# if the parent directory is already in limbo (e.g. when building a
819
# tree), choose a limbo name inside the parent, to reduce further
821
use_direct_path = False
822
if self._new_contents.get(parent) == 'directory':
823
filename = self._new_name.get(trans_id)
824
if filename is not None:
825
if parent not in self._limbo_children:
826
self._limbo_children[parent] = set()
827
self._limbo_children_names[parent] = {}
828
use_direct_path = True
829
# the direct path can only be used if no other file has
830
# already taken this pathname, i.e. if the name is unused, or
831
# if it is already associated with this trans_id.
832
elif self._case_sensitive_target:
833
if (self._limbo_children_names[parent].get(filename)
834
in (trans_id, None)):
835
use_direct_path = True
837
for l_filename, l_trans_id in\
838
self._limbo_children_names[parent].iteritems():
839
if l_trans_id == trans_id:
841
if l_filename.lower() == filename.lower():
844
use_direct_path = True
847
limbo_name = pathjoin(self._limbo_files[parent], filename)
848
self._limbo_children[parent].add(trans_id)
849
self._limbo_children_names[parent][filename] = trans_id
851
limbo_name = pathjoin(self._limbodir, trans_id)
852
self._needs_rename.add(trans_id)
853
self._limbo_files[trans_id] = limbo_name
856
def _set_executability(self, path, entry, trans_id):
857
"""Set the executability of versioned files """
858
new_executability = self._new_executability[trans_id]
859
entry.executable = new_executability
860
if supports_executable():
861
abspath = self._tree.abspath(path)
862
current_mode = os.stat(abspath).st_mode
863
if new_executability:
866
to_mode = current_mode | (0100 & ~umask)
867
# Enable x-bit for others only if they can read it.
868
if current_mode & 0004:
869
to_mode |= 0001 & ~umask
870
if current_mode & 0040:
871
to_mode |= 0010 & ~umask
873
to_mode = current_mode & ~0111
874
os.chmod(abspath, to_mode)
876
def _new_entry(self, name, parent_id, file_id):
877
"""Helper function to create a new filesystem entry."""
878
trans_id = self.create_path(name, parent_id)
879
if file_id is not None:
880
self.version_file(file_id, trans_id)
883
def new_file(self, name, parent_id, contents, file_id=None,
885
"""Convenience method to create files.
887
name is the name of the file to create.
888
parent_id is the transaction id of the parent directory of the file.
889
contents is an iterator of bytestrings, which will be used to produce
891
:param file_id: The inventory ID of the file, if it is to be versioned.
892
:param executable: Only valid when a file_id has been supplied.
894
trans_id = self._new_entry(name, parent_id, file_id)
895
# TODO: rather than scheduling a set_executable call,
896
# have create_file create the file with the right mode.
897
self.create_file(contents, trans_id)
898
if executable is not None:
899
self.set_executability(executable, trans_id)
902
def new_directory(self, name, parent_id, file_id=None):
903
"""Convenience method to create directories.
905
name is the name of the directory to create.
906
parent_id is the transaction id of the parent directory of the
908
file_id is the inventory ID of the directory, if it is to be versioned.
910
trans_id = self._new_entry(name, parent_id, file_id)
911
self.create_directory(trans_id)
914
def new_symlink(self, name, parent_id, target, file_id=None):
915
"""Convenience method to create symbolic link.
917
name is the name of the symlink to create.
918
parent_id is the transaction id of the parent directory of the symlink.
919
target is a bytestring of the target of the symlink.
920
file_id is the inventory ID of the file, if it is to be versioned.
922
trans_id = self._new_entry(name, parent_id, file_id)
923
self.create_symlink(target, trans_id)
926
def _affected_ids(self):
927
"""Return the set of transform ids affected by the transform"""
928
trans_ids = set(self._removed_id)
929
trans_ids.update(self._new_id.keys())
930
trans_ids.update(self._removed_contents)
931
trans_ids.update(self._new_contents.keys())
932
trans_ids.update(self._new_executability.keys())
933
trans_ids.update(self._new_name.keys())
934
trans_ids.update(self._new_parent.keys())
937
def _get_file_id_maps(self):
938
"""Return mapping of file_ids to trans_ids in the to and from states"""
939
trans_ids = self._affected_ids()
942
# Build up two dicts: trans_ids associated with file ids in the
943
# FROM state, vs the TO state.
944
for trans_id in trans_ids:
945
from_file_id = self.tree_file_id(trans_id)
946
if from_file_id is not None:
947
from_trans_ids[from_file_id] = trans_id
948
to_file_id = self.final_file_id(trans_id)
949
if to_file_id is not None:
950
to_trans_ids[to_file_id] = trans_id
951
return from_trans_ids, to_trans_ids
953
def _from_file_data(self, from_trans_id, from_versioned, file_id):
954
"""Get data about a file in the from (tree) state
956
Return a (name, parent, kind, executable) tuple
958
from_path = self._tree_id_paths.get(from_trans_id)
960
# get data from working tree if versioned
961
from_entry = self._tree.inventory[file_id]
962
from_name = from_entry.name
963
from_parent = from_entry.parent_id
966
if from_path is None:
967
# File does not exist in FROM state
971
# File exists, but is not versioned. Have to use path-
973
from_name = os.path.basename(from_path)
974
tree_parent = self.get_tree_parent(from_trans_id)
975
from_parent = self.tree_file_id(tree_parent)
976
if from_path is not None:
977
from_kind, from_executable, from_stats = \
978
self._tree._comparison_data(from_entry, from_path)
981
from_executable = False
982
return from_name, from_parent, from_kind, from_executable
984
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
985
"""Get data about a file in the to (target) state
987
Return a (name, parent, kind, executable) tuple
989
to_name = self.final_name(to_trans_id)
991
to_kind = self.final_kind(to_trans_id)
994
to_parent = self.final_file_id(self.final_parent(to_trans_id))
995
if to_trans_id in self._new_executability:
996
to_executable = self._new_executability[to_trans_id]
997
elif to_trans_id == from_trans_id:
998
to_executable = from_executable
1000
to_executable = False
1001
return to_name, to_parent, to_kind, to_executable
1003
def iter_changes(self):
1004
"""Produce output in the same format as Tree.iter_changes.
1006
Will produce nonsensical results if invoked while inventory/filesystem
1007
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1009
This reads the Transform, but only reproduces changes involving a
1010
file_id. Files that are not versioned in either of the FROM or TO
1011
states are not reflected.
1013
final_paths = FinalPaths(self)
1014
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1016
# Now iterate through all active file_ids
1017
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1019
from_trans_id = from_trans_ids.get(file_id)
1020
# find file ids, and determine versioning state
1021
if from_trans_id is None:
1022
from_versioned = False
1023
from_trans_id = to_trans_ids[file_id]
1025
from_versioned = True
1026
to_trans_id = to_trans_ids.get(file_id)
1027
if to_trans_id is None:
1028
to_versioned = False
1029
to_trans_id = from_trans_id
1033
from_name, from_parent, from_kind, from_executable = \
1034
self._from_file_data(from_trans_id, from_versioned, file_id)
1036
to_name, to_parent, to_kind, to_executable = \
1037
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1039
if not from_versioned:
1042
from_path = self._tree_id_paths.get(from_trans_id)
1043
if not to_versioned:
1046
to_path = final_paths.get_path(to_trans_id)
1047
if from_kind != to_kind:
1049
elif to_kind in ('file', 'symlink') and (
1050
to_trans_id != from_trans_id or
1051
to_trans_id in self._new_contents):
1053
if (not modified and from_versioned == to_versioned and
1054
from_parent==to_parent and from_name == to_name and
1055
from_executable == to_executable):
1057
results.append((file_id, (from_path, to_path), modified,
1058
(from_versioned, to_versioned),
1059
(from_parent, to_parent),
1060
(from_name, to_name),
1061
(from_kind, to_kind),
1062
(from_executable, to_executable)))
1063
return iter(sorted(results, key=lambda x:x[1]))
1065
def get_preview_tree(self):
1066
"""Return a tree representing the result of the transform.
1068
This tree only supports the subset of Tree functionality required
1069
by show_diff_trees. It must only be compared to tt._tree.
1071
return _PreviewTree(self)
1074
class TreeTransform(TreeTransformBase):
1075
"""Represent a tree transformation.
1077
This object is designed to support incremental generation of the transform,
1080
However, it gives optimum performance when parent directories are created
1081
before their contents. The transform is then able to put child files
1082
directly in their parent directory, avoiding later renames.
1084
It is easy to produce malformed transforms, but they are generally
1085
harmless. Attempting to apply a malformed transform will cause an
1086
exception to be raised before any modifications are made to the tree.
1088
Many kinds of malformed transforms can be corrected with the
1089
resolve_conflicts function. The remaining ones indicate programming error,
1090
such as trying to create a file with no path.
1092
Two sets of file creation methods are supplied. Convenience methods are:
1097
These are composed of the low-level methods:
1099
* create_file or create_directory or create_symlink
1103
Transform/Transaction ids
1104
-------------------------
1105
trans_ids are temporary ids assigned to all files involved in a transform.
1106
It's possible, even common, that not all files in the Tree have trans_ids.
1108
trans_ids are used because filenames and file_ids are not good enough
1109
identifiers; filenames change, and not all files have file_ids. File-ids
1110
are also associated with trans-ids, so that moving a file moves its
1113
trans_ids are only valid for the TreeTransform that generated them.
1117
Limbo is a temporary directory use to hold new versions of files.
1118
Files are added to limbo by create_file, create_directory, create_symlink,
1119
and their convenience variants (new_*). Files may be removed from limbo
1120
using cancel_creation. Files are renamed from limbo into their final
1121
location as part of TreeTransform.apply
1123
Limbo must be cleaned up, by either calling TreeTransform.apply or
1124
calling TreeTransform.finalize.
1126
Files are placed into limbo inside their parent directories, where
1127
possible. This reduces subsequent renames, and makes operations involving
1128
lots of files faster. This optimization is only possible if the parent
1129
directory is created *before* creating any of its children, so avoid
1130
creating children before parents, where possible.
1134
This temporary directory is used by _FileMover for storing files that are
1135
about to be deleted. In case of rollback, the files will be restored.
1136
FileMover does not delete files until it is sure that a rollback will not
1139
def __init__(self, tree, pb=DummyProgress()):
1140
"""Note: a tree_write lock is taken on the tree.
1142
Use TreeTransform.finalize() to release the lock (can be omitted if
1143
TreeTransform.apply() called).
1145
tree.lock_tree_write()
1148
limbodir = urlutils.local_path_from_url(
1149
tree._transport.abspath('limbo'))
1153
if e.errno == errno.EEXIST:
1154
raise ExistingLimbo(limbodir)
1155
deletiondir = urlutils.local_path_from_url(
1156
tree._transport.abspath('pending-deletion'))
1158
os.mkdir(deletiondir)
1160
if e.errno == errno.EEXIST:
1161
raise errors.ExistingPendingDeletion(deletiondir)
1166
TreeTransformBase.__init__(self, tree, limbodir, pb,
1167
tree.case_sensitive)
1168
self._deletiondir = deletiondir
1170
def apply(self, no_conflicts=False, _mover=None):
1171
"""Apply all changes to the inventory and filesystem.
1173
If filesystem or inventory conflicts are present, MalformedTransform
1176
If apply succeeds, finalize is not necessary.
1178
:param no_conflicts: if True, the caller guarantees there are no
1179
conflicts, so no check is made.
1180
:param _mover: Supply an alternate FileMover, for testing
1182
if not no_conflicts:
1183
conflicts = self.find_conflicts()
1184
if len(conflicts) != 0:
1185
raise MalformedTransform(conflicts=conflicts)
1186
inventory_delta = []
1187
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1190
mover = _FileMover()
1194
child_pb.update('Apply phase', 0, 2)
1195
self._apply_removals(inventory_delta, mover)
1196
child_pb.update('Apply phase', 1, 2)
1197
modified_paths = self._apply_insertions(inventory_delta, mover)
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, 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
# File-id isn't really being deleted, just moved
1243
if file_id in self._r_new_id:
1245
inventory_delta.append((path, None, file_id, None))
1249
def _apply_insertions(self, inventory_delta, mover):
1250
"""Perform tree operations that insert directory/inventory names.
1252
That is, create any files that need to be created, and restore from
1253
limbo any files that needed renaming. This must be done in strict
1254
parent-to-child order.
1256
new_paths = self.new_paths()
1258
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1261
for num, (path, trans_id) in enumerate(new_paths):
1263
child_pb.update('adding file', num, len(new_paths))
1264
if trans_id in self._new_contents or \
1265
self.path_changed(trans_id):
1266
full_path = self._tree.abspath(path)
1267
if trans_id in self._needs_rename:
1269
mover.rename(self._limbo_name(trans_id), full_path)
1271
# We may be renaming a dangling inventory id
1272
if e.errno != errno.ENOENT:
1275
self.rename_count += 1
1276
if trans_id in self._new_contents:
1277
modified_paths.append(full_path)
1278
completed_new.append(trans_id)
1279
file_id = self.final_file_id(trans_id)
1280
if file_id is not None and (trans_id in self._new_id or
1281
trans_id in self._new_name or trans_id in self._new_parent
1282
or trans_id in self._new_executability):
1284
kind = self.final_kind(trans_id)
1286
kind = self._tree.stored_kind(file_id)
1287
if trans_id in self._new_reference_revision:
1288
new_entry = inventory.TreeReference(
1289
self.final_file_id(trans_id),
1290
self._new_name[trans_id],
1291
self.final_file_id(self._new_parent[trans_id]),
1292
None, self._new_reference_revision[trans_id])
1294
new_entry = inventory.make_entry(kind,
1295
self.final_name(trans_id),
1296
self.final_file_id(self.final_parent(trans_id)),
1297
self.final_file_id(trans_id))
1299
old_path = self._tree.id2path(new_entry.file_id)
1300
except errors.NoSuchId:
1302
inventory_delta.append((old_path, path, new_entry.file_id,
1305
if trans_id in self._new_executability:
1306
self._set_executability(path, new_entry, trans_id)
1309
for trans_id in completed_new:
1310
del self._new_contents[trans_id]
1311
return modified_paths
1314
class TransformPreview(TreeTransformBase):
1315
"""A TreeTransform for generating preview trees.
1317
Unlike TreeTransform, this version works when the input tree is a
1318
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1319
unversioned files in the input tree.
1322
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1324
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1325
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1327
def canonical_path(self, path):
1330
def tree_kind(self, trans_id):
1331
path = self._tree_id_paths.get(trans_id)
1333
raise NoSuchFile(None)
1334
file_id = self._tree.path2id(path)
1335
return self._tree.kind(file_id)
1337
def _set_mode(self, trans_id, mode_id, typefunc):
1338
"""Set the mode of new file contents.
1339
The mode_id is the existing file to get the mode from (often the same
1340
as trans_id). The operation is only performed if there's a mode match
1341
according to typefunc.
1343
# is it ok to ignore this? probably
1346
def iter_tree_children(self, parent_id):
1347
"""Iterate through the entry's tree children, if any"""
1349
path = self._tree_id_paths[parent_id]
1352
file_id = self.tree_file_id(parent_id)
1353
for child in self._tree.inventory[file_id].children.iterkeys():
1354
childpath = joinpath(path, child)
1355
yield self.trans_id_tree_path(childpath)
1358
class _PreviewTree(tree.Tree):
1359
"""Partial implementation of Tree to support show_diff_trees"""
1361
def __init__(self, transform):
1362
self._transform = transform
1363
self._final_paths = FinalPaths(transform)
1365
def _changes(self, file_id):
1366
for changes in self._transform.iter_changes():
1367
if changes[0] == file_id:
1370
def _content_change(self, file_id):
1371
"""Return True if the content of this file changed"""
1372
changes = self._changes(file_id)
1373
# changes[2] is true if the file content changed. See
1374
# InterTree.iter_changes.
1375
return (changes is not None and changes[2])
1377
def _get_file_revision(self, file_id, vf, tree_revision):
1378
return self._transform._tree._get_file_revision(file_id, vf,
1381
def _stat_limbo_file(self, file_id):
1382
trans_id = self._transform.trans_id_file_id(file_id)
1383
name = self._transform._limbo_name(trans_id)
1384
return os.lstat(name)
1386
def lock_read(self):
1387
# Perhaps in theory, this should lock the TreeTransform?
1394
def inventory(self):
1395
"""This Tree does not use inventory as its backing data."""
1396
raise NotImplementedError(_PreviewTree.inventory)
1398
def get_root_id(self):
1399
return self._transform.final_file_id(self._transform.root)
1401
def all_file_ids(self):
1402
return self._transform._tree.all_file_ids()
1405
return iter(self.all_file_ids())
1407
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1408
"""See Tree.paths2ids"""
1409
to_find = set(specific_files)
1411
for (file_id, paths, changed, versioned, parent, name, kind,
1412
executable) in self._transform.iter_changes():
1413
if paths[1] in to_find:
1414
result.append(file_id)
1415
to_find.remove(paths[1])
1416
result.update(self._transform._tree.paths2ids(to_find,
1417
trees=[], require_versioned=require_versioned))
1420
def path2id(self, path):
1421
return self._transform._tree.path2id(path)
1423
def id2path(self, file_id):
1424
trans_id = self._transform.trans_id_file_id(file_id)
1426
return self._final_paths._determine_path(trans_id)
1428
raise errors.NoSuchId(self, file_id)
1430
def iter_entries_by_dir(self, specific_file_ids=None):
1431
return self._transform._tree.iter_entries_by_dir(specific_file_ids)
1433
def kind(self, file_id):
1434
trans_id = self._transform.trans_id_file_id(file_id)
1435
return self._transform.final_kind(trans_id)
1437
def stored_kind(self, file_id):
1438
return self._transform._tree.stored_kind(file_id)
1440
def get_file_mtime(self, file_id, path=None):
1441
"""See Tree.get_file_mtime"""
1442
if not self._content_change(file_id):
1443
return self._transform._tree.get_file_mtime(file_id, path)
1444
return self._stat_limbo_file(file_id).st_mtime
1446
def get_file_size(self, file_id):
1447
"""See Tree.get_file_size"""
1448
if self.kind(file_id) == 'file':
1449
return self._transform._tree.get_file_size(file_id)
1453
def get_file_sha1(self, file_id, path=None, stat_value=None):
1454
return self._transform._tree.get_file_sha1(file_id)
1456
def is_executable(self, file_id, path=None):
1457
return self._transform._tree.is_executable(file_id, path)
1459
def path_content_summary(self, path):
1460
return self._transform._tree.path_content_summary(path)
1462
def iter_changes(self, from_tree, include_unchanged=False,
1463
specific_files=None, pb=None, extra_trees=None,
1464
require_versioned=True, want_unversioned=False):
1465
"""See InterTree.iter_changes.
1467
This implementation does not support include_unchanged, specific_files,
1468
or want_unversioned. extra_trees, require_versioned, and pb are
1471
if from_tree is not self._transform._tree:
1472
raise ValueError('from_tree must be transform source tree.')
1473
if include_unchanged:
1474
raise ValueError('include_unchanged is not supported')
1475
if specific_files is not None:
1476
raise ValueError('specific_files is not supported')
1477
if want_unversioned:
1478
raise ValueError('want_unversioned is not supported')
1479
return self._transform.iter_changes()
1481
def get_file(self, file_id, path=None):
1482
"""See Tree.get_file"""
1483
if not self._content_change(file_id):
1484
return self._transform._tree.get_file(file_id, path)
1485
trans_id = self._transform.trans_id_file_id(file_id)
1486
name = self._transform._limbo_name(trans_id)
1487
return open(name, 'rb')
1489
def get_file_text(self, file_id):
1490
text_file = self.get_file(file_id)
1492
return text_file.read()
1496
def annotate_iter(self, file_id,
1497
default_revision=_mod_revision.CURRENT_REVISION):
1498
return self._transform._tree.annotate_iter(file_id,
1499
default_revision=default_revision)
1501
def get_symlink_target(self, file_id):
1502
"""See Tree.get_symlink_target"""
1503
if not self._content_change(file_id):
1504
return self._transform._tree.get_symlink_target(file_id)
1505
trans_id = self._transform.trans_id_file_id(file_id)
1506
name = self._transform._limbo_name(trans_id)
1507
return os.readlink(name)
1509
def list_files(self, include_root=False):
1510
return self._transform._tree.list_files(include_root)
1512
def walkdirs(self, prefix=""):
1513
return self._transform._tree.walkdirs(prefix)
1515
def get_parent_ids(self):
1516
return self._transform._tree.get_parent_ids()
1518
def get_revision_tree(self, revision_id):
1519
return self._transform._tree.get_revision_tree(revision_id)
1522
def joinpath(parent, child):
1523
"""Join tree-relative paths, handling the tree root specially"""
1524
if parent is None or parent == "":
1527
return pathjoin(parent, child)
1530
class FinalPaths(object):
1531
"""Make path calculation cheap by memoizing paths.
1533
The underlying tree must not be manipulated between calls, or else
1534
the results will likely be incorrect.
1536
def __init__(self, transform):
1537
object.__init__(self)
1538
self._known_paths = {}
1539
self.transform = transform
1541
def _determine_path(self, trans_id):
1542
if trans_id == self.transform.root:
1544
name = self.transform.final_name(trans_id)
1545
parent_id = self.transform.final_parent(trans_id)
1546
if parent_id == self.transform.root:
1549
return pathjoin(self.get_path(parent_id), name)
1551
def get_path(self, trans_id):
1552
"""Find the final path associated with a trans_id"""
1553
if trans_id not in self._known_paths:
1554
self._known_paths[trans_id] = self._determine_path(trans_id)
1555
return self._known_paths[trans_id]
1558
def topology_sorted_ids(tree):
1559
"""Determine the topological order of the ids in a tree"""
1560
file_ids = list(tree)
1561
file_ids.sort(key=tree.id2path)
1565
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1566
"""Create working tree for a branch, using a TreeTransform.
1568
This function should be used on empty trees, having a tree root at most.
1569
(see merge and revert functionality for working with existing trees)
1571
Existing files are handled like so:
1573
- Existing bzrdirs take precedence over creating new items. They are
1574
created as '%s.diverted' % name.
1575
- Otherwise, if the content on disk matches the content we are building,
1576
it is silently replaced.
1577
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1579
:param tree: The tree to convert wt into a copy of
1580
:param wt: The working tree that files will be placed into
1581
:param accelerator_tree: A tree which can be used for retrieving file
1582
contents more quickly than tree itself, i.e. a workingtree. tree
1583
will be used for cases where accelerator_tree's content is different.
1584
:param hardlink: If true, hard-link files to accelerator_tree, where
1585
possible. accelerator_tree must implement abspath, i.e. be a
1588
wt.lock_tree_write()
1592
if accelerator_tree is not None:
1593
accelerator_tree.lock_read()
1595
return _build_tree(tree, wt, accelerator_tree, hardlink)
1597
if accelerator_tree is not None:
1598
accelerator_tree.unlock()
1605
def _build_tree(tree, wt, accelerator_tree, hardlink):
1606
"""See build_tree."""
1607
for num, _unused in enumerate(wt.all_file_ids()):
1608
if num > 0: # more than just a root
1609
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1611
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1612
pp = ProgressPhase("Build phase", 2, top_pb)
1613
if tree.inventory.root is not None:
1614
# This is kind of a hack: we should be altering the root
1615
# as part of the regular tree shape diff logic.
1616
# The conditional test here is to avoid doing an
1617
# expensive operation (flush) every time the root id
1618
# is set within the tree, nor setting the root and thus
1619
# marking the tree as dirty, because we use two different
1620
# idioms here: tree interfaces and inventory interfaces.
1621
if wt.get_root_id() != tree.get_root_id():
1622
wt.set_root_id(tree.get_root_id())
1624
tt = TreeTransform(wt)
1628
file_trans_id[wt.get_root_id()] = \
1629
tt.trans_id_tree_file_id(wt.get_root_id())
1630
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1632
deferred_contents = []
1634
for num, (tree_path, entry) in \
1635
enumerate(tree.inventory.iter_entries_by_dir()):
1636
pb.update("Building tree", num - len(deferred_contents),
1637
len(tree.inventory))
1638
if entry.parent_id is None:
1641
file_id = entry.file_id
1642
target_path = wt.abspath(tree_path)
1644
kind = file_kind(target_path)
1648
if kind == "directory":
1650
bzrdir.BzrDir.open(target_path)
1651
except errors.NotBranchError:
1655
if (file_id not in divert and
1656
_content_match(tree, entry, file_id, kind,
1658
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1659
if kind == 'directory':
1661
if entry.parent_id not in file_trans_id:
1662
raise AssertionError(
1663
'entry %s parent id %r is not in file_trans_id %r'
1664
% (entry, entry.parent_id, file_trans_id))
1665
parent_id = file_trans_id[entry.parent_id]
1666
if entry.kind == 'file':
1667
# We *almost* replicate new_by_entry, so that we can defer
1668
# getting the file text, and get them all at once.
1669
trans_id = tt.create_path(entry.name, parent_id)
1670
file_trans_id[file_id] = trans_id
1671
tt.version_file(entry.file_id, trans_id)
1672
executable = tree.is_executable(entry.file_id, tree_path)
1673
if executable is not None:
1674
tt.set_executability(executable, trans_id)
1675
deferred_contents.append((entry.file_id, trans_id))
1677
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1680
new_trans_id = file_trans_id[file_id]
1681
old_parent = tt.trans_id_tree_path(tree_path)
1682
_reparent_children(tt, old_parent, new_trans_id)
1683
offset = num + 1 - len(deferred_contents)
1684
_create_files(tt, tree, deferred_contents, pb, offset,
1685
accelerator_tree, hardlink)
1689
divert_trans = set(file_trans_id[f] for f in divert)
1690
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1691
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1692
conflicts = cook_conflicts(raw_conflicts, tt)
1693
for conflict in conflicts:
1696
wt.add_conflicts(conflicts)
1697
except errors.UnsupportedOperation:
1699
result = tt.apply(no_conflicts=True)
1706
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1708
total = len(desired_files) + offset
1709
if accelerator_tree is None:
1710
new_desired_files = desired_files
1712
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1713
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1714
in iter if not (c or e[0] != e[1]))
1715
new_desired_files = []
1717
for file_id, trans_id in desired_files:
1718
accelerator_path = unchanged.get(file_id)
1719
if accelerator_path is None:
1720
new_desired_files.append((file_id, trans_id))
1722
pb.update('Adding file contents', count + offset, total)
1724
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1727
contents = accelerator_tree.get_file(file_id, accelerator_path)
1729
tt.create_file(contents, trans_id)
1734
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1735
new_desired_files)):
1736
tt.create_file(contents, trans_id)
1737
pb.update('Adding file contents', count + offset, total)
1740
def _reparent_children(tt, old_parent, new_parent):
1741
for child in tt.iter_tree_children(old_parent):
1742
tt.adjust_path(tt.final_name(child), new_parent, child)
1744
def _reparent_transform_children(tt, old_parent, new_parent):
1745
by_parent = tt.by_parent()
1746
for child in by_parent[old_parent]:
1747
tt.adjust_path(tt.final_name(child), new_parent, child)
1748
return by_parent[old_parent]
1750
def _content_match(tree, entry, file_id, kind, target_path):
1751
if entry.kind != kind:
1753
if entry.kind == "directory":
1755
if entry.kind == "file":
1756
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1758
elif entry.kind == "symlink":
1759
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1764
def resolve_checkout(tt, conflicts, divert):
1765
new_conflicts = set()
1766
for c_type, conflict in ((c[0], c) for c in conflicts):
1767
# Anything but a 'duplicate' would indicate programmer error
1768
if c_type != 'duplicate':
1769
raise AssertionError(c_type)
1770
# Now figure out which is new and which is old
1771
if tt.new_contents(conflict[1]):
1772
new_file = conflict[1]
1773
old_file = conflict[2]
1775
new_file = conflict[2]
1776
old_file = conflict[1]
1778
# We should only get here if the conflict wasn't completely
1780
final_parent = tt.final_parent(old_file)
1781
if new_file in divert:
1782
new_name = tt.final_name(old_file)+'.diverted'
1783
tt.adjust_path(new_name, final_parent, new_file)
1784
new_conflicts.add((c_type, 'Diverted to',
1785
new_file, old_file))
1787
new_name = tt.final_name(old_file)+'.moved'
1788
tt.adjust_path(new_name, final_parent, old_file)
1789
new_conflicts.add((c_type, 'Moved existing file to',
1790
old_file, new_file))
1791
return new_conflicts
1794
def new_by_entry(tt, entry, parent_id, tree):
1795
"""Create a new file according to its inventory entry"""
1799
contents = tree.get_file(entry.file_id).readlines()
1800
executable = tree.is_executable(entry.file_id)
1801
return tt.new_file(name, parent_id, contents, entry.file_id,
1803
elif kind in ('directory', 'tree-reference'):
1804
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1805
if kind == 'tree-reference':
1806
tt.set_tree_reference(entry.reference_revision, trans_id)
1808
elif kind == 'symlink':
1809
target = tree.get_symlink_target(entry.file_id)
1810
return tt.new_symlink(name, parent_id, target, entry.file_id)
1812
raise errors.BadFileKindError(name, kind)
1815
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1816
"""Create new file contents according to an inventory entry."""
1817
if entry.kind == "file":
1819
lines = tree.get_file(entry.file_id).readlines()
1820
tt.create_file(lines, trans_id, mode_id=mode_id)
1821
elif entry.kind == "symlink":
1822
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1823
elif entry.kind == "directory":
1824
tt.create_directory(trans_id)
1827
def create_entry_executability(tt, entry, trans_id):
1828
"""Set the executability of a trans_id according to an inventory entry"""
1829
if entry.kind == "file":
1830
tt.set_executability(entry.executable, trans_id)
1833
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1834
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1837
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1838
"""Produce a backup-style name that appears to be available"""
1842
yield "%s.~%d~" % (name, counter)
1844
for new_name in name_gen():
1845
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1849
def _entry_changes(file_id, entry, working_tree):
1850
"""Determine in which ways the inventory entry has changed.
1852
Returns booleans: has_contents, content_mod, meta_mod
1853
has_contents means there are currently contents, but they differ
1854
contents_mod means contents need to be modified
1855
meta_mod means the metadata needs to be modified
1857
cur_entry = working_tree.inventory[file_id]
1859
working_kind = working_tree.kind(file_id)
1862
has_contents = False
1865
if has_contents is True:
1866
if entry.kind != working_kind:
1867
contents_mod, meta_mod = True, False
1869
cur_entry._read_tree_state(working_tree.id2path(file_id),
1871
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1872
cur_entry._forget_tree_state()
1873
return has_contents, contents_mod, meta_mod
1876
def revert(working_tree, target_tree, filenames, backups=False,
1877
pb=DummyProgress(), change_reporter=None):
1878
"""Revert a working tree's contents to those of a target tree."""
1879
target_tree.lock_read()
1880
tt = TreeTransform(working_tree, pb)
1882
pp = ProgressPhase("Revert phase", 3, pb)
1884
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1886
merge_modified = _alter_files(working_tree, target_tree, tt,
1887
child_pb, filenames, backups)
1891
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1893
raw_conflicts = resolve_conflicts(tt, child_pb,
1894
lambda t, c: conflict_pass(t, c, target_tree))
1897
conflicts = cook_conflicts(raw_conflicts, tt)
1899
change_reporter = delta._ChangeReporter(
1900
unversioned_filter=working_tree.is_ignored)
1901
delta.report_changes(tt.iter_changes(), change_reporter)
1902
for conflict in conflicts:
1906
working_tree.set_merge_modified(merge_modified)
1908
target_tree.unlock()
1914
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1916
merge_modified = working_tree.merge_modified()
1917
change_list = target_tree.iter_changes(working_tree,
1918
specific_files=specific_files, pb=pb)
1919
if target_tree.inventory.root is None:
1926
for id_num, (file_id, path, changed_content, versioned, parent, name,
1927
kind, executable) in enumerate(change_list):
1928
if skip_root and file_id[0] is not None and parent[0] is None:
1930
trans_id = tt.trans_id_file_id(file_id)
1933
keep_content = False
1934
if kind[0] == 'file' and (backups or kind[1] is None):
1935
wt_sha1 = working_tree.get_file_sha1(file_id)
1936
if merge_modified.get(file_id) != wt_sha1:
1937
# acquire the basis tree lazily to prevent the
1938
# expense of accessing it when it's not needed ?
1939
# (Guessing, RBC, 200702)
1940
if basis_tree is None:
1941
basis_tree = working_tree.basis_tree()
1942
basis_tree.lock_read()
1943
if file_id in basis_tree:
1944
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1946
elif kind[1] is None and not versioned[1]:
1948
if kind[0] is not None:
1949
if not keep_content:
1950
tt.delete_contents(trans_id)
1951
elif kind[1] is not None:
1952
parent_trans_id = tt.trans_id_file_id(parent[0])
1953
by_parent = tt.by_parent()
1954
backup_name = _get_backup_name(name[0], by_parent,
1955
parent_trans_id, tt)
1956
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1957
new_trans_id = tt.create_path(name[0], parent_trans_id)
1958
if versioned == (True, True):
1959
tt.unversion_file(trans_id)
1960
tt.version_file(file_id, new_trans_id)
1961
# New contents should have the same unix perms as old
1964
trans_id = new_trans_id
1965
if kind[1] == 'directory':
1966
tt.create_directory(trans_id)
1967
elif kind[1] == 'symlink':
1968
tt.create_symlink(target_tree.get_symlink_target(file_id),
1970
elif kind[1] == 'file':
1971
deferred_files.append((file_id, (trans_id, mode_id)))
1972
if basis_tree is None:
1973
basis_tree = working_tree.basis_tree()
1974
basis_tree.lock_read()
1975
new_sha1 = target_tree.get_file_sha1(file_id)
1976
if (file_id in basis_tree and new_sha1 ==
1977
basis_tree.get_file_sha1(file_id)):
1978
if file_id in merge_modified:
1979
del merge_modified[file_id]
1981
merge_modified[file_id] = new_sha1
1983
# preserve the execute bit when backing up
1984
if keep_content and executable[0] == executable[1]:
1985
tt.set_executability(executable[1], trans_id)
1986
elif kind[1] is not None:
1987
raise AssertionError(kind[1])
1988
if versioned == (False, True):
1989
tt.version_file(file_id, trans_id)
1990
if versioned == (True, False):
1991
tt.unversion_file(trans_id)
1992
if (name[1] is not None and
1993
(name[0] != name[1] or parent[0] != parent[1])):
1995
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1996
if executable[0] != executable[1] and kind[1] == "file":
1997
tt.set_executability(executable[1], trans_id)
1998
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2000
tt.create_file(bytes, trans_id, mode_id)
2002
if basis_tree is not None:
2004
return merge_modified
2007
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2008
"""Make many conflict-resolution attempts, but die if they fail"""
2009
if pass_func is None:
2010
pass_func = conflict_pass
2011
new_conflicts = set()
2014
pb.update('Resolution pass', n+1, 10)
2015
conflicts = tt.find_conflicts()
2016
if len(conflicts) == 0:
2017
return new_conflicts
2018
new_conflicts.update(pass_func(tt, conflicts))
2019
raise MalformedTransform(conflicts=conflicts)
2024
def conflict_pass(tt, conflicts, path_tree=None):
2025
"""Resolve some classes of conflicts.
2027
:param tt: The transform to resolve conflicts in
2028
:param conflicts: The conflicts to resolve
2029
:param path_tree: A Tree to get supplemental paths from
2031
new_conflicts = set()
2032
for c_type, conflict in ((c[0], c) for c in conflicts):
2033
if c_type == 'duplicate id':
2034
tt.unversion_file(conflict[1])
2035
new_conflicts.add((c_type, 'Unversioned existing file',
2036
conflict[1], conflict[2], ))
2037
elif c_type == 'duplicate':
2038
# files that were renamed take precedence
2039
final_parent = tt.final_parent(conflict[1])
2040
if tt.path_changed(conflict[1]):
2041
existing_file, new_file = conflict[2], conflict[1]
2043
existing_file, new_file = conflict[1], conflict[2]
2044
new_name = tt.final_name(existing_file)+'.moved'
2045
tt.adjust_path(new_name, final_parent, existing_file)
2046
new_conflicts.add((c_type, 'Moved existing file to',
2047
existing_file, new_file))
2048
elif c_type == 'parent loop':
2049
# break the loop by undoing one of the ops that caused the loop
2051
while not tt.path_changed(cur):
2052
cur = tt.final_parent(cur)
2053
new_conflicts.add((c_type, 'Cancelled move', cur,
2054
tt.final_parent(cur),))
2055
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2057
elif c_type == 'missing parent':
2058
trans_id = conflict[1]
2060
tt.cancel_deletion(trans_id)
2061
new_conflicts.add(('deleting parent', 'Not deleting',
2066
tt.final_name(trans_id)
2068
if path_tree is not None:
2069
file_id = tt.final_file_id(trans_id)
2071
file_id = tt.inactive_file_id(trans_id)
2072
entry = path_tree.inventory[file_id]
2073
# special-case the other tree root (move its
2074
# children to current root)
2075
if entry.parent_id is None:
2077
moved = _reparent_transform_children(
2078
tt, trans_id, tt.root)
2080
new_conflicts.add((c_type, 'Moved to root',
2083
parent_trans_id = tt.trans_id_file_id(
2085
tt.adjust_path(entry.name, parent_trans_id,
2088
tt.create_directory(trans_id)
2089
new_conflicts.add((c_type, 'Created directory', trans_id))
2090
elif c_type == 'unversioned parent':
2091
file_id = tt.inactive_file_id(conflict[1])
2092
# special-case the other tree root (move its children instead)
2093
if path_tree and file_id in path_tree:
2094
if path_tree.inventory[file_id].parent_id is None:
2096
tt.version_file(file_id, conflict[1])
2097
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2098
elif c_type == 'non-directory parent':
2099
parent_id = conflict[1]
2100
parent_parent = tt.final_parent(parent_id)
2101
parent_name = tt.final_name(parent_id)
2102
parent_file_id = tt.final_file_id(parent_id)
2103
new_parent_id = tt.new_directory(parent_name + '.new',
2104
parent_parent, parent_file_id)
2105
_reparent_transform_children(tt, parent_id, new_parent_id)
2106
if parent_file_id is not None:
2107
tt.unversion_file(parent_id)
2108
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2109
return new_conflicts
2112
def cook_conflicts(raw_conflicts, tt):
2113
"""Generate a list of cooked conflicts, sorted by file path"""
2114
from bzrlib.conflicts import Conflict
2115
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2116
return sorted(conflict_iter, key=Conflict.sort_key)
2119
def iter_cook_conflicts(raw_conflicts, tt):
2120
from bzrlib.conflicts import Conflict
2122
for conflict in raw_conflicts:
2123
c_type = conflict[0]
2124
action = conflict[1]
2125
modified_path = fp.get_path(conflict[2])
2126
modified_id = tt.final_file_id(conflict[2])
2127
if len(conflict) == 3:
2128
yield Conflict.factory(c_type, action=action, path=modified_path,
2129
file_id=modified_id)
2132
conflicting_path = fp.get_path(conflict[3])
2133
conflicting_id = tt.final_file_id(conflict[3])
2134
yield Conflict.factory(c_type, action=action, path=modified_path,
2135
file_id=modified_id,
2136
conflict_path=conflicting_path,
2137
conflict_file_id=conflicting_id)
2140
class _FileMover(object):
2141
"""Moves and deletes files for TreeTransform, tracking operations"""
2144
self.past_renames = []
2145
self.pending_deletions = []
2147
def rename(self, from_, to):
2148
"""Rename a file from one path to another. Functions like os.rename"""
2150
os.rename(from_, to)
2152
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2153
raise errors.FileExists(to, str(e))
2155
self.past_renames.append((from_, to))
2157
def pre_delete(self, from_, to):
2158
"""Rename a file out of the way and mark it for deletion.
2160
Unlike os.unlink, this works equally well for files and directories.
2161
:param from_: The current file path
2162
:param to: A temporary path for the file
2164
self.rename(from_, to)
2165
self.pending_deletions.append(to)
2168
"""Reverse all renames that have been performed"""
2169
for from_, to in reversed(self.past_renames):
2170
os.rename(to, from_)
2171
# after rollback, don't reuse _FileMover
2173
pending_deletions = None
2175
def apply_deletions(self):
2176
"""Apply all marked deletions"""
2177
for path in self.pending_deletions:
2179
# after apply_deletions, don't reuse _FileMover
2181
pending_deletions = None
added
removed
bzrlib/transform.py
