/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: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
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
 
import sys
20
 
import os
21
 
 
22
 
from . import (
23
 
    errors,
24
 
    osutils,
25
 
    ui,
26
 
    )
27
 
from .i18n import gettext
28
 
 
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
 
            config = tree.get_config_stack()
86
 
            self._maxSize = config.get(opt_name)
87
 
        if stat_value is None:
88
 
            file_size = os.path.getsize(path)
89
 
        else:
90
 
            file_size = stat_value.st_size
91
 
        if self._maxSize > 0 and file_size > self._maxSize:
92
 
            ui.ui_factory.show_warning(gettext(
93
 
                "skipping {0} (larger than {1} of {2} bytes)").format(
94
 
                path, opt_name, self._maxSize))
95
 
            return True
96
 
        return False
97
 
 
98
 
 
99
 
class AddFromBaseAction(AddAction):
100
 
    """This class will try to extract file ids from another tree."""
101
 
 
102
 
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
103
 
        super(AddFromBaseAction, self).__init__(to_file=to_file,
104
 
                                                should_print=should_print)
105
 
        self.base_tree = base_tree
106
 
        self.base_path = base_path
107
 
 
108
 
    def __call__(self, inv, parent_ie, path, kind):
109
 
        # Place the parent call
110
 
        # Now check to see if we can extract an id for this file
111
 
        file_id, base_path = self._get_base_file_id(path, parent_ie)
112
 
        if file_id is not None:
113
 
            if self.should_print:
114
 
                self._to_file.write('adding %s w/ file id from %s\n'
115
 
                                    % (path, base_path))
116
 
        else:
117
 
            # we aren't doing anything special, so let the default
118
 
            # reporter happen
119
 
            file_id = super(AddFromBaseAction, self).__call__(
120
 
                inv, parent_ie, path, kind)
121
 
        return file_id
122
 
 
123
 
    def _get_base_file_id(self, path, parent_ie):
124
 
        """Look for a file id in the base branch.
125
 
 
126
 
        First, if the base tree has the parent directory,
127
 
        we look for a file with the same name in that directory.
128
 
        Else, we look for an entry in the base tree with the same path.
129
 
        """
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from os.path import dirname
 
18
 
 
19
import bzrlib.errors as errors
 
20
from bzrlib.inventory import InventoryEntry
 
21
from bzrlib.trace import mutter, note, warning
 
22
from bzrlib.errors import NotBranchError
 
23
from bzrlib.branch import is_control_file
 
24
import bzrlib.osutils
 
25
from bzrlib.workingtree import WorkingTree
 
26
 
 
27
def glob_expand_for_win32(file_list):
 
28
    if not file_list:
 
29
        return
 
30
    import glob
 
31
    expanded_file_list = []
 
32
    for possible_glob in file_list:
 
33
        glob_files = glob.glob(possible_glob)
 
34
       
 
35
        if glob_files == []:
 
36
            # special case to let the normal code path handle
 
37
            # files that do not exists
 
38
            expanded_file_list.append(possible_glob)
 
39
        else:
 
40
            expanded_file_list += glob_files
 
41
    return expanded_file_list
 
42
 
 
43
 
 
44
def _prepare_file_list(file_list):
 
45
    """Prepare a file list for use by smart_add_*."""
 
46
    import sys
 
47
    if sys.platform == 'win32':
 
48
        file_list = glob_expand_for_win32(file_list)
 
49
    if not file_list:
 
50
        file_list = [u'.']
 
51
    file_list = list(file_list)
 
52
    return file_list
 
53
 
 
54
 
 
55
def add_action_null(inv, path, kind):
 
56
    """Absorb add actions and do nothing."""
 
57
    pass
 
58
 
 
59
def add_action_print(inv, path, kind):
 
60
    """Print a line to stdout for each file that would be added."""
 
61
    print "added", bzrlib.osutils.quotefn(path)
 
62
 
 
63
def add_action_add(inv, path, kind):
 
64
    """Add each file to the given inventory. Produce no output."""
 
65
    entry = inv.add_path(path, kind=kind)
 
66
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
 
67
 
 
68
def add_action_add_and_print(inv, path, kind):
 
69
    """Add each file to the given inventory, and print a line to stdout."""
 
70
    add_action_add(inv, path, kind)
 
71
    add_action_print(inv, path, kind)
 
72
 
 
73
 
 
74
def smart_add(file_list, recurse=True, action=add_action_add):
 
75
    """Add files to version, optionally recursing into directories.
 
76
 
 
77
    This is designed more towards DWIM for humans than API simplicity.
 
78
    For the specific behaviour see the help for cmd_add().
 
79
 
 
80
    Returns the number of files added.
 
81
    """
 
82
    file_list = _prepare_file_list(file_list)
 
83
    tree = WorkingTree.open_containing(file_list[0])[0]
 
84
    return smart_add_tree(tree, file_list, recurse, action)
 
85
 
 
86
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
 
87
    """Add files to version, optionally recursing into directories.
 
88
 
 
89
    This is designed more towards DWIM for humans than API simplicity.
 
90
    For the specific behaviour see the help for cmd_add().
 
91
 
 
92
    This calls reporter with each (path, kind, file_id) of added files.
 
93
 
 
94
    Returns the number of files added.
 
95
    """
 
96
    import os, errno
 
97
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
98
    assert isinstance(recurse, bool)
 
99
 
 
100
    file_list = _prepare_file_list(file_list)
 
101
    user_list = file_list[:]
 
102
    inv = tree.read_working_inventory()
 
103
    added = []
 
104
    ignored = {}
 
105
 
 
106
    for f in file_list:
 
107
        rf = tree.relpath(f)
 
108
        af = tree.abspath(rf)
 
109
 
130
110
        try:
131
 
            parent_path = self.base_tree.id2path(parent_ie.file_id)
132
 
        except errors.NoSuchId:
133
 
            pass
134
 
        else:
135
 
            base_path = osutils.pathjoin(parent_path, osutils.basename(path))
136
 
            base_id = self.base_tree.path2id(base_path)
137
 
            if base_id is not None:
138
 
                return (base_id, base_path)
139
 
        full_base_path = osutils.pathjoin(self.base_path, path)
140
 
        # This may return None, but it is our last attempt
141
 
        return self.base_tree.path2id(full_base_path), full_base_path
 
111
            kind = bzrlib.osutils.file_kind(af)
 
112
        except OSError, e:
 
113
            if hasattr(e, 'errno') and e.errno == errno.ENOENT:
 
114
                raise errors.NoSuchFile(rf)
 
115
            raise
 
116
 
 
117
        if not InventoryEntry.versionable_kind(kind):
 
118
            if f in user_list:
 
119
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
 
120
            else:
 
121
                warning("skipping %s (can't add file of kind '%s')", f, kind)
 
122
                continue
 
123
 
 
124
        mutter("smart add of %r, abs=%r", f, af)
 
125
        
 
126
        if is_control_file(af):
 
127
            raise ForbiddenFileError('cannot add control file %s' % f)
 
128
            
 
129
        versioned = (inv.path2id(rf) != None)
 
130
 
 
131
        if kind == 'directory':
 
132
            try:
 
133
                sub_branch = WorkingTree(af)
 
134
                sub_tree = True
 
135
            except NotBranchError:
 
136
                sub_tree = False
 
137
            except errors.UnsupportedFormatError:
 
138
                sub_tree = True
 
139
        else:
 
140
            sub_tree = False
 
141
 
 
142
        if rf == '':
 
143
            mutter("tree root doesn't need to be added")
 
144
            sub_tree = False
 
145
        elif versioned:
 
146
            mutter("%r is already versioned", f)
 
147
        elif sub_tree:
 
148
            mutter("%r is a bzr tree", f)
 
149
        else:
 
150
            added.extend(__add_one(tree, inv, rf, kind, action))
 
151
 
 
152
        if kind == 'directory' and recurse and not sub_tree:
 
153
            for subf in os.listdir(af):
 
154
                subp = os.path.join(rf, subf)
 
155
                if subf == bzrlib.BZRDIR:
 
156
                    mutter("skip control directory %r", subp)
 
157
                else:
 
158
                    ignore_glob = tree.is_ignored(subp)
 
159
                    if ignore_glob is not None:
 
160
                        mutter("skip ignored sub-file %r", subp)
 
161
                        if ignore_glob not in ignored:
 
162
                            ignored[ignore_glob] = []
 
163
                        ignored[ignore_glob].append(subp)
 
164
                    else:
 
165
                        mutter("queue to add sub-file %r", subp)
 
166
                        file_list.append(tree.abspath(subp))
 
167
 
 
168
 
 
169
    mutter('added %d entries', len(added))
 
170
    
 
171
    if len(added) > 0:
 
172
        tree._write_inventory(inv)
 
173
 
 
174
    return added, ignored
 
175
 
 
176
def __add_one(tree, inv, path, kind, action):
 
177
    """Add a file or directory, automatically add unversioned parents."""
 
178
 
 
179
    # Nothing to do if path is already versioned.
 
180
    # This is safe from infinite recursion because the tree root is
 
181
    # always versioned.
 
182
    if inv.path2id(path) != None:
 
183
        return []
 
184
 
 
185
    # add parent
 
186
    added = __add_one(tree, inv, dirname(path), 'directory', action)
 
187
    action(inv, path, kind)
 
188
 
 
189
    return added + [path]