1
# Copyright (C) 2006, 2007 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
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
30
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
31
ReusingTransform, NotVersionedError, CantMoveRoot,
32
ExistingLimbo, ImmortalLimbo, NoFinalPath,
34
from bzrlib.inventory import InventoryEntry
35
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
36
delete_any, has_symlinks)
37
from bzrlib.progress import DummyProgress, ProgressPhase
38
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 TreeTransform(object):
66
"""Represent a tree transformation.
68
This object is designed to support incremental generation of the transform,
71
However, it gives optimum performance when parent directories are created
72
before their contents. The transform is then able to put child files
73
directly in their parent directory, avoiding later renames.
75
It is easy to produce malformed transforms, but they are generally
76
harmless. Attempting to apply a malformed transform will cause an
77
exception to be raised before any modifications are made to the tree.
79
Many kinds of malformed transforms can be corrected with the
80
resolve_conflicts function. The remaining ones indicate programming error,
81
such as trying to create a file with no path.
83
Two sets of file creation methods are supplied. Convenience methods are:
88
These are composed of the low-level methods:
90
* create_file or create_directory or create_symlink
94
Transform/Transaction ids
95
-------------------------
96
trans_ids are temporary ids assigned to all files involved in a transform.
97
It's possible, even common, that not all files in the Tree have trans_ids.
99
trans_ids are used because filenames and file_ids are not good enough
100
identifiers; filenames change, and not all files have file_ids. File-ids
101
are also associated with trans-ids, so that moving a file moves its
104
trans_ids are only valid for the TreeTransform that generated them.
108
Limbo is a temporary directory use to hold new versions of files.
109
Files are added to limbo by create_file, create_directory, create_symlink,
110
and their convenience variants (new_*). Files may be removed from limbo
111
using cancel_creation. Files are renamed from limbo into their final
112
location as part of TreeTransform.apply
114
Limbo must be cleaned up, by either calling TreeTransform.apply or
115
calling TreeTransform.finalize.
117
Files are placed into limbo inside their parent directories, where
118
possible. This reduces subsequent renames, and makes operations involving
119
lots of files faster. This optimization is only possible if the parent
120
directory is created *before* creating any of its children, so avoid
121
creating children before parents, where possible.
125
This temporary directory is used by _FileMover for storing files that are
126
about to be deleted. In case of rollback, the files will be restored.
127
FileMover does not delete files until it is sure that a rollback will not
130
def __init__(self, tree, pb=DummyProgress()):
131
"""Note: a tree_write lock is taken on the tree.
133
Use TreeTransform.finalize() to release the lock (can be omitted if
134
TreeTransform.apply() called).
136
object.__init__(self)
138
self._tree.lock_tree_write()
140
control_files = self._tree._control_files
141
self._limbodir = urlutils.local_path_from_url(
142
control_files.controlfilename('limbo'))
144
os.mkdir(self._limbodir)
146
if e.errno == errno.EEXIST:
147
raise ExistingLimbo(self._limbodir)
148
self._deletiondir = urlutils.local_path_from_url(
149
control_files.controlfilename('pending-deletion'))
151
os.mkdir(self._deletiondir)
153
if e.errno == errno.EEXIST:
154
raise errors.ExistingPendingDeletion(self._deletiondir)
160
# counter used to generate trans-ids (which are locally unique)
162
# mapping of trans_id -> new basename
164
# mapping of trans_id -> new parent trans_id
165
self._new_parent = {}
166
# mapping of trans_id with new contents -> new file_kind
167
self._new_contents = {}
168
# A mapping of transform ids to their limbo filename
169
self._limbo_files = {}
170
# A mapping of transform ids to a set of the transform ids of children
171
# that their limbo directory has
172
self._limbo_children = {}
173
# Map transform ids to maps of child filename to child transform id
174
self._limbo_children_names = {}
175
# List of transform ids that need to be renamed from limbo into place
176
self._needs_rename = set()
177
# Set of trans_ids whose contents will be removed
178
self._removed_contents = set()
179
# Mapping of trans_id -> new execute-bit value
180
self._new_executability = {}
181
# Mapping of trans_id -> new tree-reference value
182
self._new_reference_revision = {}
183
# Mapping of trans_id -> new file_id
185
# Mapping of old file-id -> trans_id
186
self._non_present_ids = {}
187
# Mapping of new file_id -> trans_id
189
# Set of file_ids that will be removed
190
self._removed_id = set()
191
# Mapping of path in old tree -> trans_id
192
self._tree_path_ids = {}
193
# Mapping trans_id -> path in old tree
194
self._tree_id_paths = {}
195
# Cache of realpath results, to speed up canonical_path
197
# Cache of relpath results, to speed up canonical_path
199
# The trans_id that will be used as the tree root
200
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
201
# Indictor of whether the transform has been applied
205
# A counter of how many files have been renamed
206
self.rename_count = 0
208
def __get_root(self):
209
return self._new_root
211
root = property(__get_root)
214
"""Release the working tree lock, if held, clean up limbo dir.
216
This is required if apply has not been invoked, but can be invoked
219
if self._tree is None:
222
entries = [(self._limbo_name(t), t, k) for t, k in
223
self._new_contents.iteritems()]
224
entries.sort(reverse=True)
225
for path, trans_id, kind in entries:
226
if kind == "directory":
231
os.rmdir(self._limbodir)
233
# We don't especially care *why* the dir is immortal.
234
raise ImmortalLimbo(self._limbodir)
236
os.rmdir(self._deletiondir)
238
raise errors.ImmortalPendingDeletion(self._deletiondir)
243
def _assign_id(self):
244
"""Produce a new tranform id"""
245
new_id = "new-%s" % self._id_number
249
def create_path(self, name, parent):
250
"""Assign a transaction id to a new path"""
251
trans_id = self._assign_id()
252
unique_add(self._new_name, trans_id, name)
253
unique_add(self._new_parent, trans_id, parent)
256
def adjust_path(self, name, parent, trans_id):
257
"""Change the path that is assigned to a transaction id."""
258
if trans_id == self._new_root:
260
previous_parent = self._new_parent.get(trans_id)
261
previous_name = self._new_name.get(trans_id)
262
self._new_name[trans_id] = name
263
self._new_parent[trans_id] = parent
264
if (trans_id in self._limbo_files and
265
trans_id not in self._needs_rename):
266
self._rename_in_limbo([trans_id])
267
self._limbo_children[previous_parent].remove(trans_id)
268
del self._limbo_children_names[previous_parent][previous_name]
270
def _rename_in_limbo(self, trans_ids):
271
"""Fix limbo names so that the right final path is produced.
273
This means we outsmarted ourselves-- we tried to avoid renaming
274
these files later by creating them with their final names in their
275
final parents. But now the previous name or parent is no longer
276
suitable, so we have to rename them.
278
Even for trans_ids that have no new contents, we must remove their
279
entries from _limbo_files, because they are now stale.
281
for trans_id in trans_ids:
282
old_path = self._limbo_files.pop(trans_id)
283
if trans_id not in self._new_contents:
285
new_path = self._limbo_name(trans_id)
286
os.rename(old_path, new_path)
288
def adjust_root_path(self, name, parent):
289
"""Emulate moving the root by moving all children, instead.
291
We do this by undoing the association of root's transaction id with the
292
current tree. This allows us to create a new directory with that
293
transaction id. We unversion the root directory and version the
294
physically new directory, and hope someone versions the tree root
297
old_root = self._new_root
298
old_root_file_id = self.final_file_id(old_root)
299
# force moving all children of root
300
for child_id in self.iter_tree_children(old_root):
301
if child_id != parent:
302
self.adjust_path(self.final_name(child_id),
303
self.final_parent(child_id), child_id)
304
file_id = self.final_file_id(child_id)
305
if file_id is not None:
306
self.unversion_file(child_id)
307
self.version_file(file_id, child_id)
309
# the physical root needs a new transaction id
310
self._tree_path_ids.pop("")
311
self._tree_id_paths.pop(old_root)
312
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
313
if parent == old_root:
314
parent = self._new_root
315
self.adjust_path(name, parent, old_root)
316
self.create_directory(old_root)
317
self.version_file(old_root_file_id, old_root)
318
self.unversion_file(self._new_root)
320
def trans_id_tree_file_id(self, inventory_id):
321
"""Determine the transaction id of a working tree file.
323
This reflects only files that already exist, not ones that will be
324
added by transactions.
326
path = self._tree.inventory.id2path(inventory_id)
327
return self.trans_id_tree_path(path)
329
def trans_id_file_id(self, file_id):
330
"""Determine or set the transaction id associated with a file ID.
331
A new id is only created for file_ids that were never present. If
332
a transaction has been unversioned, it is deliberately still returned.
333
(this will likely lead to an unversioned parent conflict.)
335
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
336
return self._r_new_id[file_id]
337
elif file_id in self._tree.inventory:
338
return self.trans_id_tree_file_id(file_id)
339
elif file_id in self._non_present_ids:
340
return self._non_present_ids[file_id]
342
trans_id = self._assign_id()
343
self._non_present_ids[file_id] = trans_id
346
def canonical_path(self, path):
347
"""Get the canonical tree-relative path"""
348
# don't follow final symlinks
349
abs = self._tree.abspath(path)
350
if abs in self._relpaths:
351
return self._relpaths[abs]
352
dirname, basename = os.path.split(abs)
353
if dirname not in self._realpaths:
354
self._realpaths[dirname] = os.path.realpath(dirname)
355
dirname = self._realpaths[dirname]
356
abs = pathjoin(dirname, basename)
357
if dirname in self._relpaths:
358
relpath = pathjoin(self._relpaths[dirname], basename)
359
relpath = relpath.rstrip('/\\')
361
relpath = self._tree.relpath(abs)
362
self._relpaths[abs] = relpath
365
def trans_id_tree_path(self, path):
366
"""Determine (and maybe set) the transaction ID for a tree path."""
367
path = self.canonical_path(path)
368
if path not in self._tree_path_ids:
369
self._tree_path_ids[path] = self._assign_id()
370
self._tree_id_paths[self._tree_path_ids[path]] = path
371
return self._tree_path_ids[path]
373
def get_tree_parent(self, trans_id):
374
"""Determine id of the parent in the tree."""
375
path = self._tree_id_paths[trans_id]
378
return self.trans_id_tree_path(os.path.dirname(path))
380
def create_file(self, contents, trans_id, mode_id=None):
381
"""Schedule creation of a new file.
385
Contents is an iterator of strings, all of which will be written
386
to the target destination.
388
New file takes the permissions of any existing file with that id,
389
unless mode_id is specified.
391
name = self._limbo_name(trans_id)
395
unique_add(self._new_contents, trans_id, 'file')
397
# Clean up the file, it never got registered so
398
# TreeTransform.finalize() won't clean it up.
403
f.writelines(contents)
406
self._set_mode(trans_id, mode_id, S_ISREG)
408
def _set_mode(self, trans_id, mode_id, typefunc):
409
"""Set the mode of new file contents.
410
The mode_id is the existing file to get the mode from (often the same
411
as trans_id). The operation is only performed if there's a mode match
412
according to typefunc.
417
old_path = self._tree_id_paths[mode_id]
421
mode = os.stat(self._tree.abspath(old_path)).st_mode
423
if e.errno == errno.ENOENT:
428
os.chmod(self._limbo_name(trans_id), mode)
430
def create_directory(self, trans_id):
431
"""Schedule creation of a new directory.
433
See also new_directory.
435
os.mkdir(self._limbo_name(trans_id))
436
unique_add(self._new_contents, trans_id, 'directory')
438
def create_symlink(self, target, trans_id):
439
"""Schedule creation of a new symbolic link.
441
target is a bytestring.
442
See also new_symlink.
445
os.symlink(target, self._limbo_name(trans_id))
446
unique_add(self._new_contents, trans_id, 'symlink')
449
path = FinalPaths(self).get_path(trans_id)
452
raise UnableCreateSymlink(path=path)
454
def cancel_creation(self, trans_id):
455
"""Cancel the creation of new file contents."""
456
del self._new_contents[trans_id]
457
children = self._limbo_children.get(trans_id)
458
# if this is a limbo directory with children, move them before removing
460
if children is not None:
461
self._rename_in_limbo(children)
462
del self._limbo_children[trans_id]
463
del self._limbo_children_names[trans_id]
464
delete_any(self._limbo_name(trans_id))
466
def delete_contents(self, trans_id):
467
"""Schedule the contents of a path entry for deletion"""
468
self.tree_kind(trans_id)
469
self._removed_contents.add(trans_id)
471
def cancel_deletion(self, trans_id):
472
"""Cancel a scheduled deletion"""
473
self._removed_contents.remove(trans_id)
475
def unversion_file(self, trans_id):
476
"""Schedule a path entry to become unversioned"""
477
self._removed_id.add(trans_id)
479
def delete_versioned(self, trans_id):
480
"""Delete and unversion a versioned file"""
481
self.delete_contents(trans_id)
482
self.unversion_file(trans_id)
484
def set_executability(self, executability, trans_id):
485
"""Schedule setting of the 'execute' bit
486
To unschedule, set to None
488
if executability is None:
489
del self._new_executability[trans_id]
491
unique_add(self._new_executability, trans_id, executability)
493
def set_tree_reference(self, revision_id, trans_id):
494
"""Set the reference associated with a directory"""
495
unique_add(self._new_reference_revision, trans_id, revision_id)
497
def version_file(self, file_id, trans_id):
498
"""Schedule a file to become versioned."""
499
assert file_id is not None
500
unique_add(self._new_id, trans_id, file_id)
501
unique_add(self._r_new_id, file_id, trans_id)
503
def cancel_versioning(self, trans_id):
504
"""Undo a previous versioning of a file"""
505
file_id = self._new_id[trans_id]
506
del self._new_id[trans_id]
507
del self._r_new_id[file_id]
510
"""Determine the paths of all new and changed files"""
512
fp = FinalPaths(self)
513
for id_set in (self._new_name, self._new_parent, self._new_contents,
514
self._new_id, self._new_executability):
515
new_ids.update(id_set)
516
new_paths = [(fp.get_path(t), t) for t in new_ids]
520
def tree_kind(self, trans_id):
521
"""Determine the file kind in the working tree.
523
Raises NoSuchFile if the file does not exist
525
path = self._tree_id_paths.get(trans_id)
527
raise NoSuchFile(None)
529
return file_kind(self._tree.abspath(path))
531
if e.errno != errno.ENOENT:
534
raise NoSuchFile(path)
536
def final_kind(self, trans_id):
537
"""Determine the final file kind, after any changes applied.
539
Raises NoSuchFile if the file does not exist/has no contents.
540
(It is conceivable that a path would be created without the
541
corresponding contents insertion command)
543
if trans_id in self._new_contents:
544
return self._new_contents[trans_id]
545
elif trans_id in self._removed_contents:
546
raise NoSuchFile(None)
548
return self.tree_kind(trans_id)
550
def tree_file_id(self, trans_id):
551
"""Determine the file id associated with the trans_id in the tree"""
553
path = self._tree_id_paths[trans_id]
555
# the file is a new, unversioned file, or invalid trans_id
557
# the file is old; the old id is still valid
558
if self._new_root == trans_id:
559
return self._tree.get_root_id()
560
return self._tree.inventory.path2id(path)
562
def final_file_id(self, trans_id):
563
"""Determine the file id after any changes are applied, or None.
565
None indicates that the file will not be versioned after changes are
569
# there is a new id for this file
570
assert self._new_id[trans_id] is not None
571
return self._new_id[trans_id]
573
if trans_id in self._removed_id:
575
return self.tree_file_id(trans_id)
577
def inactive_file_id(self, trans_id):
578
"""Return the inactive file_id associated with a transaction id.
579
That is, the one in the tree or in non_present_ids.
580
The file_id may actually be active, too.
582
file_id = self.tree_file_id(trans_id)
583
if file_id is not None:
585
for key, value in self._non_present_ids.iteritems():
586
if value == trans_id:
589
def final_parent(self, trans_id):
590
"""Determine the parent file_id, after any changes are applied.
592
ROOT_PARENT is returned for the tree root.
595
return self._new_parent[trans_id]
597
return self.get_tree_parent(trans_id)
599
def final_name(self, trans_id):
600
"""Determine the final filename, after all changes are applied."""
602
return self._new_name[trans_id]
605
return os.path.basename(self._tree_id_paths[trans_id])
607
raise NoFinalPath(trans_id, self)
610
"""Return a map of parent: children for known parents.
612
Only new paths and parents of tree files with assigned ids are used.
615
items = list(self._new_parent.iteritems())
616
items.extend((t, self.final_parent(t)) for t in
617
self._tree_id_paths.keys())
618
for trans_id, parent_id in items:
619
if parent_id not in by_parent:
620
by_parent[parent_id] = set()
621
by_parent[parent_id].add(trans_id)
624
def path_changed(self, trans_id):
625
"""Return True if a trans_id's path has changed."""
626
return (trans_id in self._new_name) or (trans_id in self._new_parent)
628
def new_contents(self, trans_id):
629
return (trans_id in self._new_contents)
631
def find_conflicts(self):
632
"""Find any violations of inventory or filesystem invariants"""
633
if self.__done is True:
634
raise ReusingTransform()
636
# ensure all children of all existent parents are known
637
# all children of non-existent parents are known, by definition.
638
self._add_tree_children()
639
by_parent = self.by_parent()
640
conflicts.extend(self._unversioned_parents(by_parent))
641
conflicts.extend(self._parent_loops())
642
conflicts.extend(self._duplicate_entries(by_parent))
643
conflicts.extend(self._duplicate_ids())
644
conflicts.extend(self._parent_type_conflicts(by_parent))
645
conflicts.extend(self._improper_versioning())
646
conflicts.extend(self._executability_conflicts())
647
conflicts.extend(self._overwrite_conflicts())
650
def _add_tree_children(self):
651
"""Add all the children of all active parents to the known paths.
653
Active parents are those which gain children, and those which are
654
removed. This is a necessary first step in detecting conflicts.
656
parents = self.by_parent().keys()
657
parents.extend([t for t in self._removed_contents if
658
self.tree_kind(t) == 'directory'])
659
for trans_id in self._removed_id:
660
file_id = self.tree_file_id(trans_id)
661
if file_id is not None:
662
if self._tree.inventory[file_id].kind == 'directory':
663
parents.append(trans_id)
664
elif self.tree_kind(trans_id) == 'directory':
665
parents.append(trans_id)
667
for parent_id in parents:
668
# ensure that all children are registered with the transaction
669
list(self.iter_tree_children(parent_id))
671
def iter_tree_children(self, parent_id):
672
"""Iterate through the entry's tree children, if any"""
674
path = self._tree_id_paths[parent_id]
678
children = os.listdir(self._tree.abspath(path))
680
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
684
for child in children:
685
childpath = joinpath(path, child)
686
if self._tree.is_control_filename(childpath):
688
yield self.trans_id_tree_path(childpath)
690
def has_named_child(self, by_parent, parent_id, name):
692
children = by_parent[parent_id]
695
for child in children:
696
if self.final_name(child) == name:
699
path = self._tree_id_paths[parent_id]
702
childpath = joinpath(path, name)
703
child_id = self._tree_path_ids.get(childpath)
705
return lexists(self._tree.abspath(childpath))
707
if self.final_parent(child_id) != parent_id:
709
if child_id in self._removed_contents:
710
# XXX What about dangling file-ids?
715
def _parent_loops(self):
716
"""No entry should be its own ancestor"""
718
for trans_id in self._new_parent:
721
while parent_id is not ROOT_PARENT:
724
parent_id = self.final_parent(parent_id)
727
if parent_id == trans_id:
728
conflicts.append(('parent loop', trans_id))
729
if parent_id in seen:
733
def _unversioned_parents(self, by_parent):
734
"""If parent directories are versioned, children must be versioned."""
736
for parent_id, children in by_parent.iteritems():
737
if parent_id is ROOT_PARENT:
739
if self.final_file_id(parent_id) is not None:
741
for child_id in children:
742
if self.final_file_id(child_id) is not None:
743
conflicts.append(('unversioned parent', parent_id))
747
def _improper_versioning(self):
748
"""Cannot version a file with no contents, or a bad type.
750
However, existing entries with no contents are okay.
753
for trans_id in self._new_id.iterkeys():
755
kind = self.final_kind(trans_id)
757
conflicts.append(('versioning no contents', trans_id))
759
if not InventoryEntry.versionable_kind(kind):
760
conflicts.append(('versioning bad kind', trans_id, kind))
763
def _executability_conflicts(self):
764
"""Check for bad executability changes.
766
Only versioned files may have their executability set, because
767
1. only versioned entries can have executability under windows
768
2. only files can be executable. (The execute bit on a directory
769
does not indicate searchability)
772
for trans_id in self._new_executability:
773
if self.final_file_id(trans_id) is None:
774
conflicts.append(('unversioned executability', trans_id))
777
non_file = self.final_kind(trans_id) != "file"
781
conflicts.append(('non-file executability', trans_id))
784
def _overwrite_conflicts(self):
785
"""Check for overwrites (not permitted on Win32)"""
787
for trans_id in self._new_contents:
789
self.tree_kind(trans_id)
792
if trans_id not in self._removed_contents:
793
conflicts.append(('overwrite', trans_id,
794
self.final_name(trans_id)))
797
def _duplicate_entries(self, by_parent):
798
"""No directory may have two entries with the same name."""
800
if (self._new_name, self._new_parent) == ({}, {}):
802
for children in by_parent.itervalues():
803
name_ids = [(self.final_name(t), t) for t in children]
804
if not self._tree.case_sensitive:
805
name_ids = [(n.lower(), t) for n, t in name_ids]
809
for name, trans_id in name_ids:
811
kind = self.final_kind(trans_id)
814
file_id = self.final_file_id(trans_id)
815
if kind is None and file_id is None:
817
if name == last_name:
818
conflicts.append(('duplicate', last_trans_id, trans_id,
821
last_trans_id = trans_id
824
def _duplicate_ids(self):
825
"""Each inventory id may only be used once"""
827
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
829
active_tree_ids = set((f for f in self._tree.inventory if
830
f not in removed_tree_ids))
831
for trans_id, file_id in self._new_id.iteritems():
832
if file_id in active_tree_ids:
833
old_trans_id = self.trans_id_tree_file_id(file_id)
834
conflicts.append(('duplicate id', old_trans_id, trans_id))
837
def _parent_type_conflicts(self, by_parent):
838
"""parents must have directory 'contents'."""
840
for parent_id, children in by_parent.iteritems():
841
if parent_id is ROOT_PARENT:
843
if not self._any_contents(children):
845
for child in children:
847
self.final_kind(child)
851
kind = self.final_kind(parent_id)
855
conflicts.append(('missing parent', parent_id))
856
elif kind != "directory":
857
conflicts.append(('non-directory parent', parent_id))
860
def _any_contents(self, trans_ids):
861
"""Return true if any of the trans_ids, will have contents."""
862
for trans_id in trans_ids:
864
kind = self.final_kind(trans_id)
870
def apply(self, no_conflicts=False, _mover=None):
871
"""Apply all changes to the inventory and filesystem.
873
If filesystem or inventory conflicts are present, MalformedTransform
876
If apply succeeds, finalize is not necessary.
878
:param no_conflicts: if True, the caller guarantees there are no
879
conflicts, so no check is made.
880
:param _mover: Supply an alternate FileMover, for testing
883
conflicts = self.find_conflicts()
884
if len(conflicts) != 0:
885
raise MalformedTransform(conflicts=conflicts)
886
inv = self._tree.inventory
888
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
895
child_pb.update('Apply phase', 0, 2)
896
self._apply_removals(inv, inventory_delta, mover)
897
child_pb.update('Apply phase', 1, 2)
898
modified_paths = self._apply_insertions(inv, inventory_delta,
904
mover.apply_deletions()
907
self._tree.apply_inventory_delta(inventory_delta)
910
return _TransformResults(modified_paths, self.rename_count)
912
def _limbo_name(self, trans_id):
913
"""Generate the limbo name of a file"""
914
limbo_name = self._limbo_files.get(trans_id)
915
if limbo_name is not None:
917
parent = self._new_parent.get(trans_id)
918
# if the parent directory is already in limbo (e.g. when building a
919
# tree), choose a limbo name inside the parent, to reduce further
921
use_direct_path = False
922
if self._new_contents.get(parent) == 'directory':
923
filename = self._new_name.get(trans_id)
924
if filename is not None:
925
if parent not in self._limbo_children:
926
self._limbo_children[parent] = set()
927
self._limbo_children_names[parent] = {}
928
use_direct_path = True
929
# the direct path can only be used if no other file has
930
# already taken this pathname, i.e. if the name is unused, or
931
# if it is already associated with this trans_id.
932
elif self._tree.case_sensitive:
933
if (self._limbo_children_names[parent].get(filename)
934
in (trans_id, None)):
935
use_direct_path = True
937
for l_filename, l_trans_id in\
938
self._limbo_children_names[parent].iteritems():
939
if l_trans_id == trans_id:
941
if l_filename.lower() == filename.lower():
944
use_direct_path = True
947
limbo_name = pathjoin(self._limbo_files[parent], filename)
948
self._limbo_children[parent].add(trans_id)
949
self._limbo_children_names[parent][filename] = trans_id
951
limbo_name = pathjoin(self._limbodir, trans_id)
952
self._needs_rename.add(trans_id)
953
self._limbo_files[trans_id] = limbo_name
956
def _apply_removals(self, inv, inventory_delta, mover):
957
"""Perform tree operations that remove directory/inventory names.
959
That is, delete files that are to be deleted, and put any files that
960
need renaming into limbo. This must be done in strict child-to-parent
963
tree_paths = list(self._tree_path_ids.iteritems())
964
tree_paths.sort(reverse=True)
965
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
967
for num, data in enumerate(tree_paths):
968
path, trans_id = data
969
child_pb.update('removing file', num, len(tree_paths))
970
full_path = self._tree.abspath(path)
971
if trans_id in self._removed_contents:
972
mover.pre_delete(full_path, os.path.join(self._deletiondir,
974
elif trans_id in self._new_name or trans_id in \
977
mover.rename(full_path, self._limbo_name(trans_id))
979
if e.errno != errno.ENOENT:
982
self.rename_count += 1
983
if trans_id in self._removed_id:
984
if trans_id == self._new_root:
985
file_id = self._tree.get_root_id()
987
file_id = self.tree_file_id(trans_id)
988
if file_id is not None:
989
inventory_delta.append((path, None, file_id, None))
993
def _apply_insertions(self, inv, inventory_delta, mover):
994
"""Perform tree operations that insert directory/inventory names.
996
That is, create any files that need to be created, and restore from
997
limbo any files that needed renaming. This must be done in strict
998
parent-to-child order.
1000
new_paths = self.new_paths()
1002
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1005
for num, (path, trans_id) in enumerate(new_paths):
1007
child_pb.update('adding file', num, len(new_paths))
1009
kind = self._new_contents[trans_id]
1011
kind = contents = None
1012
if trans_id in self._new_contents or \
1013
self.path_changed(trans_id):
1014
full_path = self._tree.abspath(path)
1015
if trans_id in self._needs_rename:
1017
mover.rename(self._limbo_name(trans_id), full_path)
1019
# We may be renaming a dangling inventory id
1020
if e.errno != errno.ENOENT:
1023
self.rename_count += 1
1024
if trans_id in self._new_contents:
1025
modified_paths.append(full_path)
1026
completed_new.append(trans_id)
1028
if trans_id in self._new_id:
1030
kind = file_kind(self._tree.abspath(path))
1031
if trans_id in self._new_reference_revision:
1032
new_entry = inventory.TreeReference(
1033
self._new_id[trans_id],
1034
self._new_name[trans_id],
1035
self.final_file_id(self._new_parent[trans_id]),
1036
None, self._new_reference_revision[trans_id])
1038
new_entry = inventory.make_entry(kind,
1039
self.final_name(trans_id),
1040
self.final_file_id(self.final_parent(trans_id)),
1041
self._new_id[trans_id])
1043
if trans_id in self._new_name or trans_id in\
1044
self._new_parent or\
1045
trans_id in self._new_executability:
1046
file_id = self.final_file_id(trans_id)
1047
if file_id is not None:
1048
entry = inv[file_id]
1049
new_entry = entry.copy()
1051
if trans_id in self._new_name or trans_id in\
1053
if new_entry is not None:
1054
new_entry.name = self.final_name(trans_id)
1055
parent = self.final_parent(trans_id)
1056
parent_id = self.final_file_id(parent)
1057
new_entry.parent_id = parent_id
1059
if trans_id in self._new_executability:
1060
self._set_executability(path, new_entry, trans_id)
1061
if new_entry is not None:
1062
if new_entry.file_id in inv:
1063
old_path = inv.id2path(new_entry.file_id)
1066
inventory_delta.append((old_path, path,
1071
for trans_id in completed_new:
1072
del self._new_contents[trans_id]
1073
return modified_paths
1075
def _set_executability(self, path, entry, trans_id):
1076
"""Set the executability of versioned files """
1077
new_executability = self._new_executability[trans_id]
1078
entry.executable = new_executability
1079
if supports_executable():
1080
abspath = self._tree.abspath(path)
1081
current_mode = os.stat(abspath).st_mode
1082
if new_executability:
1085
to_mode = current_mode | (0100 & ~umask)
1086
# Enable x-bit for others only if they can read it.
1087
if current_mode & 0004:
1088
to_mode |= 0001 & ~umask
1089
if current_mode & 0040:
1090
to_mode |= 0010 & ~umask
1092
to_mode = current_mode & ~0111
1093
os.chmod(abspath, to_mode)
1095
def _new_entry(self, name, parent_id, file_id):
1096
"""Helper function to create a new filesystem entry."""
1097
trans_id = self.create_path(name, parent_id)
1098
if file_id is not None:
1099
self.version_file(file_id, trans_id)
1102
def new_file(self, name, parent_id, contents, file_id=None,
1104
"""Convenience method to create files.
1106
name is the name of the file to create.
1107
parent_id is the transaction id of the parent directory of the file.
1108
contents is an iterator of bytestrings, which will be used to produce
1110
:param file_id: The inventory ID of the file, if it is to be versioned.
1111
:param executable: Only valid when a file_id has been supplied.
1113
trans_id = self._new_entry(name, parent_id, file_id)
1114
# TODO: rather than scheduling a set_executable call,
1115
# have create_file create the file with the right mode.
1116
self.create_file(contents, trans_id)
1117
if executable is not None:
1118
self.set_executability(executable, trans_id)
1121
def new_directory(self, name, parent_id, file_id=None):
1122
"""Convenience method to create directories.
1124
name is the name of the directory to create.
1125
parent_id is the transaction id of the parent directory of the
1127
file_id is the inventory ID of the directory, if it is to be versioned.
1129
trans_id = self._new_entry(name, parent_id, file_id)
1130
self.create_directory(trans_id)
1133
def new_symlink(self, name, parent_id, target, file_id=None):
1134
"""Convenience method to create symbolic link.
1136
name is the name of the symlink to create.
1137
parent_id is the transaction id of the parent directory of the symlink.
1138
target is a bytestring of the target of the symlink.
1139
file_id is the inventory ID of the file, if it is to be versioned.
1141
trans_id = self._new_entry(name, parent_id, file_id)
1142
self.create_symlink(target, trans_id)
1145
def _affected_ids(self):
1146
"""Return the set of transform ids affected by the transform"""
1147
trans_ids = set(self._removed_id)
1148
trans_ids.update(self._new_id.keys())
1149
trans_ids.update(self._removed_contents)
1150
trans_ids.update(self._new_contents.keys())
1151
trans_ids.update(self._new_executability.keys())
1152
trans_ids.update(self._new_name.keys())
1153
trans_ids.update(self._new_parent.keys())
1156
def _get_file_id_maps(self):
1157
"""Return mapping of file_ids to trans_ids in the to and from states"""
1158
trans_ids = self._affected_ids()
1161
# Build up two dicts: trans_ids associated with file ids in the
1162
# FROM state, vs the TO state.
1163
for trans_id in trans_ids:
1164
from_file_id = self.tree_file_id(trans_id)
1165
if from_file_id is not None:
1166
from_trans_ids[from_file_id] = trans_id
1167
to_file_id = self.final_file_id(trans_id)
1168
if to_file_id is not None:
1169
to_trans_ids[to_file_id] = trans_id
1170
return from_trans_ids, to_trans_ids
1172
def _from_file_data(self, from_trans_id, from_versioned, file_id):
1173
"""Get data about a file in the from (tree) state
1175
Return a (name, parent, kind, executable) tuple
1177
from_path = self._tree_id_paths.get(from_trans_id)
1179
# get data from working tree if versioned
1180
from_entry = self._tree.inventory[file_id]
1181
from_name = from_entry.name
1182
from_parent = from_entry.parent_id
1185
if from_path is None:
1186
# File does not exist in FROM state
1190
# File exists, but is not versioned. Have to use path-
1192
from_name = os.path.basename(from_path)
1193
tree_parent = self.get_tree_parent(from_trans_id)
1194
from_parent = self.tree_file_id(tree_parent)
1195
if from_path is not None:
1196
from_kind, from_executable, from_stats = \
1197
self._tree._comparison_data(from_entry, from_path)
1200
from_executable = False
1201
return from_name, from_parent, from_kind, from_executable
1203
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1204
"""Get data about a file in the to (target) state
1206
Return a (name, parent, kind, executable) tuple
1208
to_name = self.final_name(to_trans_id)
1210
to_kind = self.final_kind(to_trans_id)
1213
to_parent = self.final_file_id(self.final_parent(to_trans_id))
1214
if to_trans_id in self._new_executability:
1215
to_executable = self._new_executability[to_trans_id]
1216
elif to_trans_id == from_trans_id:
1217
to_executable = from_executable
1219
to_executable = False
1220
return to_name, to_parent, to_kind, to_executable
1222
def _iter_changes(self):
1223
"""Produce output in the same format as Tree._iter_changes.
1225
Will produce nonsensical results if invoked while inventory/filesystem
1226
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1228
This reads the Transform, but only reproduces changes involving a
1229
file_id. Files that are not versioned in either of the FROM or TO
1230
states are not reflected.
1232
final_paths = FinalPaths(self)
1233
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1235
# Now iterate through all active file_ids
1236
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1238
from_trans_id = from_trans_ids.get(file_id)
1239
# find file ids, and determine versioning state
1240
if from_trans_id is None:
1241
from_versioned = False
1242
from_trans_id = to_trans_ids[file_id]
1244
from_versioned = True
1245
to_trans_id = to_trans_ids.get(file_id)
1246
if to_trans_id is None:
1247
to_versioned = False
1248
to_trans_id = from_trans_id
1252
from_name, from_parent, from_kind, from_executable = \
1253
self._from_file_data(from_trans_id, from_versioned, file_id)
1255
to_name, to_parent, to_kind, to_executable = \
1256
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1258
if not from_versioned:
1261
from_path = self._tree_id_paths.get(from_trans_id)
1262
if not to_versioned:
1265
to_path = final_paths.get_path(to_trans_id)
1266
if from_kind != to_kind:
1268
elif to_kind in ('file', 'symlink') and (
1269
to_trans_id != from_trans_id or
1270
to_trans_id in self._new_contents):
1272
if (not modified and from_versioned == to_versioned and
1273
from_parent==to_parent and from_name == to_name and
1274
from_executable == to_executable):
1276
results.append((file_id, (from_path, to_path), modified,
1277
(from_versioned, to_versioned),
1278
(from_parent, to_parent),
1279
(from_name, to_name),
1280
(from_kind, to_kind),
1281
(from_executable, to_executable)))
1282
return iter(sorted(results, key=lambda x:x[1]))
1285
def joinpath(parent, child):
1286
"""Join tree-relative paths, handling the tree root specially"""
1287
if parent is None or parent == "":
1290
return pathjoin(parent, child)
1293
class FinalPaths(object):
1294
"""Make path calculation cheap by memoizing paths.
1296
The underlying tree must not be manipulated between calls, or else
1297
the results will likely be incorrect.
1299
def __init__(self, transform):
1300
object.__init__(self)
1301
self._known_paths = {}
1302
self.transform = transform
1304
def _determine_path(self, trans_id):
1305
if trans_id == self.transform.root:
1307
name = self.transform.final_name(trans_id)
1308
parent_id = self.transform.final_parent(trans_id)
1309
if parent_id == self.transform.root:
1312
return pathjoin(self.get_path(parent_id), name)
1314
def get_path(self, trans_id):
1315
"""Find the final path associated with a trans_id"""
1316
if trans_id not in self._known_paths:
1317
self._known_paths[trans_id] = self._determine_path(trans_id)
1318
return self._known_paths[trans_id]
1321
def topology_sorted_ids(tree):
1322
"""Determine the topological order of the ids in a tree"""
1323
file_ids = list(tree)
1324
file_ids.sort(key=tree.id2path)
1328
def build_tree(tree, wt, accelerator_tree=None):
1329
"""Create working tree for a branch, using a TreeTransform.
1331
This function should be used on empty trees, having a tree root at most.
1332
(see merge and revert functionality for working with existing trees)
1334
Existing files are handled like so:
1336
- Existing bzrdirs take precedence over creating new items. They are
1337
created as '%s.diverted' % name.
1338
- Otherwise, if the content on disk matches the content we are building,
1339
it is silently replaced.
1340
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1342
:param tree: The tree to convert wt into a copy of
1343
:param wt: The working tree that files will be placed into
1344
:param accelerator_tree: A tree which can be used for retrieving file
1345
contents more quickly than tree itself, i.e. a workingtree. tree
1346
will be used for cases where accelerator_tree's content is different.
1348
wt.lock_tree_write()
1352
if accelerator_tree is not None:
1353
accelerator_tree.lock_read()
1355
return _build_tree(tree, wt, accelerator_tree)
1357
if accelerator_tree is not None:
1358
accelerator_tree.unlock()
1365
def _build_tree(tree, wt, accelerator_tree):
1366
"""See build_tree."""
1367
if len(wt.inventory) > 1: # more than just a root
1368
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1370
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1371
pp = ProgressPhase("Build phase", 2, top_pb)
1372
if tree.inventory.root is not None:
1373
# This is kind of a hack: we should be altering the root
1374
# as part of the regular tree shape diff logic.
1375
# The conditional test here is to avoid doing an
1376
# expensive operation (flush) every time the root id
1377
# is set within the tree, nor setting the root and thus
1378
# marking the tree as dirty, because we use two different
1379
# idioms here: tree interfaces and inventory interfaces.
1380
if wt.get_root_id() != tree.get_root_id():
1381
wt.set_root_id(tree.get_root_id())
1383
tt = TreeTransform(wt)
1387
file_trans_id[wt.get_root_id()] = \
1388
tt.trans_id_tree_file_id(wt.get_root_id())
1389
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1391
deferred_contents = []
1392
for num, (tree_path, entry) in \
1393
enumerate(tree.inventory.iter_entries_by_dir()):
1394
pb.update("Building tree", num - len(deferred_contents),
1395
len(tree.inventory))
1396
if entry.parent_id is None:
1399
file_id = entry.file_id
1400
target_path = wt.abspath(tree_path)
1402
kind = file_kind(target_path)
1406
if kind == "directory":
1408
bzrdir.BzrDir.open(target_path)
1409
except errors.NotBranchError:
1413
if (file_id not in divert and
1414
_content_match(tree, entry, file_id, kind,
1416
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1417
if kind == 'directory':
1419
if entry.parent_id not in file_trans_id:
1420
raise AssertionError(
1421
'entry %s parent id %r is not in file_trans_id %r'
1422
% (entry, entry.parent_id, file_trans_id))
1423
parent_id = file_trans_id[entry.parent_id]
1424
if entry.kind == 'file':
1425
# We *almost* replicate new_by_entry, so that we can defer
1426
# getting the file text, and get them all at once.
1427
trans_id = tt.create_path(entry.name, parent_id)
1428
file_trans_id[file_id] = trans_id
1429
tt.version_file(entry.file_id, trans_id)
1430
executable = tree.is_executable(entry.file_id, tree_path)
1431
if executable is not None:
1432
tt.set_executability(executable, trans_id)
1433
deferred_contents.append((entry.file_id, trans_id))
1435
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1438
new_trans_id = file_trans_id[file_id]
1439
old_parent = tt.trans_id_tree_path(tree_path)
1440
_reparent_children(tt, old_parent, new_trans_id)
1441
for num, (trans_id, bytes) in enumerate(
1442
_iter_files_bytes_accelerated(tree, accelerator_tree,
1443
deferred_contents)):
1444
tt.create_file(bytes, trans_id)
1445
pb.update('Adding file contents',
1446
(num + len(tree.inventory) - len(deferred_contents)),
1447
len(tree.inventory))
1451
divert_trans = set(file_trans_id[f] for f in divert)
1452
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1453
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1454
conflicts = cook_conflicts(raw_conflicts, tt)
1455
for conflict in conflicts:
1458
wt.add_conflicts(conflicts)
1459
except errors.UnsupportedOperation:
1461
result = tt.apply(no_conflicts=True)
1468
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
1469
if accelerator_tree is None:
1470
new_desired_files = desired_files
1472
iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
1473
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1475
new_desired_files = []
1476
for file_id, identifier in desired_files:
1477
accelerator_path = unchanged.get(file_id)
1478
if accelerator_path is None:
1479
new_desired_files.append((file_id, identifier))
1481
contents = accelerator_tree.get_file(file_id, accelerator_path)
1484
contents_bytes = (contents.read(),)
1487
yield identifier, contents_bytes
1488
for result in tree.iter_files_bytes(new_desired_files):
1492
def _reparent_children(tt, old_parent, new_parent):
1493
for child in tt.iter_tree_children(old_parent):
1494
tt.adjust_path(tt.final_name(child), new_parent, child)
1496
def _reparent_transform_children(tt, old_parent, new_parent):
1497
by_parent = tt.by_parent()
1498
for child in by_parent[old_parent]:
1499
tt.adjust_path(tt.final_name(child), new_parent, child)
1501
def _content_match(tree, entry, file_id, kind, target_path):
1502
if entry.kind != kind:
1504
if entry.kind == "directory":
1506
if entry.kind == "file":
1507
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1509
elif entry.kind == "symlink":
1510
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1515
def resolve_checkout(tt, conflicts, divert):
1516
new_conflicts = set()
1517
for c_type, conflict in ((c[0], c) for c in conflicts):
1518
# Anything but a 'duplicate' would indicate programmer error
1519
assert c_type == 'duplicate', c_type
1520
# Now figure out which is new and which is old
1521
if tt.new_contents(conflict[1]):
1522
new_file = conflict[1]
1523
old_file = conflict[2]
1525
new_file = conflict[2]
1526
old_file = conflict[1]
1528
# We should only get here if the conflict wasn't completely
1530
final_parent = tt.final_parent(old_file)
1531
if new_file in divert:
1532
new_name = tt.final_name(old_file)+'.diverted'
1533
tt.adjust_path(new_name, final_parent, new_file)
1534
new_conflicts.add((c_type, 'Diverted to',
1535
new_file, old_file))
1537
new_name = tt.final_name(old_file)+'.moved'
1538
tt.adjust_path(new_name, final_parent, old_file)
1539
new_conflicts.add((c_type, 'Moved existing file to',
1540
old_file, new_file))
1541
return new_conflicts
1544
def new_by_entry(tt, entry, parent_id, tree):
1545
"""Create a new file according to its inventory entry"""
1549
contents = tree.get_file(entry.file_id).readlines()
1550
executable = tree.is_executable(entry.file_id)
1551
return tt.new_file(name, parent_id, contents, entry.file_id,
1553
elif kind in ('directory', 'tree-reference'):
1554
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1555
if kind == 'tree-reference':
1556
tt.set_tree_reference(entry.reference_revision, trans_id)
1558
elif kind == 'symlink':
1559
target = tree.get_symlink_target(entry.file_id)
1560
return tt.new_symlink(name, parent_id, target, entry.file_id)
1562
raise errors.BadFileKindError(name, kind)
1565
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1566
"""Create new file contents according to an inventory entry."""
1567
if entry.kind == "file":
1569
lines = tree.get_file(entry.file_id).readlines()
1570
tt.create_file(lines, trans_id, mode_id=mode_id)
1571
elif entry.kind == "symlink":
1572
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1573
elif entry.kind == "directory":
1574
tt.create_directory(trans_id)
1577
def create_entry_executability(tt, entry, trans_id):
1578
"""Set the executability of a trans_id according to an inventory entry"""
1579
if entry.kind == "file":
1580
tt.set_executability(entry.executable, trans_id)
1583
@deprecated_function(zero_fifteen)
1584
def find_interesting(working_tree, target_tree, filenames):
1585
"""Find the ids corresponding to specified filenames.
1587
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1589
working_tree.lock_read()
1591
target_tree.lock_read()
1593
return working_tree.paths2ids(filenames, [target_tree])
1595
target_tree.unlock()
1597
working_tree.unlock()
1600
@deprecated_function(zero_ninety)
1601
def change_entry(tt, file_id, working_tree, target_tree,
1602
trans_id_file_id, backups, trans_id, by_parent):
1603
"""Replace a file_id's contents with those from a target tree."""
1604
if file_id is None and target_tree is None:
1605
# skip the logic altogether in the deprecation test
1607
e_trans_id = trans_id_file_id(file_id)
1608
entry = target_tree.inventory[file_id]
1609
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1612
mode_id = e_trans_id
1615
tt.delete_contents(e_trans_id)
1617
parent_trans_id = trans_id_file_id(entry.parent_id)
1618
backup_name = get_backup_name(entry, by_parent,
1619
parent_trans_id, tt)
1620
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1621
tt.unversion_file(e_trans_id)
1622
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1623
tt.version_file(file_id, e_trans_id)
1624
trans_id[file_id] = e_trans_id
1625
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1626
create_entry_executability(tt, entry, e_trans_id)
1629
tt.set_executability(entry.executable, e_trans_id)
1630
if tt.final_name(e_trans_id) != entry.name:
1633
parent_id = tt.final_parent(e_trans_id)
1634
parent_file_id = tt.final_file_id(parent_id)
1635
if parent_file_id != entry.parent_id:
1640
parent_trans_id = trans_id_file_id(entry.parent_id)
1641
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1644
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1645
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1648
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1649
"""Produce a backup-style name that appears to be available"""
1653
yield "%s.~%d~" % (name, counter)
1655
for new_name in name_gen():
1656
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1660
def _entry_changes(file_id, entry, working_tree):
1661
"""Determine in which ways the inventory entry has changed.
1663
Returns booleans: has_contents, content_mod, meta_mod
1664
has_contents means there are currently contents, but they differ
1665
contents_mod means contents need to be modified
1666
meta_mod means the metadata needs to be modified
1668
cur_entry = working_tree.inventory[file_id]
1670
working_kind = working_tree.kind(file_id)
1673
has_contents = False
1676
if has_contents is True:
1677
if entry.kind != working_kind:
1678
contents_mod, meta_mod = True, False
1680
cur_entry._read_tree_state(working_tree.id2path(file_id),
1682
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1683
cur_entry._forget_tree_state()
1684
return has_contents, contents_mod, meta_mod
1687
def revert(working_tree, target_tree, filenames, backups=False,
1688
pb=DummyProgress(), change_reporter=None):
1689
"""Revert a working tree's contents to those of a target tree."""
1690
target_tree.lock_read()
1691
tt = TreeTransform(working_tree, pb)
1693
pp = ProgressPhase("Revert phase", 3, pb)
1695
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1697
merge_modified = _alter_files(working_tree, target_tree, tt,
1698
child_pb, filenames, backups)
1702
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1704
raw_conflicts = resolve_conflicts(tt, child_pb,
1705
lambda t, c: conflict_pass(t, c, target_tree))
1708
conflicts = cook_conflicts(raw_conflicts, tt)
1710
change_reporter = delta._ChangeReporter(
1711
unversioned_filter=working_tree.is_ignored)
1712
delta.report_changes(tt._iter_changes(), change_reporter)
1713
for conflict in conflicts:
1717
working_tree.set_merge_modified(merge_modified)
1719
target_tree.unlock()
1725
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1727
merge_modified = working_tree.merge_modified()
1728
change_list = target_tree._iter_changes(working_tree,
1729
specific_files=specific_files, pb=pb)
1730
if target_tree.inventory.root is None:
1737
for id_num, (file_id, path, changed_content, versioned, parent, name,
1738
kind, executable) in enumerate(change_list):
1739
if skip_root and file_id[0] is not None and parent[0] is None:
1741
trans_id = tt.trans_id_file_id(file_id)
1744
keep_content = False
1745
if kind[0] == 'file' and (backups or kind[1] is None):
1746
wt_sha1 = working_tree.get_file_sha1(file_id)
1747
if merge_modified.get(file_id) != wt_sha1:
1748
# acquire the basis tree lazily to prevent the
1749
# expense of accessing it when it's not needed ?
1750
# (Guessing, RBC, 200702)
1751
if basis_tree is None:
1752
basis_tree = working_tree.basis_tree()
1753
basis_tree.lock_read()
1754
if file_id in basis_tree:
1755
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1757
elif kind[1] is None and not versioned[1]:
1759
if kind[0] is not None:
1760
if not keep_content:
1761
tt.delete_contents(trans_id)
1762
elif kind[1] is not None:
1763
parent_trans_id = tt.trans_id_file_id(parent[0])
1764
by_parent = tt.by_parent()
1765
backup_name = _get_backup_name(name[0], by_parent,
1766
parent_trans_id, tt)
1767
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1768
new_trans_id = tt.create_path(name[0], parent_trans_id)
1769
if versioned == (True, True):
1770
tt.unversion_file(trans_id)
1771
tt.version_file(file_id, new_trans_id)
1772
# New contents should have the same unix perms as old
1775
trans_id = new_trans_id
1776
if kind[1] == 'directory':
1777
tt.create_directory(trans_id)
1778
elif kind[1] == 'symlink':
1779
tt.create_symlink(target_tree.get_symlink_target(file_id),
1781
elif kind[1] == 'file':
1782
deferred_files.append((file_id, (trans_id, mode_id)))
1783
if basis_tree is None:
1784
basis_tree = working_tree.basis_tree()
1785
basis_tree.lock_read()
1786
new_sha1 = target_tree.get_file_sha1(file_id)
1787
if (file_id in basis_tree and new_sha1 ==
1788
basis_tree.get_file_sha1(file_id)):
1789
if file_id in merge_modified:
1790
del merge_modified[file_id]
1792
merge_modified[file_id] = new_sha1
1794
# preserve the execute bit when backing up
1795
if keep_content and executable[0] == executable[1]:
1796
tt.set_executability(executable[1], trans_id)
1798
assert kind[1] is None
1799
if versioned == (False, True):
1800
tt.version_file(file_id, trans_id)
1801
if versioned == (True, False):
1802
tt.unversion_file(trans_id)
1803
if (name[1] is not None and
1804
(name[0] != name[1] or parent[0] != parent[1])):
1806
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1807
if executable[0] != executable[1] and kind[1] == "file":
1808
tt.set_executability(executable[1], trans_id)
1809
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1811
tt.create_file(bytes, trans_id, mode_id)
1813
if basis_tree is not None:
1815
return merge_modified
1818
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1819
"""Make many conflict-resolution attempts, but die if they fail"""
1820
if pass_func is None:
1821
pass_func = conflict_pass
1822
new_conflicts = set()
1825
pb.update('Resolution pass', n+1, 10)
1826
conflicts = tt.find_conflicts()
1827
if len(conflicts) == 0:
1828
return new_conflicts
1829
new_conflicts.update(pass_func(tt, conflicts))
1830
raise MalformedTransform(conflicts=conflicts)
1835
def conflict_pass(tt, conflicts, path_tree=None):
1836
"""Resolve some classes of conflicts.
1838
:param tt: The transform to resolve conflicts in
1839
:param conflicts: The conflicts to resolve
1840
:param path_tree: A Tree to get supplemental paths from
1842
new_conflicts = set()
1843
for c_type, conflict in ((c[0], c) for c in conflicts):
1844
if c_type == 'duplicate id':
1845
tt.unversion_file(conflict[1])
1846
new_conflicts.add((c_type, 'Unversioned existing file',
1847
conflict[1], conflict[2], ))
1848
elif c_type == 'duplicate':
1849
# files that were renamed take precedence
1850
final_parent = tt.final_parent(conflict[1])
1851
if tt.path_changed(conflict[1]):
1852
existing_file, new_file = conflict[2], conflict[1]
1854
existing_file, new_file = conflict[1], conflict[2]
1855
new_name = tt.final_name(existing_file)+'.moved'
1856
tt.adjust_path(new_name, final_parent, existing_file)
1857
new_conflicts.add((c_type, 'Moved existing file to',
1858
existing_file, new_file))
1859
elif c_type == 'parent loop':
1860
# break the loop by undoing one of the ops that caused the loop
1862
while not tt.path_changed(cur):
1863
cur = tt.final_parent(cur)
1864
new_conflicts.add((c_type, 'Cancelled move', cur,
1865
tt.final_parent(cur),))
1866
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1868
elif c_type == 'missing parent':
1869
trans_id = conflict[1]
1871
tt.cancel_deletion(trans_id)
1872
new_conflicts.add(('deleting parent', 'Not deleting',
1875
tt.create_directory(trans_id)
1876
new_conflicts.add((c_type, 'Created directory', trans_id))
1878
tt.final_name(trans_id)
1880
if path_tree is not None:
1881
file_id = tt.final_file_id(trans_id)
1882
entry = path_tree.inventory[file_id]
1883
parent_trans_id = tt.trans_id_file_id(entry.parent_id)
1884
tt.adjust_path(entry.name, parent_trans_id, trans_id)
1885
elif c_type == 'unversioned parent':
1886
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1887
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
1888
elif c_type == 'non-directory parent':
1889
parent_id = conflict[1]
1890
parent_parent = tt.final_parent(parent_id)
1891
parent_name = tt.final_name(parent_id)
1892
parent_file_id = tt.final_file_id(parent_id)
1893
new_parent_id = tt.new_directory(parent_name + '.new',
1894
parent_parent, parent_file_id)
1895
_reparent_transform_children(tt, parent_id, new_parent_id)
1896
tt.unversion_file(parent_id)
1897
new_conflicts.add((c_type, 'Created directory', new_parent_id))
1898
return new_conflicts
1901
def cook_conflicts(raw_conflicts, tt):
1902
"""Generate a list of cooked conflicts, sorted by file path"""
1903
from bzrlib.conflicts import Conflict
1904
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1905
return sorted(conflict_iter, key=Conflict.sort_key)
1908
def iter_cook_conflicts(raw_conflicts, tt):
1909
from bzrlib.conflicts import Conflict
1911
for conflict in raw_conflicts:
1912
c_type = conflict[0]
1913
action = conflict[1]
1914
modified_path = fp.get_path(conflict[2])
1915
modified_id = tt.final_file_id(conflict[2])
1916
if len(conflict) == 3:
1917
yield Conflict.factory(c_type, action=action, path=modified_path,
1918
file_id=modified_id)
1921
conflicting_path = fp.get_path(conflict[3])
1922
conflicting_id = tt.final_file_id(conflict[3])
1923
yield Conflict.factory(c_type, action=action, path=modified_path,
1924
file_id=modified_id,
1925
conflict_path=conflicting_path,
1926
conflict_file_id=conflicting_id)
1929
class _FileMover(object):
1930
"""Moves and deletes files for TreeTransform, tracking operations"""
1933
self.past_renames = []
1934
self.pending_deletions = []
1936
def rename(self, from_, to):
1937
"""Rename a file from one path to another. Functions like os.rename"""
1939
os.rename(from_, to)
1941
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
1942
raise errors.FileExists(to, str(e))
1944
self.past_renames.append((from_, to))
1946
def pre_delete(self, from_, to):
1947
"""Rename a file out of the way and mark it for deletion.
1949
Unlike os.unlink, this works equally well for files and directories.
1950
:param from_: The current file path
1951
:param to: A temporary path for the file
1953
self.rename(from_, to)
1954
self.pending_deletions.append(to)
1957
"""Reverse all renames that have been performed"""
1958
for from_, to in reversed(self.past_renames):
1959
os.rename(to, from_)
1960
# after rollback, don't reuse _FileMover
1962
pending_deletions = None
1964
def apply_deletions(self):
1965
"""Apply all marked deletions"""
1966
for path in self.pending_deletions:
1968
# after apply_deletions, don't reuse _FileMover
1970
pending_deletions = None
added
removed
bzrlib/transform.py
