~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/mutabletree.py

  • Committer: Martin
  • Date: 2011-04-15 21:22:57 UTC
  • mto: This revision was merged to the branch mainline in revision 5797.
  • Revision ID: gzlist@googlemail.com-20110415212257-jgtovwwp4be7egd9
Add release notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
33
33
    osutils,
34
34
    revisiontree,
35
35
    inventory,
36
 
    symbol_versioning,
37
36
    trace,
38
37
    tree,
39
38
    )
80
79
        # used on media which doesn't differentiate the case of names.
81
80
        self.case_sensitive = True
82
81
 
 
82
    def is_control_filename(self, filename):
 
83
        """True if filename is the name of a control file in this tree.
 
84
 
 
85
        :param filename: A filename within the tree. This is a relative path
 
86
        from the root of this tree.
 
87
 
 
88
        This is true IF and ONLY IF the filename is part of the meta data
 
89
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
90
        on disk will not be a control file for this tree.
 
91
        """
 
92
        raise NotImplementedError(self.is_control_filename)
 
93
 
83
94
    @needs_tree_write_lock
84
95
    def add(self, files, ids=None, kinds=None):
85
96
        """Add paths to the set of versioned paths.
149
160
        if sub_tree_id == self.get_root_id():
150
161
            raise errors.BadReferenceTarget(self, sub_tree,
151
162
                                     'Trees have the same root id.')
152
 
        if sub_tree_id in self.inventory:
 
163
        if sub_tree_id in self:
153
164
            raise errors.BadReferenceTarget(self, sub_tree,
154
165
                                            'Root id already present in tree')
155
166
        self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
164
175
        """
165
176
        raise NotImplementedError(self._add)
166
177
 
167
 
    @needs_tree_write_lock
168
178
    def apply_inventory_delta(self, changes):
169
179
        """Apply changes to the inventory as an atomic operation.
170
180
 
173
183
        :return None:
174
184
        :seealso Inventory.apply_delta: For details on the changes parameter.
175
185
        """
176
 
        self.flush()
177
 
        inv = self.inventory
178
 
        inv.apply_delta(changes)
179
 
        self._write_inventory(inv)
 
186
        raise NotImplementedError(self.apply_inventory_delta)
180
187
 
181
188
    @needs_write_lock
182
189
    def commit(self, message=None, revprops=None, *args,
334
341
        :return: None
335
342
        """
336
343
 
337
 
    def _fix_case_of_inventory_path(self, path):
338
 
        """If our tree isn't case sensitive, return the canonical path"""
339
 
        if not self.case_sensitive:
340
 
            path = self.get_canonical_inventory_path(path)
341
 
        return path
342
 
 
343
344
    @needs_write_lock
344
345
    def put_file_bytes_non_atomic(self, file_id, bytes):
345
346
        """Update the content of a file in the tree.
369
370
        """
370
371
        raise NotImplementedError(self.set_parent_trees)
371
372
 
 
373
    def smart_add(self, file_list, recurse=True, action=None, save=True):
 
374
        """Version file_list, optionally recursing into directories.
 
375
 
 
376
        This is designed more towards DWIM for humans than API clarity.
 
377
        For the specific behaviour see the help for cmd_add().
 
378
 
 
379
        :param file_list: List of zero or more paths.  *NB: these are 
 
380
            interpreted relative to the process cwd, not relative to the 
 
381
            tree.*  (Add and most other tree methods use tree-relative
 
382
            paths.)
 
383
        :param action: A reporter to be called with the inventory, parent_ie,
 
384
            path and kind of the path being added. It may return a file_id if
 
385
            a specific one should be used.
 
386
        :param save: Save the inventory after completing the adds. If False
 
387
            this provides dry-run functionality by doing the add and not saving
 
388
            the inventory.
 
389
        :return: A tuple - files_added, ignored_files. files_added is the count
 
390
            of added files, and ignored_files is a dict mapping files that were
 
391
            ignored to the rule that caused them to be ignored.
 
392
        """
 
393
        raise NotImplementedError(self.smart_add)
 
394
 
 
395
    def update_basis_by_delta(self, new_revid, delta):
 
396
        """Update the parents of this tree after a commit.
 
397
 
 
398
        This gives the tree one parent, with revision id new_revid. The
 
399
        inventory delta is applied to the current basis tree to generate the
 
400
        inventory for the parent new_revid, and all other parent trees are
 
401
        discarded.
 
402
 
 
403
        All the changes in the delta should be changes synchronising the basis
 
404
        tree with some or all of the working tree, with a change to a directory
 
405
        requiring that its contents have been recursively included. That is,
 
406
        this is not a general purpose tree modification routine, but a helper
 
407
        for commit which is not required to handle situations that do not arise
 
408
        outside of commit.
 
409
 
 
410
        See the inventory developers documentation for the theory behind
 
411
        inventory deltas.
 
412
 
 
413
        :param new_revid: The new revision id for the trees parent.
 
414
        :param delta: An inventory delta (see apply_inventory_delta) describing
 
415
            the changes from the current left most parent revision to new_revid.
 
416
        """
 
417
        raise NotImplementedError(self.update_basis_by_delta)
 
418
 
 
419
 
 
420
class MutableInventoryTree(MutableTree,tree.InventoryTree):
 
421
 
 
422
    @needs_tree_write_lock
 
423
    def apply_inventory_delta(self, changes):
 
424
        """Apply changes to the inventory as an atomic operation.
 
425
 
 
426
        :param changes: An inventory delta to apply to the working tree's
 
427
            inventory.
 
428
        :return None:
 
429
        :seealso Inventory.apply_delta: For details on the changes parameter.
 
430
        """
 
431
        self.flush()
 
432
        inv = self.inventory
 
433
        inv.apply_delta(changes)
 
434
        self._write_inventory(inv)
 
435
 
 
436
    def _fix_case_of_inventory_path(self, path):
 
437
        """If our tree isn't case sensitive, return the canonical path"""
 
438
        if not self.case_sensitive:
 
439
            path = self.get_canonical_inventory_path(path)
 
440
        return path
 
441
 
372
442
    @needs_tree_write_lock
373
443
    def smart_add(self, file_list, recurse=True, action=None, save=True):
374
444
        """Version file_list, optionally recursing into directories.
418
488
 
419
489
        # expand any symlinks in the directory part, while leaving the
420
490
        # filename alone
421
 
        file_list = map(osutils.normalizepath, file_list)
 
491
        # only expanding if symlinks are supported avoids windows path bugs
 
492
        if osutils.has_symlinks():
 
493
            file_list = map(osutils.normalizepath, file_list)
422
494
 
423
495
        # validate user file paths and convert all paths to tree
424
496
        # relative : it's cheaper to make a tree relative path an abspath
545
617
                        this_ie = None
546
618
                    else:
547
619
                        this_ie = inv[this_id]
 
620
                        # Same as in _add_one below, if the inventory doesn't
 
621
                        # think this is a directory, update the inventory
 
622
                        if this_ie.kind != 'directory':
 
623
                            this_ie = inventory.make_entry('directory',
 
624
                                this_ie.name, this_ie.parent_id, this_id)
 
625
                            del inv[this_id]
 
626
                            inv.add(this_ie)
548
627
 
549
628
                for subf in sorted(os.listdir(abspath)):
550
629
                    # here we could use TreeDirectory rather than
622
701
        self.set_parent_trees([(new_revid, rev_tree)])
623
702
 
624
703
 
 
704
 
 
705
 
625
706
class MutableTreeHooks(hooks.Hooks):
626
707
    """A dictionary mapping a hook name to a list of callables for mutabletree
627
708
    hooks.
631
712
        """Create the default hooks.
632
713
 
633
714
        """
634
 
        hooks.Hooks.__init__(self)
635
 
        self.create_hook(hooks.HookPoint('start_commit',
 
715
        hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
 
716
        self.add_hook('start_commit',
636
717
            "Called before a commit is performed on a tree. The start commit "
637
718
            "hook is able to change the tree before the commit takes place. "
638
719
            "start_commit is called with the bzrlib.mutabletree.MutableTree "
639
 
            "that the commit is being performed on.", (1, 4), None))
640
 
        self.create_hook(hooks.HookPoint('post_commit',
 
720
            "that the commit is being performed on.", (1, 4))
 
721
        self.add_hook('post_commit',
641
722
            "Called after a commit is performed on a tree. The hook is "
642
723
            "called with a bzrlib.mutabletree.PostCommitHookParams object. "
643
724
            "The mutable tree the commit was performed on is available via "
644
 
            "the mutable_tree attribute of that object.", (2, 0), None))
 
725
            "the mutable_tree attribute of that object.", (2, 0))
645
726
 
646
727
 
647
728
# install the default hooks into the MutableTree class.