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, S_IEXEC
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
30
revision as _mod_revision,
33
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
34
ReusingTransform, NotVersionedError, CantMoveRoot,
35
ExistingLimbo, ImmortalLimbo, NoFinalPath,
37
from bzrlib.inventory import InventoryEntry
38
from bzrlib.osutils import (
47
from bzrlib.progress import DummyProgress, ProgressPhase
48
from bzrlib.symbol_versioning import (
51
from bzrlib.trace import mutter, warning
52
from bzrlib import tree
54
import bzrlib.urlutils as urlutils
57
ROOT_PARENT = "root-parent"
60
def unique_add(map, key, value):
62
raise DuplicateKey(key=key)
66
class _TransformResults(object):
67
def __init__(self, modified_paths, rename_count):
69
self.modified_paths = modified_paths
70
self.rename_count = rename_count
73
class TreeTransformBase(object):
74
"""The base class for TreeTransform and TreeTransformBase"""
76
def __init__(self, tree, limbodir, pb=DummyProgress(),
80
:param tree: The tree that will be transformed, but not necessarily
82
:param limbodir: A directory where new files can be stored until
83
they are installed in their proper places
84
:param pb: A ProgressBar indicating how much progress is being made
85
:param case_sensitive: If True, the target of the transform is
86
case sensitive, not just case preserving.
90
self._limbodir = limbodir
91
self._deletiondir = None
93
# mapping of trans_id -> new basename
95
# mapping of trans_id -> new parent trans_id
97
# mapping of trans_id with new contents -> new file_kind
98
self._new_contents = {}
99
# A mapping of transform ids to their limbo filename
100
self._limbo_files = {}
101
# A mapping of transform ids to a set of the transform ids of children
102
# that their limbo directory has
103
self._limbo_children = {}
104
# Map transform ids to maps of child filename to child transform id
105
self._limbo_children_names = {}
106
# List of transform ids that need to be renamed from limbo into place
107
self._needs_rename = set()
108
# Set of trans_ids whose contents will be removed
109
self._removed_contents = set()
110
# Mapping of trans_id -> new execute-bit value
111
self._new_executability = {}
112
# Mapping of trans_id -> new tree-reference value
113
self._new_reference_revision = {}
114
# Mapping of trans_id -> new file_id
116
# Mapping of old file-id -> trans_id
117
self._non_present_ids = {}
118
# Mapping of new file_id -> trans_id
120
# Set of file_ids that will be removed
121
self._removed_id = set()
122
# Mapping of path in old tree -> trans_id
123
self._tree_path_ids = {}
124
# Mapping trans_id -> path in old tree
125
self._tree_id_paths = {}
126
# Cache of realpath results, to speed up canonical_path
128
# Cache of relpath results, to speed up canonical_path
130
# The trans_id that will be used as the tree root
131
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
132
# Indictor of whether the transform has been applied
136
# Whether the target is case sensitive
137
self._case_sensitive_target = case_sensitive
138
# A counter of how many files have been renamed
139
self.rename_count = 0
141
def __get_root(self):
142
return self._new_root
144
root = property(__get_root)
147
"""Release the working tree lock, if held, clean up limbo dir.
149
This is required if apply has not been invoked, but can be invoked
152
if self._tree is None:
155
entries = [(self._limbo_name(t), t, k) for t, k in
156
self._new_contents.iteritems()]
157
entries.sort(reverse=True)
158
for path, trans_id, kind in entries:
159
if kind == "directory":
164
os.rmdir(self._limbodir)
166
# We don't especially care *why* the dir is immortal.
167
raise ImmortalLimbo(self._limbodir)
169
if self._deletiondir is not None:
170
os.rmdir(self._deletiondir)
172
raise errors.ImmortalPendingDeletion(self._deletiondir)
177
def _assign_id(self):
178
"""Produce a new tranform id"""
179
new_id = "new-%s" % self._id_number
183
def create_path(self, name, parent):
184
"""Assign a transaction id to a new path"""
185
trans_id = self._assign_id()
186
unique_add(self._new_name, trans_id, name)
187
unique_add(self._new_parent, trans_id, parent)
190
def adjust_path(self, name, parent, trans_id):
191
"""Change the path that is assigned to a transaction id."""
192
if trans_id == self._new_root:
194
previous_parent = self._new_parent.get(trans_id)
195
previous_name = self._new_name.get(trans_id)
196
self._new_name[trans_id] = name
197
self._new_parent[trans_id] = parent
198
if (trans_id in self._limbo_files and
199
trans_id not in self._needs_rename):
200
self._rename_in_limbo([trans_id])
201
self._limbo_children[previous_parent].remove(trans_id)
202
del self._limbo_children_names[previous_parent][previous_name]
204
def _rename_in_limbo(self, trans_ids):
205
"""Fix limbo names so that the right final path is produced.
207
This means we outsmarted ourselves-- we tried to avoid renaming
208
these files later by creating them with their final names in their
209
final parents. But now the previous name or parent is no longer
210
suitable, so we have to rename them.
212
Even for trans_ids that have no new contents, we must remove their
213
entries from _limbo_files, because they are now stale.
215
for trans_id in trans_ids:
216
old_path = self._limbo_files.pop(trans_id)
217
if trans_id not in self._new_contents:
219
new_path = self._limbo_name(trans_id)
220
os.rename(old_path, new_path)
222
def adjust_root_path(self, name, parent):
223
"""Emulate moving the root by moving all children, instead.
225
We do this by undoing the association of root's transaction id with the
226
current tree. This allows us to create a new directory with that
227
transaction id. We unversion the root directory and version the
228
physically new directory, and hope someone versions the tree root
231
old_root = self._new_root
232
old_root_file_id = self.final_file_id(old_root)
233
# force moving all children of root
234
for child_id in self.iter_tree_children(old_root):
235
if child_id != parent:
236
self.adjust_path(self.final_name(child_id),
237
self.final_parent(child_id), child_id)
238
file_id = self.final_file_id(child_id)
239
if file_id is not None:
240
self.unversion_file(child_id)
241
self.version_file(file_id, child_id)
243
# the physical root needs a new transaction id
244
self._tree_path_ids.pop("")
245
self._tree_id_paths.pop(old_root)
246
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
247
if parent == old_root:
248
parent = self._new_root
249
self.adjust_path(name, parent, old_root)
250
self.create_directory(old_root)
251
self.version_file(old_root_file_id, old_root)
252
self.unversion_file(self._new_root)
254
def trans_id_tree_file_id(self, inventory_id):
255
"""Determine the transaction id of a working tree file.
257
This reflects only files that already exist, not ones that will be
258
added by transactions.
260
path = self._tree.id2path(inventory_id)
261
return self.trans_id_tree_path(path)
263
def trans_id_file_id(self, file_id):
264
"""Determine or set the transaction id associated with a file ID.
265
A new id is only created for file_ids that were never present. If
266
a transaction has been unversioned, it is deliberately still returned.
267
(this will likely lead to an unversioned parent conflict.)
269
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
270
return self._r_new_id[file_id]
271
elif file_id in self._tree.inventory:
272
return self.trans_id_tree_file_id(file_id)
273
elif file_id in self._non_present_ids:
274
return self._non_present_ids[file_id]
276
trans_id = self._assign_id()
277
self._non_present_ids[file_id] = trans_id
280
def canonical_path(self, path):
281
"""Get the canonical tree-relative path"""
282
# don't follow final symlinks
283
abs = self._tree.abspath(path)
284
if abs in self._relpaths:
285
return self._relpaths[abs]
286
dirname, basename = os.path.split(abs)
287
if dirname not in self._realpaths:
288
self._realpaths[dirname] = os.path.realpath(dirname)
289
dirname = self._realpaths[dirname]
290
abs = pathjoin(dirname, basename)
291
if dirname in self._relpaths:
292
relpath = pathjoin(self._relpaths[dirname], basename)
293
relpath = relpath.rstrip('/\\')
295
relpath = self._tree.relpath(abs)
296
self._relpaths[abs] = relpath
299
def trans_id_tree_path(self, path):
300
"""Determine (and maybe set) the transaction ID for a tree path."""
301
path = self.canonical_path(path)
302
if path not in self._tree_path_ids:
303
self._tree_path_ids[path] = self._assign_id()
304
self._tree_id_paths[self._tree_path_ids[path]] = path
305
return self._tree_path_ids[path]
307
def get_tree_parent(self, trans_id):
308
"""Determine id of the parent in the tree."""
309
path = self._tree_id_paths[trans_id]
312
return self.trans_id_tree_path(os.path.dirname(path))
314
def create_file(self, contents, trans_id, mode_id=None):
315
"""Schedule creation of a new file.
319
Contents is an iterator of strings, all of which will be written
320
to the target destination.
322
New file takes the permissions of any existing file with that id,
323
unless mode_id is specified.
325
name = self._limbo_name(trans_id)
329
unique_add(self._new_contents, trans_id, 'file')
331
# Clean up the file, it never got registered so
332
# TreeTransform.finalize() won't clean it up.
337
f.writelines(contents)
340
self._set_mode(trans_id, mode_id, S_ISREG)
342
def _set_mode(self, trans_id, mode_id, typefunc):
343
"""Set the mode of new file contents.
344
The mode_id is the existing file to get the mode from (often the same
345
as trans_id). The operation is only performed if there's a mode match
346
according to typefunc.
351
old_path = self._tree_id_paths[mode_id]
355
mode = os.stat(self._tree.abspath(old_path)).st_mode
357
if e.errno in (errno.ENOENT, errno.ENOTDIR):
358
# Either old_path doesn't exist, or the parent of the
359
# target is not a directory (but will be one eventually)
360
# Either way, we know it doesn't exist *right now*
361
# See also bug #248448
366
os.chmod(self._limbo_name(trans_id), mode)
368
def create_hardlink(self, path, trans_id):
369
"""Schedule creation of a hard link"""
370
name = self._limbo_name(trans_id)
374
if e.errno != errno.EPERM:
376
raise errors.HardLinkNotSupported(path)
378
unique_add(self._new_contents, trans_id, 'file')
380
# Clean up the file, it never got registered so
381
# TreeTransform.finalize() won't clean it up.
385
def create_directory(self, trans_id):
386
"""Schedule creation of a new directory.
388
See also new_directory.
390
os.mkdir(self._limbo_name(trans_id))
391
unique_add(self._new_contents, trans_id, 'directory')
393
def create_symlink(self, target, trans_id):
394
"""Schedule creation of a new symbolic link.
396
target is a bytestring.
397
See also new_symlink.
400
os.symlink(target, self._limbo_name(trans_id))
401
unique_add(self._new_contents, trans_id, 'symlink')
404
path = FinalPaths(self).get_path(trans_id)
407
raise UnableCreateSymlink(path=path)
409
def cancel_creation(self, trans_id):
410
"""Cancel the creation of new file contents."""
411
del self._new_contents[trans_id]
412
children = self._limbo_children.get(trans_id)
413
# if this is a limbo directory with children, move them before removing
415
if children is not None:
416
self._rename_in_limbo(children)
417
del self._limbo_children[trans_id]
418
del self._limbo_children_names[trans_id]
419
delete_any(self._limbo_name(trans_id))
421
def delete_contents(self, trans_id):
422
"""Schedule the contents of a path entry for deletion"""
423
self.tree_kind(trans_id)
424
self._removed_contents.add(trans_id)
426
def cancel_deletion(self, trans_id):
427
"""Cancel a scheduled deletion"""
428
self._removed_contents.remove(trans_id)
430
def unversion_file(self, trans_id):
431
"""Schedule a path entry to become unversioned"""
432
self._removed_id.add(trans_id)
434
def delete_versioned(self, trans_id):
435
"""Delete and unversion a versioned file"""
436
self.delete_contents(trans_id)
437
self.unversion_file(trans_id)
439
def set_executability(self, executability, trans_id):
440
"""Schedule setting of the 'execute' bit
441
To unschedule, set to None
443
if executability is None:
444
del self._new_executability[trans_id]
446
unique_add(self._new_executability, trans_id, executability)
448
def set_tree_reference(self, revision_id, trans_id):
449
"""Set the reference associated with a directory"""
450
unique_add(self._new_reference_revision, trans_id, revision_id)
452
def version_file(self, file_id, trans_id):
453
"""Schedule a file to become versioned."""
456
unique_add(self._new_id, trans_id, file_id)
457
unique_add(self._r_new_id, file_id, trans_id)
459
def cancel_versioning(self, trans_id):
460
"""Undo a previous versioning of a file"""
461
file_id = self._new_id[trans_id]
462
del self._new_id[trans_id]
463
del self._r_new_id[file_id]
465
def new_paths(self, filesystem_only=False):
466
"""Determine the paths of all new and changed files.
468
:param filesystem_only: if True, only calculate values for files
469
that require renames or execute bit changes.
473
id_sets = (self._needs_rename, self._new_executability)
475
id_sets = (self._new_name, self._new_parent, self._new_contents,
476
self._new_id, self._new_executability)
477
for id_set in id_sets:
478
new_ids.update(id_set)
479
return sorted(FinalPaths(self).get_paths(new_ids))
481
def tree_kind(self, trans_id):
482
"""Determine the file kind in the working tree.
484
Raises NoSuchFile if the file does not exist
486
path = self._tree_id_paths.get(trans_id)
488
raise NoSuchFile(None)
490
return file_kind(self._tree.abspath(path))
492
if e.errno != errno.ENOENT:
495
raise NoSuchFile(path)
497
def final_kind(self, trans_id):
498
"""Determine the final file kind, after any changes applied.
500
Raises NoSuchFile if the file does not exist/has no contents.
501
(It is conceivable that a path would be created without the
502
corresponding contents insertion command)
504
if trans_id in self._new_contents:
505
return self._new_contents[trans_id]
506
elif trans_id in self._removed_contents:
507
raise NoSuchFile(None)
509
return self.tree_kind(trans_id)
511
def tree_file_id(self, trans_id):
512
"""Determine the file id associated with the trans_id in the tree"""
514
path = self._tree_id_paths[trans_id]
516
# the file is a new, unversioned file, or invalid trans_id
518
# the file is old; the old id is still valid
519
if self._new_root == trans_id:
520
return self._tree.get_root_id()
521
return self._tree.inventory.path2id(path)
523
def final_file_id(self, trans_id):
524
"""Determine the file id after any changes are applied, or None.
526
None indicates that the file will not be versioned after changes are
530
return self._new_id[trans_id]
532
if trans_id in self._removed_id:
534
return self.tree_file_id(trans_id)
536
def inactive_file_id(self, trans_id):
537
"""Return the inactive file_id associated with a transaction id.
538
That is, the one in the tree or in non_present_ids.
539
The file_id may actually be active, too.
541
file_id = self.tree_file_id(trans_id)
542
if file_id is not None:
544
for key, value in self._non_present_ids.iteritems():
545
if value == trans_id:
548
def final_parent(self, trans_id):
549
"""Determine the parent file_id, after any changes are applied.
551
ROOT_PARENT is returned for the tree root.
554
return self._new_parent[trans_id]
556
return self.get_tree_parent(trans_id)
558
def final_name(self, trans_id):
559
"""Determine the final filename, after all changes are applied."""
561
return self._new_name[trans_id]
564
return os.path.basename(self._tree_id_paths[trans_id])
566
raise NoFinalPath(trans_id, self)
569
"""Return a map of parent: children for known parents.
571
Only new paths and parents of tree files with assigned ids are used.
574
items = list(self._new_parent.iteritems())
575
items.extend((t, self.final_parent(t)) for t in
576
self._tree_id_paths.keys())
577
for trans_id, parent_id in items:
578
if parent_id not in by_parent:
579
by_parent[parent_id] = set()
580
by_parent[parent_id].add(trans_id)
583
def path_changed(self, trans_id):
584
"""Return True if a trans_id's path has changed."""
585
return (trans_id in self._new_name) or (trans_id in self._new_parent)
587
def new_contents(self, trans_id):
588
return (trans_id in self._new_contents)
590
def find_conflicts(self):
591
"""Find any violations of inventory or filesystem invariants"""
592
if self._done is True:
593
raise ReusingTransform()
595
# ensure all children of all existent parents are known
596
# all children of non-existent parents are known, by definition.
597
self._add_tree_children()
598
by_parent = self.by_parent()
599
conflicts.extend(self._unversioned_parents(by_parent))
600
conflicts.extend(self._parent_loops())
601
conflicts.extend(self._duplicate_entries(by_parent))
602
conflicts.extend(self._duplicate_ids())
603
conflicts.extend(self._parent_type_conflicts(by_parent))
604
conflicts.extend(self._improper_versioning())
605
conflicts.extend(self._executability_conflicts())
606
conflicts.extend(self._overwrite_conflicts())
609
def _add_tree_children(self):
610
"""Add all the children of all active parents to the known paths.
612
Active parents are those which gain children, and those which are
613
removed. This is a necessary first step in detecting conflicts.
615
parents = self.by_parent().keys()
616
parents.extend([t for t in self._removed_contents if
617
self.tree_kind(t) == 'directory'])
618
for trans_id in self._removed_id:
619
file_id = self.tree_file_id(trans_id)
620
if file_id is not None:
621
if self._tree.inventory[file_id].kind == 'directory':
622
parents.append(trans_id)
623
elif self.tree_kind(trans_id) == 'directory':
624
parents.append(trans_id)
626
for parent_id in parents:
627
# ensure that all children are registered with the transaction
628
list(self.iter_tree_children(parent_id))
630
def iter_tree_children(self, parent_id):
631
"""Iterate through the entry's tree children, if any"""
633
path = self._tree_id_paths[parent_id]
637
children = os.listdir(self._tree.abspath(path))
639
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
643
for child in children:
644
childpath = joinpath(path, child)
645
if self._tree.is_control_filename(childpath):
647
yield self.trans_id_tree_path(childpath)
649
def has_named_child(self, by_parent, parent_id, name):
651
children = by_parent[parent_id]
654
for child in children:
655
if self.final_name(child) == name:
658
path = self._tree_id_paths[parent_id]
661
childpath = joinpath(path, name)
662
child_id = self._tree_path_ids.get(childpath)
664
return lexists(self._tree.abspath(childpath))
666
if self.final_parent(child_id) != parent_id:
668
if child_id in self._removed_contents:
669
# XXX What about dangling file-ids?
674
def _parent_loops(self):
675
"""No entry should be its own ancestor"""
677
for trans_id in self._new_parent:
680
while parent_id is not ROOT_PARENT:
683
parent_id = self.final_parent(parent_id)
686
if parent_id == trans_id:
687
conflicts.append(('parent loop', trans_id))
688
if parent_id in seen:
692
def _unversioned_parents(self, by_parent):
693
"""If parent directories are versioned, children must be versioned."""
695
for parent_id, children in by_parent.iteritems():
696
if parent_id is ROOT_PARENT:
698
if self.final_file_id(parent_id) is not None:
700
for child_id in children:
701
if self.final_file_id(child_id) is not None:
702
conflicts.append(('unversioned parent', parent_id))
706
def _improper_versioning(self):
707
"""Cannot version a file with no contents, or a bad type.
709
However, existing entries with no contents are okay.
712
for trans_id in self._new_id.iterkeys():
714
kind = self.final_kind(trans_id)
716
conflicts.append(('versioning no contents', trans_id))
718
if not InventoryEntry.versionable_kind(kind):
719
conflicts.append(('versioning bad kind', trans_id, kind))
722
def _executability_conflicts(self):
723
"""Check for bad executability changes.
725
Only versioned files may have their executability set, because
726
1. only versioned entries can have executability under windows
727
2. only files can be executable. (The execute bit on a directory
728
does not indicate searchability)
731
for trans_id in self._new_executability:
732
if self.final_file_id(trans_id) is None:
733
conflicts.append(('unversioned executability', trans_id))
736
non_file = self.final_kind(trans_id) != "file"
740
conflicts.append(('non-file executability', trans_id))
743
def _overwrite_conflicts(self):
744
"""Check for overwrites (not permitted on Win32)"""
746
for trans_id in self._new_contents:
748
self.tree_kind(trans_id)
751
if trans_id not in self._removed_contents:
752
conflicts.append(('overwrite', trans_id,
753
self.final_name(trans_id)))
756
def _duplicate_entries(self, by_parent):
757
"""No directory may have two entries with the same name."""
759
if (self._new_name, self._new_parent) == ({}, {}):
761
for children in by_parent.itervalues():
762
name_ids = [(self.final_name(t), t) for t in children]
763
if not self._case_sensitive_target:
764
name_ids = [(n.lower(), t) for n, t in name_ids]
768
for name, trans_id in name_ids:
770
kind = self.final_kind(trans_id)
773
file_id = self.final_file_id(trans_id)
774
if kind is None and file_id is None:
776
if name == last_name:
777
conflicts.append(('duplicate', last_trans_id, trans_id,
780
last_trans_id = trans_id
783
def _duplicate_ids(self):
784
"""Each inventory id may only be used once"""
786
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
788
all_ids = self._tree.all_file_ids()
789
active_tree_ids = all_ids.difference(removed_tree_ids)
790
for trans_id, file_id in self._new_id.iteritems():
791
if file_id in active_tree_ids:
792
old_trans_id = self.trans_id_tree_file_id(file_id)
793
conflicts.append(('duplicate id', old_trans_id, trans_id))
796
def _parent_type_conflicts(self, by_parent):
797
"""parents must have directory 'contents'."""
799
for parent_id, children in by_parent.iteritems():
800
if parent_id is ROOT_PARENT:
802
if not self._any_contents(children):
804
for child in children:
806
self.final_kind(child)
810
kind = self.final_kind(parent_id)
814
conflicts.append(('missing parent', parent_id))
815
elif kind != "directory":
816
conflicts.append(('non-directory parent', parent_id))
819
def _any_contents(self, trans_ids):
820
"""Return true if any of the trans_ids, will have contents."""
821
for trans_id in trans_ids:
823
kind = self.final_kind(trans_id)
829
def _limbo_name(self, trans_id):
830
"""Generate the limbo name of a file"""
831
limbo_name = self._limbo_files.get(trans_id)
832
if limbo_name is not None:
834
parent = self._new_parent.get(trans_id)
835
# if the parent directory is already in limbo (e.g. when building a
836
# tree), choose a limbo name inside the parent, to reduce further
838
use_direct_path = False
839
if self._new_contents.get(parent) == 'directory':
840
filename = self._new_name.get(trans_id)
841
if filename is not None:
842
if parent not in self._limbo_children:
843
self._limbo_children[parent] = set()
844
self._limbo_children_names[parent] = {}
845
use_direct_path = True
846
# the direct path can only be used if no other file has
847
# already taken this pathname, i.e. if the name is unused, or
848
# if it is already associated with this trans_id.
849
elif self._case_sensitive_target:
850
if (self._limbo_children_names[parent].get(filename)
851
in (trans_id, None)):
852
use_direct_path = True
854
for l_filename, l_trans_id in\
855
self._limbo_children_names[parent].iteritems():
856
if l_trans_id == trans_id:
858
if l_filename.lower() == filename.lower():
861
use_direct_path = True
864
limbo_name = pathjoin(self._limbo_files[parent], filename)
865
self._limbo_children[parent].add(trans_id)
866
self._limbo_children_names[parent][filename] = trans_id
868
limbo_name = pathjoin(self._limbodir, trans_id)
869
self._needs_rename.add(trans_id)
870
self._limbo_files[trans_id] = limbo_name
873
def _set_executability(self, path, entry, trans_id):
874
"""Set the executability of versioned files """
875
new_executability = self._new_executability[trans_id]
876
if entry is not None:
877
entry.executable = new_executability
878
if supports_executable():
879
abspath = self._tree.abspath(path)
880
current_mode = os.stat(abspath).st_mode
881
if new_executability:
884
to_mode = current_mode | (0100 & ~umask)
885
# Enable x-bit for others only if they can read it.
886
if current_mode & 0004:
887
to_mode |= 0001 & ~umask
888
if current_mode & 0040:
889
to_mode |= 0010 & ~umask
891
to_mode = current_mode & ~0111
892
os.chmod(abspath, to_mode)
894
def _new_entry(self, name, parent_id, file_id):
895
"""Helper function to create a new filesystem entry."""
896
trans_id = self.create_path(name, parent_id)
897
if file_id is not None:
898
self.version_file(file_id, trans_id)
901
def new_file(self, name, parent_id, contents, file_id=None,
903
"""Convenience method to create files.
905
name is the name of the file to create.
906
parent_id is the transaction id of the parent directory of the file.
907
contents is an iterator of bytestrings, which will be used to produce
909
:param file_id: The inventory ID of the file, if it is to be versioned.
910
:param executable: Only valid when a file_id has been supplied.
912
trans_id = self._new_entry(name, parent_id, file_id)
913
# TODO: rather than scheduling a set_executable call,
914
# have create_file create the file with the right mode.
915
self.create_file(contents, trans_id)
916
if executable is not None:
917
self.set_executability(executable, trans_id)
920
def new_directory(self, name, parent_id, file_id=None):
921
"""Convenience method to create directories.
923
name is the name of the directory to create.
924
parent_id is the transaction id of the parent directory of the
926
file_id is the inventory ID of the directory, if it is to be versioned.
928
trans_id = self._new_entry(name, parent_id, file_id)
929
self.create_directory(trans_id)
932
def new_symlink(self, name, parent_id, target, file_id=None):
933
"""Convenience method to create symbolic link.
935
name is the name of the symlink to create.
936
parent_id is the transaction id of the parent directory of the symlink.
937
target is a bytestring of the target of the symlink.
938
file_id is the inventory ID of the file, if it is to be versioned.
940
trans_id = self._new_entry(name, parent_id, file_id)
941
self.create_symlink(target, trans_id)
944
def _affected_ids(self):
945
"""Return the set of transform ids affected by the transform"""
946
trans_ids = set(self._removed_id)
947
trans_ids.update(self._new_id.keys())
948
trans_ids.update(self._removed_contents)
949
trans_ids.update(self._new_contents.keys())
950
trans_ids.update(self._new_executability.keys())
951
trans_ids.update(self._new_name.keys())
952
trans_ids.update(self._new_parent.keys())
955
def _get_file_id_maps(self):
956
"""Return mapping of file_ids to trans_ids in the to and from states"""
957
trans_ids = self._affected_ids()
960
# Build up two dicts: trans_ids associated with file ids in the
961
# FROM state, vs the TO state.
962
for trans_id in trans_ids:
963
from_file_id = self.tree_file_id(trans_id)
964
if from_file_id is not None:
965
from_trans_ids[from_file_id] = trans_id
966
to_file_id = self.final_file_id(trans_id)
967
if to_file_id is not None:
968
to_trans_ids[to_file_id] = trans_id
969
return from_trans_ids, to_trans_ids
971
def _from_file_data(self, from_trans_id, from_versioned, file_id):
972
"""Get data about a file in the from (tree) state
974
Return a (name, parent, kind, executable) tuple
976
from_path = self._tree_id_paths.get(from_trans_id)
978
# get data from working tree if versioned
979
from_entry = self._tree.inventory[file_id]
980
from_name = from_entry.name
981
from_parent = from_entry.parent_id
984
if from_path is None:
985
# File does not exist in FROM state
989
# File exists, but is not versioned. Have to use path-
991
from_name = os.path.basename(from_path)
992
tree_parent = self.get_tree_parent(from_trans_id)
993
from_parent = self.tree_file_id(tree_parent)
994
if from_path is not None:
995
from_kind, from_executable, from_stats = \
996
self._tree._comparison_data(from_entry, from_path)
999
from_executable = False
1000
return from_name, from_parent, from_kind, from_executable
1002
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1003
"""Get data about a file in the to (target) state
1005
Return a (name, parent, kind, executable) tuple
1007
to_name = self.final_name(to_trans_id)
1009
to_kind = self.final_kind(to_trans_id)
1012
to_parent = self.final_file_id(self.final_parent(to_trans_id))
1013
if to_trans_id in self._new_executability:
1014
to_executable = self._new_executability[to_trans_id]
1015
elif to_trans_id == from_trans_id:
1016
to_executable = from_executable
1018
to_executable = False
1019
return to_name, to_parent, to_kind, to_executable
1021
def iter_changes(self):
1022
"""Produce output in the same format as Tree.iter_changes.
1024
Will produce nonsensical results if invoked while inventory/filesystem
1025
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1027
This reads the Transform, but only reproduces changes involving a
1028
file_id. Files that are not versioned in either of the FROM or TO
1029
states are not reflected.
1031
final_paths = FinalPaths(self)
1032
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1034
# Now iterate through all active file_ids
1035
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1037
from_trans_id = from_trans_ids.get(file_id)
1038
# find file ids, and determine versioning state
1039
if from_trans_id is None:
1040
from_versioned = False
1041
from_trans_id = to_trans_ids[file_id]
1043
from_versioned = True
1044
to_trans_id = to_trans_ids.get(file_id)
1045
if to_trans_id is None:
1046
to_versioned = False
1047
to_trans_id = from_trans_id
1051
from_name, from_parent, from_kind, from_executable = \
1052
self._from_file_data(from_trans_id, from_versioned, file_id)
1054
to_name, to_parent, to_kind, to_executable = \
1055
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1057
if not from_versioned:
1060
from_path = self._tree_id_paths.get(from_trans_id)
1061
if not to_versioned:
1064
to_path = final_paths.get_path(to_trans_id)
1065
if from_kind != to_kind:
1067
elif to_kind in ('file', 'symlink') and (
1068
to_trans_id != from_trans_id or
1069
to_trans_id in self._new_contents):
1071
if (not modified and from_versioned == to_versioned and
1072
from_parent==to_parent and from_name == to_name and
1073
from_executable == to_executable):
1075
results.append((file_id, (from_path, to_path), modified,
1076
(from_versioned, to_versioned),
1077
(from_parent, to_parent),
1078
(from_name, to_name),
1079
(from_kind, to_kind),
1080
(from_executable, to_executable)))
1081
return iter(sorted(results, key=lambda x:x[1]))
1083
def get_preview_tree(self):
1084
"""Return a tree representing the result of the transform.
1086
This tree only supports the subset of Tree functionality required
1087
by show_diff_trees. It must only be compared to tt._tree.
1089
return _PreviewTree(self)
1092
class TreeTransform(TreeTransformBase):
1093
"""Represent a tree transformation.
1095
This object is designed to support incremental generation of the transform,
1098
However, it gives optimum performance when parent directories are created
1099
before their contents. The transform is then able to put child files
1100
directly in their parent directory, avoiding later renames.
1102
It is easy to produce malformed transforms, but they are generally
1103
harmless. Attempting to apply a malformed transform will cause an
1104
exception to be raised before any modifications are made to the tree.
1106
Many kinds of malformed transforms can be corrected with the
1107
resolve_conflicts function. The remaining ones indicate programming error,
1108
such as trying to create a file with no path.
1110
Two sets of file creation methods are supplied. Convenience methods are:
1115
These are composed of the low-level methods:
1117
* create_file or create_directory or create_symlink
1121
Transform/Transaction ids
1122
-------------------------
1123
trans_ids are temporary ids assigned to all files involved in a transform.
1124
It's possible, even common, that not all files in the Tree have trans_ids.
1126
trans_ids are used because filenames and file_ids are not good enough
1127
identifiers; filenames change, and not all files have file_ids. File-ids
1128
are also associated with trans-ids, so that moving a file moves its
1131
trans_ids are only valid for the TreeTransform that generated them.
1135
Limbo is a temporary directory use to hold new versions of files.
1136
Files are added to limbo by create_file, create_directory, create_symlink,
1137
and their convenience variants (new_*). Files may be removed from limbo
1138
using cancel_creation. Files are renamed from limbo into their final
1139
location as part of TreeTransform.apply
1141
Limbo must be cleaned up, by either calling TreeTransform.apply or
1142
calling TreeTransform.finalize.
1144
Files are placed into limbo inside their parent directories, where
1145
possible. This reduces subsequent renames, and makes operations involving
1146
lots of files faster. This optimization is only possible if the parent
1147
directory is created *before* creating any of its children, so avoid
1148
creating children before parents, where possible.
1152
This temporary directory is used by _FileMover for storing files that are
1153
about to be deleted. In case of rollback, the files will be restored.
1154
FileMover does not delete files until it is sure that a rollback will not
1157
def __init__(self, tree, pb=DummyProgress()):
1158
"""Note: a tree_write lock is taken on the tree.
1160
Use TreeTransform.finalize() to release the lock (can be omitted if
1161
TreeTransform.apply() called).
1163
tree.lock_tree_write()
1166
limbodir = urlutils.local_path_from_url(
1167
tree._transport.abspath('limbo'))
1171
if e.errno == errno.EEXIST:
1172
raise ExistingLimbo(limbodir)
1173
deletiondir = urlutils.local_path_from_url(
1174
tree._transport.abspath('pending-deletion'))
1176
os.mkdir(deletiondir)
1178
if e.errno == errno.EEXIST:
1179
raise errors.ExistingPendingDeletion(deletiondir)
1184
TreeTransformBase.__init__(self, tree, limbodir, pb,
1185
tree.case_sensitive)
1186
self._deletiondir = deletiondir
1188
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1189
"""Apply all changes to the inventory and filesystem.
1191
If filesystem or inventory conflicts are present, MalformedTransform
1194
If apply succeeds, finalize is not necessary.
1196
:param no_conflicts: if True, the caller guarantees there are no
1197
conflicts, so no check is made.
1198
:param precomputed_delta: An inventory delta to use instead of
1200
:param _mover: Supply an alternate FileMover, for testing
1202
if not no_conflicts:
1203
conflicts = self.find_conflicts()
1204
if len(conflicts) != 0:
1205
raise MalformedTransform(conflicts=conflicts)
1206
if precomputed_delta is None:
1207
new_inventory_delta = []
1208
inventory_delta = new_inventory_delta
1210
new_inventory_delta = None
1211
inventory_delta = precomputed_delta
1212
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1215
mover = _FileMover()
1219
child_pb.update('Apply phase', 0, 2)
1220
self._apply_removals(new_inventory_delta, mover)
1221
child_pb.update('Apply phase', 1, 2)
1222
modified_paths = self._apply_insertions(new_inventory_delta,
1228
mover.apply_deletions()
1231
self._tree.apply_inventory_delta(inventory_delta)
1234
return _TransformResults(modified_paths, self.rename_count)
1236
def _apply_removals(self, inventory_delta, mover):
1237
"""Perform tree operations that remove directory/inventory names.
1239
That is, delete files that are to be deleted, and put any files that
1240
need renaming into limbo. This must be done in strict child-to-parent
1243
If inventory_delta is None, no inventory delta generation is performed.
1245
tree_paths = list(self._tree_path_ids.iteritems())
1246
tree_paths.sort(reverse=True)
1247
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1249
for num, data in enumerate(tree_paths):
1250
path, trans_id = data
1251
child_pb.update('removing file', num, len(tree_paths))
1252
full_path = self._tree.abspath(path)
1253
if trans_id in self._removed_contents:
1254
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1256
elif trans_id in self._new_name or trans_id in \
1259
mover.rename(full_path, self._limbo_name(trans_id))
1261
if e.errno != errno.ENOENT:
1264
self.rename_count += 1
1265
if (trans_id in self._removed_id
1266
and inventory_delta is not None):
1267
if trans_id == self._new_root:
1268
file_id = self._tree.get_root_id()
1270
file_id = self.tree_file_id(trans_id)
1271
# File-id isn't really being deleted, just moved
1272
if file_id in self._r_new_id:
1274
inventory_delta.append((path, None, file_id, None))
1278
def _apply_insertions(self, inventory_delta, mover):
1279
"""Perform tree operations that insert directory/inventory names.
1281
That is, create any files that need to be created, and restore from
1282
limbo any files that needed renaming. This must be done in strict
1283
parent-to-child order.
1285
If inventory_delta is None, no inventory delta is calculated, and
1286
no list of modified paths is returned.
1288
new_paths = self.new_paths(filesystem_only=(inventory_delta is None))
1291
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1293
if inventory_delta is not None:
1294
entries = self._tree.iter_entries_by_dir(
1295
new_path_file_ids.values())
1296
old_paths = dict((e.file_id, p) for p, e in entries)
1297
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1299
for num, (path, trans_id) in enumerate(new_paths):
1302
child_pb.update('adding file', num, len(new_paths))
1303
full_path = self._tree.abspath(path)
1304
if trans_id in self._needs_rename:
1306
mover.rename(self._limbo_name(trans_id), full_path)
1308
# We may be renaming a dangling inventory id
1309
if e.errno != errno.ENOENT:
1312
self.rename_count += 1
1313
if inventory_delta is not None:
1314
if (trans_id in self._new_contents or
1315
self.path_changed(trans_id)):
1316
if trans_id in self._new_contents:
1317
modified_paths.append(full_path)
1318
completed_new.append(trans_id)
1319
file_id = new_path_file_ids[trans_id]
1320
if file_id is not None and (trans_id in self._new_id or
1321
trans_id in self._new_name or
1322
trans_id in self._new_parent
1323
or trans_id in self._new_executability):
1325
kind = self.final_kind(trans_id)
1327
kind = self._tree.stored_kind(file_id)
1328
parent_trans_id = self.final_parent(trans_id)
1329
parent_file_id = new_path_file_ids.get(parent_trans_id)
1330
if parent_file_id is None:
1331
parent_file_id = self.final_file_id(
1333
if trans_id in self._new_reference_revision:
1334
new_entry = inventory.TreeReference(
1336
self._new_name[trans_id],
1337
self.final_file_id(self._new_parent[trans_id]),
1338
None, self._new_reference_revision[trans_id])
1340
new_entry = inventory.make_entry(kind,
1341
self.final_name(trans_id),
1342
parent_file_id, file_id)
1343
old_path = old_paths.get(new_entry.file_id)
1344
inventory_delta.append(
1345
(old_path, path, new_entry.file_id, new_entry))
1347
if trans_id in self._new_executability:
1348
self._set_executability(path, new_entry, trans_id)
1351
if inventory_delta is None:
1352
self._new_contents.clear()
1354
for trans_id in completed_new:
1355
del self._new_contents[trans_id]
1356
return modified_paths
1359
class TransformPreview(TreeTransformBase):
1360
"""A TreeTransform for generating preview trees.
1362
Unlike TreeTransform, this version works when the input tree is a
1363
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1364
unversioned files in the input tree.
1367
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1369
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1370
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1372
def canonical_path(self, path):
1375
def tree_kind(self, trans_id):
1376
path = self._tree_id_paths.get(trans_id)
1378
raise NoSuchFile(None)
1379
file_id = self._tree.path2id(path)
1380
return self._tree.kind(file_id)
1382
def _set_mode(self, trans_id, mode_id, typefunc):
1383
"""Set the mode of new file contents.
1384
The mode_id is the existing file to get the mode from (often the same
1385
as trans_id). The operation is only performed if there's a mode match
1386
according to typefunc.
1388
# is it ok to ignore this? probably
1391
def iter_tree_children(self, parent_id):
1392
"""Iterate through the entry's tree children, if any"""
1394
path = self._tree_id_paths[parent_id]
1397
file_id = self.tree_file_id(parent_id)
1400
children = getattr(self._tree.inventory[file_id], 'children', {})
1401
for child in children:
1402
childpath = joinpath(path, child)
1403
yield self.trans_id_tree_path(childpath)
1406
class _PreviewTree(tree.Tree):
1407
"""Partial implementation of Tree to support show_diff_trees"""
1409
def __init__(self, transform):
1410
self._transform = transform
1411
self._final_paths = FinalPaths(transform)
1412
self.__by_parent = None
1414
def _changes(self, file_id):
1415
for changes in self._transform.iter_changes():
1416
if changes[0] == file_id:
1419
def _content_change(self, file_id):
1420
"""Return True if the content of this file changed"""
1421
changes = self._changes(file_id)
1422
# changes[2] is true if the file content changed. See
1423
# InterTree.iter_changes.
1424
return (changes is not None and changes[2])
1426
def _get_file_revision(self, file_id, vf, tree_revision):
1427
return self._transform._tree._get_file_revision(file_id, vf,
1430
def _stat_limbo_file(self, file_id):
1431
trans_id = self._transform.trans_id_file_id(file_id)
1432
name = self._transform._limbo_name(trans_id)
1433
return os.lstat(name)
1436
def _by_parent(self):
1437
if self.__by_parent is None:
1438
self.__by_parent = self._transform.by_parent()
1439
return self.__by_parent
1441
def lock_read(self):
1442
# Perhaps in theory, this should lock the TreeTransform?
1449
def inventory(self):
1450
"""This Tree does not use inventory as its backing data."""
1451
raise NotImplementedError(_PreviewTree.inventory)
1453
def get_root_id(self):
1454
return self._transform.final_file_id(self._transform.root)
1456
def all_file_ids(self):
1457
tree_ids = set(self._transform._tree.all_file_ids())
1458
tree_ids.difference_update(self._transform.tree_file_id(t)
1459
for t in self._transform._removed_id)
1460
tree_ids.update(self._transform._new_id.values())
1464
return iter(self.all_file_ids())
1466
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1467
"""See Tree.paths2ids"""
1468
to_find = set(specific_files)
1470
for (file_id, paths, changed, versioned, parent, name, kind,
1471
executable) in self._transform.iter_changes():
1472
if paths[1] in to_find:
1473
result.append(file_id)
1474
to_find.remove(paths[1])
1475
result.update(self._transform._tree.paths2ids(to_find,
1476
trees=[], require_versioned=require_versioned))
1479
def _path2trans_id(self, path):
1480
segments = splitpath(path)
1481
cur_parent = self._transform.root
1482
for cur_segment in segments:
1483
for child in self._all_children(cur_parent):
1484
if self._transform.final_name(child) == cur_segment:
1491
def path2id(self, path):
1492
return self._transform.final_file_id(self._path2trans_id(path))
1494
def id2path(self, file_id):
1495
trans_id = self._transform.trans_id_file_id(file_id)
1497
return self._final_paths._determine_path(trans_id)
1499
raise errors.NoSuchId(self, file_id)
1501
def _all_children(self, trans_id):
1502
children = set(self._transform.iter_tree_children(trans_id))
1503
# children in the _new_parent set are provided by _by_parent.
1504
children.difference_update(self._transform._new_parent.keys())
1505
children.update(self._by_parent.get(trans_id, []))
1508
def _make_inv_entries(self, ordered_entries, specific_file_ids):
1509
for trans_id, parent_file_id in ordered_entries:
1510
file_id = self._transform.final_file_id(trans_id)
1513
if (specific_file_ids is not None
1514
and file_id not in specific_file_ids):
1517
kind = self._transform.final_kind(trans_id)
1519
kind = self._transform._tree.stored_kind(file_id)
1520
new_entry = inventory.make_entry(
1522
self._transform.final_name(trans_id),
1523
parent_file_id, file_id)
1524
yield new_entry, trans_id
1526
def iter_entries_by_dir(self, specific_file_ids=None):
1527
# This may not be a maximally efficient implementation, but it is
1528
# reasonably straightforward. An implementation that grafts the
1529
# TreeTransform changes onto the tree's iter_entries_by_dir results
1530
# might be more efficient, but requires tricky inferences about stack
1532
todo = [ROOT_PARENT]
1534
while len(todo) > 0:
1536
parent_file_id = self._transform.final_file_id(parent)
1537
children = list(self._all_children(parent))
1538
paths = dict(zip(children, self._final_paths.get_paths(children)))
1539
children.sort(key=paths.get)
1540
todo.extend(reversed(children))
1541
for trans_id in children:
1542
ordered_ids.append((trans_id, parent_file_id))
1543
for entry, trans_id in self._make_inv_entries(ordered_ids,
1545
yield unicode(self._final_paths.get_path(trans_id)), entry
1547
def kind(self, file_id):
1548
trans_id = self._transform.trans_id_file_id(file_id)
1549
return self._transform.final_kind(trans_id)
1551
def stored_kind(self, file_id):
1552
trans_id = self._transform.trans_id_file_id(file_id)
1554
return self._transform._new_contents[trans_id]
1556
return self._transform._tree.stored_kind(file_id)
1558
def get_file_mtime(self, file_id, path=None):
1559
"""See Tree.get_file_mtime"""
1560
if not self._content_change(file_id):
1561
return self._transform._tree.get_file_mtime(file_id, path)
1562
return self._stat_limbo_file(file_id).st_mtime
1564
def get_file_size(self, file_id):
1565
"""See Tree.get_file_size"""
1566
if self.kind(file_id) == 'file':
1567
return self._transform._tree.get_file_size(file_id)
1571
def get_file_sha1(self, file_id, path=None, stat_value=None):
1572
return self._transform._tree.get_file_sha1(file_id)
1574
def is_executable(self, file_id, path=None):
1575
trans_id = self._transform.trans_id_file_id(file_id)
1577
return self._transform._new_executability[trans_id]
1579
return self._transform._tree.is_executable(file_id, path)
1581
def path_content_summary(self, path):
1582
trans_id = self._path2trans_id(path)
1583
tt = self._transform
1584
tree_path = tt._tree_id_paths.get(trans_id)
1585
kind = tt._new_contents.get(trans_id)
1587
if tree_path is None or trans_id in tt._removed_contents:
1588
return 'missing', None, None, None
1589
summary = tt._tree.path_content_summary(tree_path)
1590
kind, size, executable, link_or_sha1 = summary
1593
limbo_name = tt._limbo_name(trans_id)
1594
if trans_id in tt._new_reference_revision:
1595
kind = 'tree-reference'
1597
statval = os.lstat(limbo_name)
1598
size = statval.st_size
1599
if not supports_executable():
1602
executable = statval.st_mode & S_IEXEC
1606
if kind == 'symlink':
1607
link_or_sha1 = os.readlink(limbo_name)
1608
if supports_executable():
1609
executable = tt._new_executability.get(trans_id, executable)
1610
return kind, size, executable, link_or_sha1
1612
def iter_changes(self, from_tree, include_unchanged=False,
1613
specific_files=None, pb=None, extra_trees=None,
1614
require_versioned=True, want_unversioned=False):
1615
"""See InterTree.iter_changes.
1617
This implementation does not support include_unchanged, specific_files,
1618
or want_unversioned. extra_trees, require_versioned, and pb are
1621
if from_tree is not self._transform._tree:
1622
raise ValueError('from_tree must be transform source tree.')
1623
if include_unchanged:
1624
raise ValueError('include_unchanged is not supported')
1625
if specific_files is not None:
1626
raise ValueError('specific_files is not supported')
1627
if want_unversioned:
1628
raise ValueError('want_unversioned is not supported')
1629
return self._transform.iter_changes()
1631
def get_file(self, file_id, path=None):
1632
"""See Tree.get_file"""
1633
if not self._content_change(file_id):
1634
return self._transform._tree.get_file(file_id, path)
1635
trans_id = self._transform.trans_id_file_id(file_id)
1636
name = self._transform._limbo_name(trans_id)
1637
return open(name, 'rb')
1639
def get_file_text(self, file_id):
1640
text_file = self.get_file(file_id)
1642
return text_file.read()
1646
def annotate_iter(self, file_id,
1647
default_revision=_mod_revision.CURRENT_REVISION):
1648
changes = self._changes(file_id)
1652
changed_content, versioned, kind = (changes[2], changes[3],
1656
get_old = (kind[0] == 'file' and versioned[0])
1658
old_annotation = self._transform._tree.annotate_iter(file_id,
1659
default_revision=default_revision)
1663
return old_annotation
1664
if not changed_content:
1665
return old_annotation
1666
return annotate.reannotate([old_annotation],
1667
self.get_file(file_id).readlines(),
1670
def get_symlink_target(self, file_id):
1671
"""See Tree.get_symlink_target"""
1672
if not self._content_change(file_id):
1673
return self._transform._tree.get_symlink_target(file_id)
1674
trans_id = self._transform.trans_id_file_id(file_id)
1675
name = self._transform._limbo_name(trans_id)
1676
return os.readlink(name)
1678
def list_files(self, include_root=False):
1679
return self._transform._tree.list_files(include_root)
1681
def walkdirs(self, prefix=""):
1682
return self._transform._tree.walkdirs(prefix)
1684
def get_parent_ids(self):
1685
return self._transform._tree.get_parent_ids()
1687
def get_revision_tree(self, revision_id):
1688
return self._transform._tree.get_revision_tree(revision_id)
1691
def joinpath(parent, child):
1692
"""Join tree-relative paths, handling the tree root specially"""
1693
if parent is None or parent == "":
1696
return pathjoin(parent, child)
1699
class FinalPaths(object):
1700
"""Make path calculation cheap by memoizing paths.
1702
The underlying tree must not be manipulated between calls, or else
1703
the results will likely be incorrect.
1705
def __init__(self, transform):
1706
object.__init__(self)
1707
self._known_paths = {}
1708
self.transform = transform
1710
def _determine_path(self, trans_id):
1711
if trans_id == self.transform.root:
1713
name = self.transform.final_name(trans_id)
1714
parent_id = self.transform.final_parent(trans_id)
1715
if parent_id == self.transform.root:
1718
return pathjoin(self.get_path(parent_id), name)
1720
def get_path(self, trans_id):
1721
"""Find the final path associated with a trans_id"""
1722
if trans_id not in self._known_paths:
1723
self._known_paths[trans_id] = self._determine_path(trans_id)
1724
return self._known_paths[trans_id]
1726
def get_paths(self, trans_ids):
1727
return [(self.get_path(t), t) for t in trans_ids]
1731
def topology_sorted_ids(tree):
1732
"""Determine the topological order of the ids in a tree"""
1733
file_ids = list(tree)
1734
file_ids.sort(key=tree.id2path)
1738
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
1739
delta_from_tree=False):
1740
"""Create working tree for a branch, using a TreeTransform.
1742
This function should be used on empty trees, having a tree root at most.
1743
(see merge and revert functionality for working with existing trees)
1745
Existing files are handled like so:
1747
- Existing bzrdirs take precedence over creating new items. They are
1748
created as '%s.diverted' % name.
1749
- Otherwise, if the content on disk matches the content we are building,
1750
it is silently replaced.
1751
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1753
:param tree: The tree to convert wt into a copy of
1754
:param wt: The working tree that files will be placed into
1755
:param accelerator_tree: A tree which can be used for retrieving file
1756
contents more quickly than tree itself, i.e. a workingtree. tree
1757
will be used for cases where accelerator_tree's content is different.
1758
:param hardlink: If true, hard-link files to accelerator_tree, where
1759
possible. accelerator_tree must implement abspath, i.e. be a
1761
:param delta_from_tree: If true, build_tree may use the input Tree to
1762
generate the inventory delta.
1764
wt.lock_tree_write()
1768
if accelerator_tree is not None:
1769
accelerator_tree.lock_read()
1771
return _build_tree(tree, wt, accelerator_tree, hardlink,
1774
if accelerator_tree is not None:
1775
accelerator_tree.unlock()
1782
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
1783
"""See build_tree."""
1784
for num, _unused in enumerate(wt.all_file_ids()):
1785
if num > 0: # more than just a root
1786
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1787
existing_files = set()
1788
for dir, files in wt.walkdirs():
1789
existing_files.update(f[0] for f in files)
1791
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1792
pp = ProgressPhase("Build phase", 2, top_pb)
1793
if tree.inventory.root is not None:
1794
# This is kind of a hack: we should be altering the root
1795
# as part of the regular tree shape diff logic.
1796
# The conditional test here is to avoid doing an
1797
# expensive operation (flush) every time the root id
1798
# is set within the tree, nor setting the root and thus
1799
# marking the tree as dirty, because we use two different
1800
# idioms here: tree interfaces and inventory interfaces.
1801
if wt.get_root_id() != tree.get_root_id():
1802
wt.set_root_id(tree.get_root_id())
1804
tt = TreeTransform(wt)
1808
file_trans_id[wt.get_root_id()] = \
1809
tt.trans_id_tree_file_id(wt.get_root_id())
1810
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1812
deferred_contents = []
1814
total = len(tree.inventory)
1816
precomputed_delta = []
1818
precomputed_delta = None
1819
for num, (tree_path, entry) in \
1820
enumerate(tree.inventory.iter_entries_by_dir()):
1821
pb.update("Building tree", num - len(deferred_contents), total)
1822
if entry.parent_id is None:
1825
file_id = entry.file_id
1827
precomputed_delta.append((None, tree_path, file_id, entry))
1828
if tree_path in existing_files:
1829
target_path = wt.abspath(tree_path)
1830
kind = file_kind(target_path)
1831
if kind == "directory":
1833
bzrdir.BzrDir.open(target_path)
1834
except errors.NotBranchError:
1838
if (file_id not in divert and
1839
_content_match(tree, entry, file_id, kind,
1841
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1842
if kind == 'directory':
1844
parent_id = file_trans_id[entry.parent_id]
1845
if entry.kind == 'file':
1846
# We *almost* replicate new_by_entry, so that we can defer
1847
# getting the file text, and get them all at once.
1848
trans_id = tt.create_path(entry.name, parent_id)
1849
file_trans_id[file_id] = trans_id
1850
tt.version_file(file_id, trans_id)
1851
executable = tree.is_executable(file_id, tree_path)
1853
tt.set_executability(executable, trans_id)
1854
deferred_contents.append((file_id, trans_id))
1856
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1859
new_trans_id = file_trans_id[file_id]
1860
old_parent = tt.trans_id_tree_path(tree_path)
1861
_reparent_children(tt, old_parent, new_trans_id)
1862
offset = num + 1 - len(deferred_contents)
1863
_create_files(tt, tree, deferred_contents, pb, offset,
1864
accelerator_tree, hardlink)
1868
divert_trans = set(file_trans_id[f] for f in divert)
1869
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1870
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1871
if len(raw_conflicts) > 0:
1872
precomputed_delta = None
1873
conflicts = cook_conflicts(raw_conflicts, tt)
1874
for conflict in conflicts:
1877
wt.add_conflicts(conflicts)
1878
except errors.UnsupportedOperation:
1880
result = tt.apply(no_conflicts=True,
1881
precomputed_delta=precomputed_delta)
1888
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1890
total = len(desired_files) + offset
1891
if accelerator_tree is None:
1892
new_desired_files = desired_files
1894
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1895
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1896
in iter if not (c or e[0] != e[1]))
1897
new_desired_files = []
1899
for file_id, trans_id in desired_files:
1900
accelerator_path = unchanged.get(file_id)
1901
if accelerator_path is None:
1902
new_desired_files.append((file_id, trans_id))
1904
pb.update('Adding file contents', count + offset, total)
1906
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1909
contents = accelerator_tree.get_file(file_id, accelerator_path)
1911
tt.create_file(contents, trans_id)
1916
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1917
new_desired_files)):
1918
tt.create_file(contents, trans_id)
1919
pb.update('Adding file contents', count + offset, total)
1922
def _reparent_children(tt, old_parent, new_parent):
1923
for child in tt.iter_tree_children(old_parent):
1924
tt.adjust_path(tt.final_name(child), new_parent, child)
1926
def _reparent_transform_children(tt, old_parent, new_parent):
1927
by_parent = tt.by_parent()
1928
for child in by_parent[old_parent]:
1929
tt.adjust_path(tt.final_name(child), new_parent, child)
1930
return by_parent[old_parent]
1932
def _content_match(tree, entry, file_id, kind, target_path):
1933
if entry.kind != kind:
1935
if entry.kind == "directory":
1937
if entry.kind == "file":
1938
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1940
elif entry.kind == "symlink":
1941
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1946
def resolve_checkout(tt, conflicts, divert):
1947
new_conflicts = set()
1948
for c_type, conflict in ((c[0], c) for c in conflicts):
1949
# Anything but a 'duplicate' would indicate programmer error
1950
if c_type != 'duplicate':
1951
raise AssertionError(c_type)
1952
# Now figure out which is new and which is old
1953
if tt.new_contents(conflict[1]):
1954
new_file = conflict[1]
1955
old_file = conflict[2]
1957
new_file = conflict[2]
1958
old_file = conflict[1]
1960
# We should only get here if the conflict wasn't completely
1962
final_parent = tt.final_parent(old_file)
1963
if new_file in divert:
1964
new_name = tt.final_name(old_file)+'.diverted'
1965
tt.adjust_path(new_name, final_parent, new_file)
1966
new_conflicts.add((c_type, 'Diverted to',
1967
new_file, old_file))
1969
new_name = tt.final_name(old_file)+'.moved'
1970
tt.adjust_path(new_name, final_parent, old_file)
1971
new_conflicts.add((c_type, 'Moved existing file to',
1972
old_file, new_file))
1973
return new_conflicts
1976
def new_by_entry(tt, entry, parent_id, tree):
1977
"""Create a new file according to its inventory entry"""
1981
contents = tree.get_file(entry.file_id).readlines()
1982
executable = tree.is_executable(entry.file_id)
1983
return tt.new_file(name, parent_id, contents, entry.file_id,
1985
elif kind in ('directory', 'tree-reference'):
1986
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1987
if kind == 'tree-reference':
1988
tt.set_tree_reference(entry.reference_revision, trans_id)
1990
elif kind == 'symlink':
1991
target = tree.get_symlink_target(entry.file_id)
1992
return tt.new_symlink(name, parent_id, target, entry.file_id)
1994
raise errors.BadFileKindError(name, kind)
1997
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1998
"""Create new file contents according to an inventory entry."""
1999
if entry.kind == "file":
2001
lines = tree.get_file(entry.file_id).readlines()
2002
tt.create_file(lines, trans_id, mode_id=mode_id)
2003
elif entry.kind == "symlink":
2004
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2005
elif entry.kind == "directory":
2006
tt.create_directory(trans_id)
2009
def create_entry_executability(tt, entry, trans_id):
2010
"""Set the executability of a trans_id according to an inventory entry"""
2011
if entry.kind == "file":
2012
tt.set_executability(entry.executable, trans_id)
2015
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2016
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2019
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2020
"""Produce a backup-style name that appears to be available"""
2024
yield "%s.~%d~" % (name, counter)
2026
for new_name in name_gen():
2027
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2031
def _entry_changes(file_id, entry, working_tree):
2032
"""Determine in which ways the inventory entry has changed.
2034
Returns booleans: has_contents, content_mod, meta_mod
2035
has_contents means there are currently contents, but they differ
2036
contents_mod means contents need to be modified
2037
meta_mod means the metadata needs to be modified
2039
cur_entry = working_tree.inventory[file_id]
2041
working_kind = working_tree.kind(file_id)
2044
has_contents = False
2047
if has_contents is True:
2048
if entry.kind != working_kind:
2049
contents_mod, meta_mod = True, False
2051
cur_entry._read_tree_state(working_tree.id2path(file_id),
2053
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2054
cur_entry._forget_tree_state()
2055
return has_contents, contents_mod, meta_mod
2058
def revert(working_tree, target_tree, filenames, backups=False,
2059
pb=DummyProgress(), change_reporter=None):
2060
"""Revert a working tree's contents to those of a target tree."""
2061
target_tree.lock_read()
2062
tt = TreeTransform(working_tree, pb)
2064
pp = ProgressPhase("Revert phase", 3, pb)
2066
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2068
merge_modified = _alter_files(working_tree, target_tree, tt,
2069
child_pb, filenames, backups)
2073
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2075
raw_conflicts = resolve_conflicts(tt, child_pb,
2076
lambda t, c: conflict_pass(t, c, target_tree))
2079
conflicts = cook_conflicts(raw_conflicts, tt)
2081
change_reporter = delta._ChangeReporter(
2082
unversioned_filter=working_tree.is_ignored)
2083
delta.report_changes(tt.iter_changes(), change_reporter)
2084
for conflict in conflicts:
2088
working_tree.set_merge_modified(merge_modified)
2090
target_tree.unlock()
2096
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2098
merge_modified = working_tree.merge_modified()
2099
change_list = target_tree.iter_changes(working_tree,
2100
specific_files=specific_files, pb=pb)
2101
if target_tree.inventory.root is None:
2108
for id_num, (file_id, path, changed_content, versioned, parent, name,
2109
kind, executable) in enumerate(change_list):
2110
if skip_root and file_id[0] is not None and parent[0] is None:
2112
trans_id = tt.trans_id_file_id(file_id)
2115
keep_content = False
2116
if kind[0] == 'file' and (backups or kind[1] is None):
2117
wt_sha1 = working_tree.get_file_sha1(file_id)
2118
if merge_modified.get(file_id) != wt_sha1:
2119
# acquire the basis tree lazily to prevent the
2120
# expense of accessing it when it's not needed ?
2121
# (Guessing, RBC, 200702)
2122
if basis_tree is None:
2123
basis_tree = working_tree.basis_tree()
2124
basis_tree.lock_read()
2125
if file_id in basis_tree:
2126
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2128
elif kind[1] is None and not versioned[1]:
2130
if kind[0] is not None:
2131
if not keep_content:
2132
tt.delete_contents(trans_id)
2133
elif kind[1] is not None:
2134
parent_trans_id = tt.trans_id_file_id(parent[0])
2135
by_parent = tt.by_parent()
2136
backup_name = _get_backup_name(name[0], by_parent,
2137
parent_trans_id, tt)
2138
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2139
new_trans_id = tt.create_path(name[0], parent_trans_id)
2140
if versioned == (True, True):
2141
tt.unversion_file(trans_id)
2142
tt.version_file(file_id, new_trans_id)
2143
# New contents should have the same unix perms as old
2146
trans_id = new_trans_id
2147
if kind[1] == 'directory':
2148
tt.create_directory(trans_id)
2149
elif kind[1] == 'symlink':
2150
tt.create_symlink(target_tree.get_symlink_target(file_id),
2152
elif kind[1] == 'file':
2153
deferred_files.append((file_id, (trans_id, mode_id)))
2154
if basis_tree is None:
2155
basis_tree = working_tree.basis_tree()
2156
basis_tree.lock_read()
2157
new_sha1 = target_tree.get_file_sha1(file_id)
2158
if (file_id in basis_tree and new_sha1 ==
2159
basis_tree.get_file_sha1(file_id)):
2160
if file_id in merge_modified:
2161
del merge_modified[file_id]
2163
merge_modified[file_id] = new_sha1
2165
# preserve the execute bit when backing up
2166
if keep_content and executable[0] == executable[1]:
2167
tt.set_executability(executable[1], trans_id)
2168
elif kind[1] is not None:
2169
raise AssertionError(kind[1])
2170
if versioned == (False, True):
2171
tt.version_file(file_id, trans_id)
2172
if versioned == (True, False):
2173
tt.unversion_file(trans_id)
2174
if (name[1] is not None and
2175
(name[0] != name[1] or parent[0] != parent[1])):
2177
name[1], tt.trans_id_file_id(parent[1]), trans_id)
2178
if executable[0] != executable[1] and kind[1] == "file":
2179
tt.set_executability(executable[1], trans_id)
2180
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2182
tt.create_file(bytes, trans_id, mode_id)
2184
if basis_tree is not None:
2186
return merge_modified
2189
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2190
"""Make many conflict-resolution attempts, but die if they fail"""
2191
if pass_func is None:
2192
pass_func = conflict_pass
2193
new_conflicts = set()
2196
pb.update('Resolution pass', n+1, 10)
2197
conflicts = tt.find_conflicts()
2198
if len(conflicts) == 0:
2199
return new_conflicts
2200
new_conflicts.update(pass_func(tt, conflicts))
2201
raise MalformedTransform(conflicts=conflicts)
2206
def conflict_pass(tt, conflicts, path_tree=None):
2207
"""Resolve some classes of conflicts.
2209
:param tt: The transform to resolve conflicts in
2210
:param conflicts: The conflicts to resolve
2211
:param path_tree: A Tree to get supplemental paths from
2213
new_conflicts = set()
2214
for c_type, conflict in ((c[0], c) for c in conflicts):
2215
if c_type == 'duplicate id':
2216
tt.unversion_file(conflict[1])
2217
new_conflicts.add((c_type, 'Unversioned existing file',
2218
conflict[1], conflict[2], ))
2219
elif c_type == 'duplicate':
2220
# files that were renamed take precedence
2221
final_parent = tt.final_parent(conflict[1])
2222
if tt.path_changed(conflict[1]):
2223
existing_file, new_file = conflict[2], conflict[1]
2225
existing_file, new_file = conflict[1], conflict[2]
2226
new_name = tt.final_name(existing_file)+'.moved'
2227
tt.adjust_path(new_name, final_parent, existing_file)
2228
new_conflicts.add((c_type, 'Moved existing file to',
2229
existing_file, new_file))
2230
elif c_type == 'parent loop':
2231
# break the loop by undoing one of the ops that caused the loop
2233
while not tt.path_changed(cur):
2234
cur = tt.final_parent(cur)
2235
new_conflicts.add((c_type, 'Cancelled move', cur,
2236
tt.final_parent(cur),))
2237
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2239
elif c_type == 'missing parent':
2240
trans_id = conflict[1]
2242
tt.cancel_deletion(trans_id)
2243
new_conflicts.add(('deleting parent', 'Not deleting',
2248
tt.final_name(trans_id)
2250
if path_tree is not None:
2251
file_id = tt.final_file_id(trans_id)
2253
file_id = tt.inactive_file_id(trans_id)
2254
entry = path_tree.inventory[file_id]
2255
# special-case the other tree root (move its
2256
# children to current root)
2257
if entry.parent_id is None:
2259
moved = _reparent_transform_children(
2260
tt, trans_id, tt.root)
2262
new_conflicts.add((c_type, 'Moved to root',
2265
parent_trans_id = tt.trans_id_file_id(
2267
tt.adjust_path(entry.name, parent_trans_id,
2270
tt.create_directory(trans_id)
2271
new_conflicts.add((c_type, 'Created directory', trans_id))
2272
elif c_type == 'unversioned parent':
2273
file_id = tt.inactive_file_id(conflict[1])
2274
# special-case the other tree root (move its children instead)
2275
if path_tree and file_id in path_tree:
2276
if path_tree.inventory[file_id].parent_id is None:
2278
tt.version_file(file_id, conflict[1])
2279
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2280
elif c_type == 'non-directory parent':
2281
parent_id = conflict[1]
2282
parent_parent = tt.final_parent(parent_id)
2283
parent_name = tt.final_name(parent_id)
2284
parent_file_id = tt.final_file_id(parent_id)
2285
new_parent_id = tt.new_directory(parent_name + '.new',
2286
parent_parent, parent_file_id)
2287
_reparent_transform_children(tt, parent_id, new_parent_id)
2288
if parent_file_id is not None:
2289
tt.unversion_file(parent_id)
2290
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2291
return new_conflicts
2294
def cook_conflicts(raw_conflicts, tt):
2295
"""Generate a list of cooked conflicts, sorted by file path"""
2296
from bzrlib.conflicts import Conflict
2297
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2298
return sorted(conflict_iter, key=Conflict.sort_key)
2301
def iter_cook_conflicts(raw_conflicts, tt):
2302
from bzrlib.conflicts import Conflict
2304
for conflict in raw_conflicts:
2305
c_type = conflict[0]
2306
action = conflict[1]
2307
modified_path = fp.get_path(conflict[2])
2308
modified_id = tt.final_file_id(conflict[2])
2309
if len(conflict) == 3:
2310
yield Conflict.factory(c_type, action=action, path=modified_path,
2311
file_id=modified_id)
2314
conflicting_path = fp.get_path(conflict[3])
2315
conflicting_id = tt.final_file_id(conflict[3])
2316
yield Conflict.factory(c_type, action=action, path=modified_path,
2317
file_id=modified_id,
2318
conflict_path=conflicting_path,
2319
conflict_file_id=conflicting_id)
2322
class _FileMover(object):
2323
"""Moves and deletes files for TreeTransform, tracking operations"""
2326
self.past_renames = []
2327
self.pending_deletions = []
2329
def rename(self, from_, to):
2330
"""Rename a file from one path to another. Functions like os.rename"""
2332
os.rename(from_, to)
2334
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2335
raise errors.FileExists(to, str(e))
2337
self.past_renames.append((from_, to))
2339
def pre_delete(self, from_, to):
2340
"""Rename a file out of the way and mark it for deletion.
2342
Unlike os.unlink, this works equally well for files and directories.
2343
:param from_: The current file path
2344
:param to: A temporary path for the file
2346
self.rename(from_, to)
2347
self.pending_deletions.append(to)
2350
"""Reverse all renames that have been performed"""
2351
for from_, to in reversed(self.past_renames):
2352
os.rename(to, from_)
2353
# after rollback, don't reuse _FileMover
2355
pending_deletions = None
2357
def apply_deletions(self):
2358
"""Apply all marked deletions"""
2359
for path in self.pending_deletions:
2361
# after apply_deletions, don't reuse _FileMover
2363
pending_deletions = None
added
removed
bzrlib/transform.py
