# Copyright (C) 2005, 2006 Canonical Ltd # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # FIXME: This refactoring of the workingtree code doesn't seem to keep # the WorkingTree's copy of the inventory in sync with the branch. The # branch modifies its working inventory when it does a commit to make # missing files permanently removed. # TODO: Maybe also keep the full path of the entry, and the children? # But those depend on its position within a particular inventory, and # it would be nice not to need to hold the backpointer here. # This should really be an id randomly assigned when the tree is # created, but it's not for now. ROOT_ID = "TREE_ROOT" import os import re import sys from bzrlib.lazy_import import lazy_import lazy_import(globals(), """ import collections import tarfile import bzrlib from bzrlib import ( errors, osutils, symbol_versioning, ) """) from bzrlib.errors import ( BzrCheckError, BzrError, ) from bzrlib.trace import mutter class InventoryEntry(object): """Description of a versioned file. An InventoryEntry has the following fields, which are also present in the XML inventory-entry element: file_id name (within the parent directory) parent_id file_id of the parent directory, or ROOT_ID revision the revision_id in which this variation of this file was introduced. executable Indicates that this file should be executable on systems that support it. text_sha1 sha-1 of the text of the file text_size size in bytes of the text of the file (reading a version 4 tree created a text_id field.) >>> i = Inventory() >>> i.path2id('') 'TREE_ROOT' >>> i.add(InventoryDirectory('123', 'src', ROOT_ID)) InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None) >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123')) InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None) >>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'} >>> for ix, j in enumerate(i.iter_entries()): ... print (j[0] == shouldbe[ix], j[1]) ... (True, InventoryDirectory('TREE_ROOT', '', parent_id=None, revision=None)) (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)) (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)) >>> i.add(InventoryFile('2323', 'bye.c', '123')) Traceback (most recent call last): ... BzrError: inventory already contains entry with id {2323} >>> i.add(InventoryFile('2324', 'bye.c', '123')) InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None) >>> i.add(InventoryDirectory('2325', 'wibble', '123')) InventoryDirectory('2325', 'wibble', parent_id='123', revision=None) >>> i.path2id('src/wibble') '2325' >>> '2325' in i True >>> i.add(InventoryFile('2326', 'wibble.c', '2325')) InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None) >>> i['2326'] InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None) >>> for path, entry in i.iter_entries(): ... print path ... assert i.path2id(path) ... src src/bye.c src/hello.c src/wibble src/wibble/wibble.c >>> i.id2path('2326') 'src/wibble/wibble.c' """ # Constants returned by describe_change() # # TODO: These should probably move to some kind of FileChangeDescription # class; that's like what's inside a TreeDelta but we want to be able to # generate them just for one file at a time. RENAMED = 'renamed' MODIFIED_AND_RENAMED = 'modified and renamed' __slots__ = [] def detect_changes(self, old_entry): """Return a (text_modified, meta_modified) from this to old_entry. _read_tree_state must have been called on self and old_entry prior to calling detect_changes. """ return False, False def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree, output_to, reverse=False): """Perform a diff from this to to_entry. text_diff will be used for textual difference calculation. This is a template method, override _diff in child classes. """ self._read_tree_state(tree.id2path(self.file_id), tree) if to_entry: # cannot diff from one kind to another - you must do a removal # and an addif they do not match. assert self.kind == to_entry.kind to_entry._read_tree_state(to_tree.id2path(to_entry.file_id), to_tree) self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree, output_to, reverse) def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree, output_to, reverse=False): """Perform a diff between two entries of the same kind.""" def find_previous_heads(self, previous_inventories, versioned_file_store, transaction, entry_vf=None): """Return the revisions and entries that directly precede this. Returned as a map from revision to inventory entry. This is a map containing the file revisions in all parents for which the file exists, and its revision is not a parent of any other. If the file is new, the set will be empty. :param versioned_file_store: A store where ancestry data on this file id can be queried. :param transaction: The transaction that queries to the versioned file store should be completed under. :param entry_vf: The entry versioned file, if its already available. """ def get_ancestors(weave, entry): return set(weave.get_ancestry(entry.revision)) # revision:ie mapping for each ie found in previous_inventories. candidates = {} # revision:ie mapping with one revision for each head. heads = {} # revision: ancestor list for each head head_ancestors = {} # identify candidate head revision ids. for inv in previous_inventories: if self.file_id in inv: ie = inv[self.file_id] assert ie.file_id == self.file_id if ie.revision in candidates: # same revision value in two different inventories: # correct possible inconsistencies: # * there was a bug in revision updates with 'x' bit # support. try: if candidates[ie.revision].executable != ie.executable: candidates[ie.revision].executable = False ie.executable = False except AttributeError: pass # must now be the same. assert candidates[ie.revision] == ie else: # add this revision as a candidate. candidates[ie.revision] = ie # common case optimisation if len(candidates) == 1: # if there is only one candidate revision found # then we can opening the versioned file to access ancestry: # there cannot be any ancestors to eliminate when there is # only one revision available. heads[ie.revision] = ie return heads # eliminate ancestors amongst the available candidates: # heads are those that are not an ancestor of any other candidate # - this provides convergence at a per-file level. for ie in candidates.values(): # may be an ancestor of a known head: already_present = 0 != len( [head for head in heads if ie.revision in head_ancestors[head]]) if already_present: # an ancestor of an analyzed candidate. continue # not an ancestor of a known head: # load the versioned file for this file id if needed if entry_vf is None: entry_vf = versioned_file_store.get_weave_or_empty( self.file_id, transaction) ancestors = get_ancestors(entry_vf, ie) # may knock something else out: check_heads = list(heads.keys()) for head in check_heads: if head in ancestors: # this previously discovered 'head' is not # really a head - its an ancestor of the newly # found head, heads.pop(head) head_ancestors[ie.revision] = ancestors heads[ie.revision] = ie return heads def get_tar_item(self, root, dp, now, tree): """Get a tarfile item and a file stream for its content.""" item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8')) # TODO: would be cool to actually set it to the timestamp of the # revision it was last changed item.mtime = now fileobj = self._put_in_tar(item, tree) return item, fileobj def has_text(self): """Return true if the object this entry represents has textual data. Note that textual data includes binary content. Also note that all entries get weave files created for them. This attribute is primarily used when upgrading from old trees that did not have the weave index for all inventory entries. """ return False def __init__(self, file_id, name, parent_id, text_id=None): """Create an InventoryEntry The filename must be a single component, relative to the parent directory; it cannot be a whole path or relative name. >>> e = InventoryFile('123', 'hello.c', ROOT_ID) >>> e.name 'hello.c' >>> e.file_id '123' >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID) Traceback (most recent call last): InvalidEntryName: Invalid entry name: src/hello.c """ assert isinstance(name, basestring), name if '/' in name or '\\' in name: raise errors.InvalidEntryName(name=name) self.executable = False self.revision = None self.text_sha1 = None self.text_size = None self.file_id = file_id self.name = name self.text_id = text_id self.parent_id = parent_id self.symlink_target = None def kind_character(self): """Return a short kind indicator useful for appending to names.""" raise BzrError('unknown kind %r' % self.kind) known_kinds = ('file', 'directory', 'symlink') def _put_in_tar(self, item, tree): """populate item for stashing in a tar, and return the content stream. If no content is available, return None. """ raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind)) def put_on_disk(self, dest, dp, tree): """Create a representation of self on disk in the prefix dest. This is a template method - implement _put_on_disk in subclasses. """ fullpath = osutils.pathjoin(dest, dp) self._put_on_disk(fullpath, tree) # mutter(" export {%s} kind %s to %s", self.file_id, # self.kind, fullpath) def _put_on_disk(self, fullpath, tree): """Put this entry onto disk at fullpath, from tree tree.""" raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind)) def sorted_children(self): return sorted(self.children.items()) @staticmethod def versionable_kind(kind): return (kind in ('file', 'directory', 'symlink')) def check(self, checker, rev_id, inv, tree): """Check this inventory entry is intact. This is a template method, override _check for kind specific tests. :param checker: Check object providing context for the checks; can be used to find out what parts of the repository have already been checked. :param rev_id: Revision id from which this InventoryEntry was loaded. Not necessarily the last-changed revision for this file. :param inv: Inventory from which the entry was loaded. :param tree: RevisionTree for this entry. """ if self.parent_id is not None: if not inv.has_id(self.parent_id): raise BzrCheckError('missing parent {%s} in inventory for revision {%s}' % (self.parent_id, rev_id)) self._check(checker, rev_id, tree) def _check(self, checker, rev_id, tree): """Check this inventory entry for kind specific errors.""" raise BzrCheckError('unknown entry kind %r in revision {%s}' % (self.kind, rev_id)) def copy(self): """Clone this inventory entry.""" raise NotImplementedError @staticmethod def describe_change(old_entry, new_entry): """Describe the change between old_entry and this. This smells of being an InterInventoryEntry situation, but as its the first one, we're making it a static method for now. An entry with a different parent, or different name is considered to be renamed. Reparenting is an internal detail. Note that renaming the parent does not trigger a rename for the child entry itself. """ # TODO: Perhaps return an object rather than just a string if old_entry is new_entry: # also the case of both being None return 'unchanged' elif old_entry is None: return 'added' elif new_entry is None: return 'removed' text_modified, meta_modified = new_entry.detect_changes(old_entry) if text_modified or meta_modified: modified = True else: modified = False # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here. if old_entry.parent_id != new_entry.parent_id: renamed = True elif old_entry.name != new_entry.name: renamed = True else: renamed = False if renamed and not modified: return InventoryEntry.RENAMED if modified and not renamed: return 'modified' if modified and renamed: return InventoryEntry.MODIFIED_AND_RENAMED return 'unchanged' def __repr__(self): return ("%s(%r, %r, parent_id=%r, revision=%r)" % (self.__class__.__name__, self.file_id, self.name, self.parent_id, self.revision)) def snapshot(self, revision, path, previous_entries, work_tree, commit_builder): """Make a snapshot of this entry which may or may not have changed. This means that all its fields are populated, that it has its text stored in the text store or weave. """ # mutter('new parents of %s are %r', path, previous_entries) self._read_tree_state(path, work_tree) # TODO: Where should we determine whether to reuse a # previous revision id or create a new revision? 20060606 if len(previous_entries) == 1: # cannot be unchanged unless there is only one parent file rev. parent_ie = previous_entries.values()[0] if self._unchanged(parent_ie): # mutter("found unchanged entry") self.revision = parent_ie.revision return "unchanged" return self._snapshot_into_revision(revision, previous_entries, work_tree, commit_builder) def _snapshot_into_revision(self, revision, previous_entries, work_tree, commit_builder): """Record this revision unconditionally into a store. The entry's last-changed revision property (`revision`) is updated to that of the new revision. :param revision: id of the new revision that is being recorded. :returns: String description of the commit (e.g. "merged", "modified"), etc. """ # mutter('new revision {%s} for {%s}', revision, self.file_id) self.revision = revision self._snapshot_text(previous_entries, work_tree, commit_builder) def _snapshot_text(self, file_parents, work_tree, commit_builder): """Record the 'text' of this entry, whatever form that takes. This default implementation simply adds an empty text. """ raise NotImplementedError(self._snapshot_text) def __eq__(self, other): if not isinstance(other, InventoryEntry): return NotImplemented return ((self.file_id == other.file_id) and (self.name == other.name) and (other.symlink_target == self.symlink_target) and (self.text_sha1 == other.text_sha1) and (self.text_size == other.text_size) and (self.text_id == other.text_id) and (self.parent_id == other.parent_id) and (self.kind == other.kind) and (self.revision == other.revision) and (self.executable == other.executable) ) def __ne__(self, other): return not (self == other) def __hash__(self): raise ValueError('not hashable') def _unchanged(self, previous_ie): """Has this entry changed relative to previous_ie. This method should be overridden in child classes. """ compatible = True # different inv parent if previous_ie.parent_id != self.parent_id: compatible = False # renamed elif previous_ie.name != self.name: compatible = False return compatible def _read_tree_state(self, path, work_tree): """Populate fields in the inventory entry from the given tree. Note that this should be modified to be a noop on virtual trees as all entries created there are prepopulated. """ # TODO: Rather than running this manually, we should check the # working sha1 and other expensive properties when they're # first requested, or preload them if they're already known pass # nothing to do by default def _forget_tree_state(self): pass class RootEntry(InventoryEntry): __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind', 'text_id', 'parent_id', 'children', 'executable', 'revision', 'symlink_target'] def _check(self, checker, rev_id, tree): """See InventoryEntry._check""" def __init__(self, file_id): self.file_id = file_id self.children = {} self.kind = 'directory' self.parent_id = None self.name = u'' self.revision = None symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.' ' Please use InventoryDirectory instead.', DeprecationWarning, stacklevel=2) def __eq__(self, other): if not isinstance(other, RootEntry): return NotImplemented return (self.file_id == other.file_id) \ and (self.children == other.children) class InventoryDirectory(InventoryEntry): """A directory in an inventory.""" __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind', 'text_id', 'parent_id', 'children', 'executable', 'revision', 'symlink_target'] def _check(self, checker, rev_id, tree): """See InventoryEntry._check""" if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None: raise BzrCheckError('directory {%s} has text in revision {%s}' % (self.file_id, rev_id)) def copy(self): other = InventoryDirectory(self.file_id, self.name, self.parent_id) other.revision = self.revision # note that children are *not* copied; they're pulled across when # others are added return other def __init__(self, file_id, name, parent_id): super(InventoryDirectory, self).__init__(file_id, name, parent_id) self.children = {} self.kind = 'directory' def kind_character(self): """See InventoryEntry.kind_character.""" return '/' def _put_in_tar(self, item, tree): """See InventoryEntry._put_in_tar.""" item.type = tarfile.DIRTYPE fileobj = None item.name += '/' item.size = 0 item.mode = 0755 return fileobj def _put_on_disk(self, fullpath, tree): """See InventoryEntry._put_on_disk.""" os.mkdir(fullpath) def _snapshot_text(self, file_parents, work_tree, commit_builder): """See InventoryEntry._snapshot_text.""" commit_builder.modified_directory(self.file_id, file_parents) class InventoryFile(InventoryEntry): """A file in an inventory.""" __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind', 'text_id', 'parent_id', 'children', 'executable', 'revision', 'symlink_target'] def _check(self, checker, tree_revision_id, tree): """See InventoryEntry._check""" t = (self.file_id, self.revision) if t in checker.checked_texts: prev_sha = checker.checked_texts[t] if prev_sha != self.text_sha1: raise BzrCheckError('mismatched sha1 on {%s} in {%s}' % (self.file_id, tree_revision_id)) else: checker.repeated_text_cnt += 1 return if self.file_id not in checker.checked_weaves: mutter('check weave {%s}', self.file_id) w = tree.get_weave(self.file_id) # Not passing a progress bar, because it creates a new # progress, which overwrites the current progress, # and doesn't look nice w.check() checker.checked_weaves[self.file_id] = True else: w = tree.get_weave(self.file_id) mutter('check version {%s} of {%s}', tree_revision_id, self.file_id) checker.checked_text_cnt += 1 # We can't check the length, because Weave doesn't store that # information, and the whole point of looking at the weave's # sha1sum is that we don't have to extract the text. if self.text_sha1 != w.get_sha1(self.revision): raise BzrCheckError('text {%s} version {%s} wrong sha1' % (self.file_id, self.revision)) checker.checked_texts[t] = self.text_sha1 def copy(self): other = InventoryFile(self.file_id, self.name, self.parent_id) other.executable = self.executable other.text_id = self.text_id other.text_sha1 = self.text_sha1 other.text_size = self.text_size other.revision = self.revision return other def detect_changes(self, old_entry): """See InventoryEntry.detect_changes.""" assert self.text_sha1 is not None assert old_entry.text_sha1 is not None text_modified = (self.text_sha1 != old_entry.text_sha1) meta_modified = (self.executable != old_entry.executable) return text_modified, meta_modified def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree, output_to, reverse=False): """See InventoryEntry._diff.""" try: from_text = tree.get_file(self.file_id).readlines() if to_entry: to_text = to_tree.get_file(to_entry.file_id).readlines() else: to_text = [] if not reverse: text_diff(from_label, from_text, to_label, to_text, output_to) else: text_diff(to_label, to_text, from_label, from_text, output_to) except errors.BinaryFile: if reverse: label_pair = (to_label, from_label) else: label_pair = (from_label, to_label) print >> output_to, "Binary files %s and %s differ" % label_pair def has_text(self): """See InventoryEntry.has_text.""" return True def __init__(self, file_id, name, parent_id): super(InventoryFile, self).__init__(file_id, name, parent_id) self.kind = 'file' def kind_character(self): """See InventoryEntry.kind_character.""" return '' def _put_in_tar(self, item, tree): """See InventoryEntry._put_in_tar.""" item.type = tarfile.REGTYPE fileobj = tree.get_file(self.file_id) item.size = self.text_size if tree.is_executable(self.file_id): item.mode = 0755 else: item.mode = 0644 return fileobj def _put_on_disk(self, fullpath, tree): """See InventoryEntry._put_on_disk.""" osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb')) if tree.is_executable(self.file_id): os.chmod(fullpath, 0755) def _read_tree_state(self, path, work_tree): """See InventoryEntry._read_tree_state.""" self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path) # FIXME: 20050930 probe for the text size when getting sha1 # in _read_tree_state self.executable = work_tree.is_executable(self.file_id, path=path) def __repr__(self): return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)" % (self.__class__.__name__, self.file_id, self.name, self.parent_id, self.text_sha1, self.text_size)) def _forget_tree_state(self): self.text_sha1 = None def _snapshot_text(self, file_parents, work_tree, commit_builder): """See InventoryEntry._snapshot_text.""" def get_content_byte_lines(): return work_tree.get_file(self.file_id).readlines() self.text_sha1, self.text_size = commit_builder.modified_file_text( self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size) def _unchanged(self, previous_ie): """See InventoryEntry._unchanged.""" compatible = super(InventoryFile, self)._unchanged(previous_ie) if self.text_sha1 != previous_ie.text_sha1: compatible = False else: # FIXME: 20050930 probe for the text size when getting sha1 # in _read_tree_state self.text_size = previous_ie.text_size if self.executable != previous_ie.executable: compatible = False return compatible class InventoryLink(InventoryEntry): """A file in an inventory.""" __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind', 'text_id', 'parent_id', 'children', 'executable', 'revision', 'symlink_target'] def _check(self, checker, rev_id, tree): """See InventoryEntry._check""" if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None: raise BzrCheckError('symlink {%s} has text in revision {%s}' % (self.file_id, rev_id)) if self.symlink_target is None: raise BzrCheckError('symlink {%s} has no target in revision {%s}' % (self.file_id, rev_id)) def copy(self): other = InventoryLink(self.file_id, self.name, self.parent_id) other.symlink_target = self.symlink_target other.revision = self.revision return other def detect_changes(self, old_entry): """See InventoryEntry.detect_changes.""" # FIXME: which _modified field should we use ? RBC 20051003 text_modified = (self.symlink_target != old_entry.symlink_target) if text_modified: mutter(" symlink target changed") meta_modified = False return text_modified, meta_modified def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree, output_to, reverse=False): """See InventoryEntry._diff.""" from_text = self.symlink_target if to_entry is not None: to_text = to_entry.symlink_target if reverse: temp = from_text from_text = to_text to_text = temp print >>output_to, '=== target changed %r => %r' % (from_text, to_text) else: if not reverse: print >>output_to, '=== target was %r' % self.symlink_target else: print >>output_to, '=== target is %r' % self.symlink_target def __init__(self, file_id, name, parent_id): super(InventoryLink, self).__init__(file_id, name, parent_id) self.kind = 'symlink' def kind_character(self): """See InventoryEntry.kind_character.""" return '' def _put_in_tar(self, item, tree): """See InventoryEntry._put_in_tar.""" item.type = tarfile.SYMTYPE fileobj = None item.size = 0 item.mode = 0755 item.linkname = self.symlink_target return fileobj def _put_on_disk(self, fullpath, tree): """See InventoryEntry._put_on_disk.""" try: os.symlink(self.symlink_target, fullpath) except OSError,e: raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e)) def _read_tree_state(self, path, work_tree): """See InventoryEntry._read_tree_state.""" self.symlink_target = work_tree.get_symlink_target(self.file_id) def _forget_tree_state(self): self.symlink_target = None def _unchanged(self, previous_ie): """See InventoryEntry._unchanged.""" compatible = super(InventoryLink, self)._unchanged(previous_ie) if self.symlink_target != previous_ie.symlink_target: compatible = False return compatible def _snapshot_text(self, file_parents, work_tree, commit_builder): """See InventoryEntry._snapshot_text.""" commit_builder.modified_link( self.file_id, file_parents, self.symlink_target) class Inventory(object): """Inventory of versioned files in a tree. This describes which file_id is present at each point in the tree, and possibly the SHA-1 or other information about the file. Entries can be looked up either by path or by file_id. The inventory represents a typical unix file tree, with directories containing files and subdirectories. We never store the full path to a file, because renaming a directory implicitly moves all of its contents. This class internally maintains a lookup tree that allows the children under a directory to be returned quickly. InventoryEntry objects must not be modified after they are inserted, other than through the Inventory API. >>> inv = Inventory() >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID)) InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None) >>> inv['123-123'].name 'hello.c' May be treated as an iterator or set to look up file ids: >>> bool(inv.path2id('hello.c')) True >>> '123-123' in inv True May also look up by name: >>> [x[0] for x in inv.iter_entries()] ['', u'hello.c'] >>> inv = Inventory('TREE_ROOT-12345678-12345678') >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID)) Traceback (most recent call last): BzrError: parent_id {TREE_ROOT} not in inventory >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678')) InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None) """ def __init__(self, root_id=ROOT_ID, revision_id=None): """Create or read an inventory. If a working directory is specified, the inventory is read from there. If the file is specified, read from that. If not, the inventory is created empty. The inventory is created with a default root directory, with an id of None. """ if root_id is not None: self._set_root(InventoryDirectory(root_id, '', None)) else: self.root = None self._byid = {} self.revision_id = revision_id def _set_root(self, ie): self.root = ie self._byid = {self.root.file_id: self.root} def copy(self): # TODO: jam 20051218 Should copy also copy the revision_id? entries = self.iter_entries() other = Inventory(entries.next()[1].file_id) # copy recursively so we know directories will be added before # their children. There are more efficient ways than this... for path, entry in entries(): other.add(entry.copy()) return other def __iter__(self): return iter(self._byid) def __len__(self): """Returns number of entries.""" return len(self._byid) def iter_entries(self, from_dir=None): """Return (path, entry) pairs, in order by name.""" if from_dir is None: if self.root is None: return from_dir = self.root yield '', self.root elif isinstance(from_dir, basestring): from_dir = self._byid[from_dir] # unrolling the recursive called changed the time from # 440ms/663ms (inline/total) to 116ms/116ms children = from_dir.children.items() children.sort() children = collections.deque(children) stack = [(u'', children)] while stack: from_dir_relpath, children = stack[-1] while children: name, ie = children.popleft() # we know that from_dir_relpath never ends in a slash # and 'f' doesn't begin with one, we can do a string op, rather # than the checks of pathjoin(), though this means that all paths # start with a slash path = from_dir_relpath + '/' + name yield path[1:], ie if ie.kind != 'directory': continue # But do this child first new_children = ie.children.items() new_children.sort() new_children = collections.deque(new_children) stack.append((path, new_children)) # Break out of inner loop, so that we start outer loop with child break else: # if we finished all children, pop it off the stack stack.pop() def iter_entries_by_dir(self, from_dir=None): """Iterate over the entries in a directory first order. This returns all entries for a directory before returning the entries for children of a directory. This is not lexicographically sorted order, and is a hybrid between depth-first and breadth-first. :return: This yields (path, entry) pairs """ # TODO? Perhaps this should return the from_dir so that the root is # yielded? or maybe an option? if from_dir is None: if self.root is None: return from_dir = self.root yield '', self.root elif isinstance(from_dir, basestring): from_dir = self._byid[from_dir] stack = [(u'', from_dir)] while stack: cur_relpath, cur_dir = stack.pop() child_dirs = [] for child_name, child_ie in sorted(cur_dir.children.iteritems()): child_relpath = cur_relpath + child_name yield child_relpath, child_ie if child_ie.kind == 'directory': child_dirs.append((child_relpath+'/', child_ie)) stack.extend(reversed(child_dirs)) def entries(self): """Return list of (path, ie) for all entries except the root. This may be faster than iter_entries. """ accum = [] def descend(dir_ie, dir_path): kids = dir_ie.children.items() kids.sort() for name, ie in kids: child_path = osutils.pathjoin(dir_path, name) accum.append((child_path, ie)) if ie.kind == 'directory': descend(ie, child_path) descend(self.root, u'') return accum def directories(self): """Return (path, entry) pairs for all directories, including the root. """ accum = [] def descend(parent_ie, parent_path): accum.append((parent_path, parent_ie)) kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory'] kids.sort() for name, child_ie in kids: child_path = osutils.pathjoin(parent_path, name) descend(child_ie, child_path) descend(self.root, u'') return accum def __contains__(self, file_id): """True if this entry contains a file with given id. >>> inv = Inventory() >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID)) InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None) >>> '123' in inv True >>> '456' in inv False """ return (file_id in self._byid) def __getitem__(self, file_id): """Return the entry for given file_id. >>> inv = Inventory() >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID)) InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None) >>> inv['123123'].name 'hello.c' """ try: return self._byid[file_id] except KeyError: if file_id is None: raise BzrError("can't look up file_id None") else: raise BzrError("file_id {%s} not in inventory" % file_id) def get_file_kind(self, file_id): return self._byid[file_id].kind def get_child(self, parent_id, filename): return self[parent_id].children.get(filename) def add(self, entry): """Add entry to inventory. To add a file to a branch ready to be committed, use Branch.add, which calls this. Returns the new entry object. """ if entry.file_id in self._byid: raise BzrError("inventory already contains entry with id {%s}" % entry.file_id) if entry.parent_id is None: assert self.root is None and len(self._byid) == 0 self._set_root(entry) return entry try: parent = self._byid[entry.parent_id] except KeyError: raise BzrError("parent_id {%s} not in inventory" % entry.parent_id) if entry.name in parent.children: raise BzrError("%s is already versioned" % osutils.pathjoin(self.id2path(parent.file_id), entry.name)) self._byid[entry.file_id] = entry parent.children[entry.name] = entry return entry def add_path(self, relpath, kind, file_id=None, parent_id=None): """Add entry from a path. The immediate parent must already be versioned. Returns the new entry object.""" parts = osutils.splitpath(relpath) if len(parts) == 0: if file_id is None: file_id = bzrlib.workingtree.gen_root_id() self.root = InventoryDirectory(file_id, '', None) self._byid = {self.root.file_id: self.root} return else: parent_path = parts[:-1] parent_id = self.path2id(parent_path) if parent_id is None: raise errors.NotVersionedError(path=parent_path) ie = make_entry(kind, parts[-1], parent_id, file_id) return self.add(ie) def __delitem__(self, file_id): """Remove entry by id. >>> inv = Inventory() >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID)) InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None) >>> '123' in inv True >>> del inv['123'] >>> '123' in inv False """ ie = self[file_id] assert ie.parent_id is None or \ self[ie.parent_id].children[ie.name] == ie del self._byid[file_id] if ie.parent_id is not None: del self[ie.parent_id].children[ie.name] def __eq__(self, other): """Compare two sets by comparing their contents. >>> i1 = Inventory() >>> i2 = Inventory() >>> i1 == i2 True >>> i1.add(InventoryFile('123', 'foo', ROOT_ID)) InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None) >>> i1 == i2 False >>> i2.add(InventoryFile('123', 'foo', ROOT_ID)) InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None) >>> i1 == i2 True """ if not isinstance(other, Inventory): return NotImplemented return self._byid == other._byid def __ne__(self, other): return not self.__eq__(other) def __hash__(self): raise ValueError('not hashable') def _iter_file_id_parents(self, file_id): """Yield the parents of file_id up to the root.""" while file_id is not None: try: ie = self._byid[file_id] except KeyError: raise BzrError("file_id {%s} not found in inventory" % file_id) yield ie file_id = ie.parent_id def get_idpath(self, file_id): """Return a list of file_ids for the path to an entry. The list contains one element for each directory followed by the id of the file itself. So the length of the returned list is equal to the depth of the file in the tree, counting the root directory as depth 1. """ p = [] for parent in self._iter_file_id_parents(file_id): p.insert(0, parent.file_id) return p def id2path(self, file_id): """Return as a string the path to file_id. >>> i = Inventory() >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID)) >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id')) >>> print i.id2path('foo-id') src/foo.c """ # get all names, skipping root return '/'.join(reversed( [parent.name for parent in self._iter_file_id_parents(file_id)][:-1])) def path2id(self, name): """Walk down through directories to return entry of last component. names may be either a list of path components, or a single string, in which case it is automatically split. This returns the entry of the last component in the path, which may be either a file or a directory. Returns None IFF the path is not found. """ if isinstance(name, basestring): name = osutils.splitpath(name) # mutter("lookup path %r" % name) parent = self.root if parent is None: return None for f in name: try: cie = parent.children[f] assert cie.name == f assert cie.parent_id == parent.file_id parent = cie except KeyError: # or raise an error? return None return parent.file_id def has_filename(self, names): return bool(self.path2id(names)) def has_id(self, file_id): return (file_id in self._byid) def remove_recursive_id(self, file_id): """Remove file_id, and children, from the inventory. :param file_id: A file_id to remove. """ to_find_delete = [self._byid[file_id]] to_delete = [] while to_find_delete: ie = to_find_delete.pop() to_delete.append(ie.file_id) if ie.kind == 'directory': to_find_delete.extend(ie.children.values()) for file_id in reversed(to_delete): ie = self[file_id] del self._byid[file_id] if ie.parent_id is not None: del self[ie.parent_id].children[ie.name] def rename(self, file_id, new_parent_id, new_name): """Move a file within the inventory. This can change either the name, or the parent, or both. This does not move the working file.""" if not is_valid_name(new_name): raise BzrError("not an acceptable filename: %r" % new_name) new_parent = self._byid[new_parent_id] if new_name in new_parent.children: raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id))) new_parent_idpath = self.get_idpath(new_parent_id) if file_id in new_parent_idpath: raise BzrError("cannot move directory %r into a subdirectory of itself, %r" % (self.id2path(file_id), self.id2path(new_parent_id))) file_ie = self._byid[file_id] old_parent = self._byid[file_ie.parent_id] # TODO: Don't leave things messed up if this fails del old_parent.children[file_ie.name] new_parent.children[new_name] = file_ie file_ie.name = new_name file_ie.parent_id = new_parent_id def is_root(self, file_id): return self.root is not None and file_id == self.root.file_id def make_entry(kind, name, parent_id, file_id=None): """Create an inventory entry. :param kind: the type of inventory entry to create. :param name: the basename of the entry. :param parent_id: the parent_id of the entry. :param file_id: the file_id to use. if None, one will be created. """ if file_id is None: file_id = bzrlib.workingtree.gen_file_id(name) norm_name, can_access = osutils.normalized_filename(name) if norm_name != name: if can_access: name = norm_name else: # TODO: jam 20060701 This would probably be more useful # if the error was raised with the full path raise errors.InvalidNormalization(name) if kind == 'directory': return InventoryDirectory(file_id, name, parent_id) elif kind == 'file': return InventoryFile(file_id, name, parent_id) elif kind == 'symlink': return InventoryLink(file_id, name, parent_id) else: raise BzrError("unknown kind %r" % kind) _NAME_RE = None def is_valid_name(name): global _NAME_RE if _NAME_RE is None: _NAME_RE = re.compile(r'^[^/\\]+$') return bool(_NAME_RE.match(name))