/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Vincent Ladeuil
  • Date: 2012-01-18 14:09:19 UTC
  • mto: This revision was merged to the branch mainline in revision 6468.
  • Revision ID: v.ladeuil+lp@free.fr-20120118140919-rlvdrhpc0nq1lbwi
Change set/remove to require a lock for the branch config files.

This means that tests (or any plugin for that matter) do not requires an
explicit lock on the branch anymore to change a single option. This also
means the optimisation becomes "opt-in" and as such won't be as
spectacular as it may be and/or harder to get right (nothing fails
anymore).

This reduces the diff by ~300 lines.

Code/tests that were updating more than one config option is still taking
a lock to at least avoid some IOs and demonstrate the benefits through
the decreased number of hpss calls.

The duplication between BranchStack and BranchOnlyStack will be removed
once the same sharing is in place for local config files, at which point
the Stack class itself may be able to host the changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Helper functions for adding files to working trees."""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
import sys
 
22
import os
 
23
 
 
24
from bzrlib import (
 
25
    osutils,
 
26
    ui, 
 
27
    )
 
28
from bzrlib.i18n import gettext
 
29
 
 
30
class AddAction(object):
 
31
    """A class which defines what action to take when adding a file."""
 
32
 
 
33
    def __init__(self, to_file=None, should_print=None):
 
34
        """Initialize an action which prints added files to an output stream.
 
35
 
 
36
        :param to_file: The stream to write into. This is expected to take
 
37
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
 
38
        :param should_print: If False, printing will be suppressed.
 
39
        """
 
40
        self._to_file = to_file
 
41
        if to_file is None:
 
42
            self._to_file = sys.stdout
 
43
        self.should_print = False
 
44
        if should_print is not None:
 
45
            self.should_print = should_print
 
46
 
 
47
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
 
48
        """Add path to inventory.
 
49
 
 
50
        The default action does nothing.
 
51
 
 
52
        :param inv: The inventory we are working with.
 
53
        :param path: The FastPath being added
 
54
        :param kind: The kind of the object being added.
 
55
        """
 
56
        if self.should_print:
 
57
            self._to_file.write('adding %s\n' % _quote(path))
 
58
        return None
 
59
 
 
60
    def skip_file(self, tree, path, kind, stat_value = None):
 
61
        """Test whether the given file should be skipped or not.
 
62
        
 
63
        The default action never skips. Note this is only called during
 
64
        recursive adds
 
65
        
 
66
        :param tree: The tree we are working in
 
67
        :param path: The path being added
 
68
        :param kind: The kind of object being added.
 
69
        :param stat: Stat result for this file, if available already
 
70
        :return bool. True if the file should be skipped (not added)
 
71
        """
 
72
        return False
 
73
 
 
74
 
 
75
class AddWithSkipLargeAction(AddAction):
 
76
    """A class that can decide to skip a file if it's considered too large"""
 
77
 
 
78
    _maxSize = None
 
79
 
 
80
    def skip_file(self, tree, path, kind, stat_value = None):
 
81
        if kind != 'file':
 
82
            return False
 
83
        opt_name = 'add.maximum_file_size'
 
84
        if self._maxSize is None:
 
85
            # FIXME: We use the branch config as there is no tree config
 
86
            # -- vila 2011-12-16
 
87
            config = tree.branch.get_config_stack()
 
88
            self._maxSize = config.get(opt_name)
 
89
        if stat_value is None:
 
90
            file_size = os.path.getsize(path);
 
91
        else:
 
92
            file_size = stat_value.st_size;
 
93
        if self._maxSize > 0 and file_size > self._maxSize:
 
94
            ui.ui_factory.show_warning(gettext(
 
95
                "skipping {0} (larger than {1} of {2} bytes)").format(
 
96
                path, opt_name,  self._maxSize))
 
97
            return True
 
98
        return False
 
99
 
 
100
 
 
101
class AddFromBaseAction(AddAction):
 
102
    """This class will try to extract file ids from another tree."""
 
103
 
 
104
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
 
105
        super(AddFromBaseAction, self).__init__(to_file=to_file,
 
106
                                                should_print=should_print)
 
107
        self.base_tree = base_tree
 
108
        self.base_path = base_path
 
109
 
 
110
    def __call__(self, inv, parent_ie, path, kind):
 
111
        # Place the parent call
 
112
        # Now check to see if we can extract an id for this file
 
113
        file_id, base_path = self._get_base_file_id(path, parent_ie)
 
114
        if file_id is not None:
 
115
            if self.should_print:
 
116
                self._to_file.write('adding %s w/ file id from %s\n'
 
117
                                    % (path, base_path))
 
118
        else:
 
119
            # we aren't doing anything special, so let the default
 
120
            # reporter happen
 
121
            file_id = super(AddFromBaseAction, self).__call__(
 
122
                        inv, parent_ie, path, kind)
 
123
        return file_id
 
124
 
 
125
    def _get_base_file_id(self, path, parent_ie):
 
126
        """Look for a file id in the base branch.
 
127
 
 
128
        First, if the base tree has the parent directory,
 
129
        we look for a file with the same name in that directory.
 
130
        Else, we look for an entry in the base tree with the same path.
 
131
        """
 
132
 
 
133
        if self.base_tree.has_id(parent_ie.file_id):
 
134
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
 
135
            base_child_ie = base_parent_ie.children.get(
 
136
                osutils.basename(path))
 
137
            if base_child_ie is not None:
 
138
                return (base_child_ie.file_id,
 
139
                        self.base_tree.id2path(base_child_ie.file_id))
 
140
        full_base_path = osutils.pathjoin(self.base_path, path)
 
141
        # This may return None, but it is our last attempt
 
142
        return self.base_tree.path2id(full_base_path), full_base_path