← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Martin Pool
  • Date: 2005-09-15 08:37:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050915083741-70d7550b97c7b580
- some updates for fetch/update function

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 bzrlib import (
23
 
    osutils,
24
 
    ui, 
25
 
    )
26
 
from bzrlib.i18n import gettext
27
 
 
28
 
class AddAction(object):
29
 
    """A class which defines what action to take when adding a file."""
30
 
 
31
 
    def __init__(self, to_file=None, should_print=None):
32
 
        """Initialize an action which prints added files to an output stream.
33
 
 
34
 
        :param to_file: The stream to write into. This is expected to take
35
 
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
36
 
        :param should_print: If False, printing will be suppressed.
37
 
        """
38
 
        self._to_file = to_file
39
 
        if to_file is None:
40
 
            self._to_file = sys.stdout
41
 
        self.should_print = False
42
 
        if should_print is not None:
43
 
            self.should_print = should_print
44
 
 
45
 
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
46
 
        """Add path to inventory.
47
 
 
48
 
        The default action does nothing.
49
 
 
50
 
        :param inv: The inventory we are working with.
51
 
        :param path: The FastPath being added
52
 
        :param kind: The kind of the object being added.
53
 
        """
54
 
        if self.should_print:
55
 
            self._to_file.write('adding %s\n' % _quote(path))
56
 
        return None
57
 
 
58
 
    def skip_file(self, tree, path, kind, stat_value = None):
59
 
        """Test whether the given file should be skipped or not.
60
 
        
61
 
        The default action never skips. Note this is only called during
62
 
        recursive adds
63
 
        
64
 
        :param tree: The tree we are working in
65
 
        :param path: The path being added
66
 
        :param kind: The kind of object being added.
67
 
        :param stat: Stat result for this file, if available already
68
 
        :return bool. True if the file should be skipped (not added)
69
 
        """
70
 
        return False
71
 
 
72
 
 
73
 
class AddWithSkipLargeAction(AddAction):
74
 
    """A class that can decide to skip a file if it's considered too large"""
75
 
 
76
 
    # default 20 MB
77
 
    _DEFAULT_MAX_FILE_SIZE = 20000000
78
 
    _optionName = 'add.maximum_file_size'
79
 
    _maxSize = None
80
 
 
81
 
    def skip_file(self, tree, path, kind, stat_value = None):
82
 
        if kind != 'file':
83
 
            return False            
84
 
        if self._maxSize is None:
85
 
            config = tree.branch.get_config()
86
 
            self._maxSize = config.get_user_option_as_int_from_SI(
87
 
                self._optionName,  
88
 
                self._DEFAULT_MAX_FILE_SIZE)
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, self._optionName,  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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from bzrlib.trace import mutter, note, warning
 
18
from bzrlib.errors import NotBranchError
 
19
from bzrlib.branch import Branch
 
20
from bzrlib.osutils import quotefn
 
21
 
 
22
def glob_expand_for_win32(file_list):
 
23
    import glob
 
24
    
 
25
    expanded_file_list = []
 
26
    for possible_glob in file_list:
 
27
        glob_files = glob.glob(possible_glob)
 
28
       
 
29
        if glob_files == []:
 
30
            # special case to let the normal code path handle
 
31
            # files that do not exists
 
32
            expanded_file_list.append(possible_glob)
 
33
        else:
 
34
            expanded_file_list += glob_files
 
35
    return expanded_file_list
 
36
 
 
37
 
 
38
def add_reporter_null(path, kind, entry):
 
39
    """Absorb add reports and do nothing."""
 
40
    pass
 
41
 
 
42
def add_reporter_print(path, kind, entry):
 
43
    """Print a line to stdout for each file that's added."""
 
44
    print "added", quotefn(path)
 
45
    
 
46
def _prepare_file_list(file_list):
 
47
    """Prepare a file list for use by smart_add_*."""
 
48
    import sys
 
49
    if sys.platform == 'win32':
 
50
        file_list = glob_expand_for_win32(file_list)
 
51
    if not file_list:
 
52
        file_list = ['.']
 
53
    file_list = list(file_list)
 
54
    return file_list
 
55
 
 
56
 
 
57
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
 
58
    """Add files to version, optionally recursing into directories.
 
59
 
 
60
    This is designed more towards DWIM for humans than API simplicity.
 
61
    For the specific behaviour see the help for cmd_add().
 
62
 
 
63
    Returns the number of files added.
 
64
    """
 
65
    file_list = _prepare_file_list(file_list)
 
66
    b = Branch(file_list[0], find_root=True)
 
67
    return smart_add_branch(b, file_list, recurse, reporter)
 
68
 
 
69
        
 
70
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
 
71
    """Add files to version, optionally recursing into directories.
 
72
 
 
73
    This is designed more towards DWIM for humans than API simplicity.
 
74
    For the specific behaviour see the help for cmd_add().
 
75
 
 
76
    This yields a sequence of (path, kind, file_id) for added files.
 
77
 
 
78
    Returns the number of files added.
 
79
    """
 
80
    import os
 
81
    import sys
 
82
    from bzrlib.osutils import quotefn
 
83
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
84
    import bzrlib.branch
 
85
    import bzrlib.osutils
 
86
 
 
87
    assert isinstance(recurse, bool)
 
88
 
 
89
    file_list = _prepare_file_list(file_list)
 
90
    user_list = file_list[:]
 
91
    inv = branch.read_working_inventory()
 
92
    tree = branch.working_tree()
 
93
    count = 0
 
94
 
 
95
    for f in file_list:
 
96
        rf = branch.relpath(f)
 
97
        af = branch.abspath(rf)
 
98
 
 
99
        kind = bzrlib.osutils.file_kind(af)
 
100
 
 
101
        if kind != 'file' and kind != 'directory':
 
102
            if f in user_list:
 
103
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
 
104
            else:
 
105
                warning("skipping %s (can't add file of kind '%s')", f, kind)
 
106
                continue
 
107
 
 
108
        mutter("smart add of %r, abs=%r" % (f, af))
 
109
        
 
110
        if bzrlib.branch.is_control_file(af):
 
111
            raise ForbiddenFileError('cannot add control file %s' % f)
 
112
            
 
113
        versioned = (inv.path2id(rf) != None)
 
114
 
 
115
        if kind == 'directory':
 
116
            try:
 
117
                sub_branch = Branch(af, find_root=False)
 
118
                sub_tree = True
 
119
            except NotBranchError:
 
120
                sub_tree = False
 
121
        else:
 
122
            sub_tree = False
 
123
 
 
124
        if rf == '':
 
125
            mutter("branch root doesn't need to be added")
 
126
            sub_tree = False
 
127
        elif versioned:
 
128
            mutter("%r is already versioned" % f)
 
129
        elif sub_tree:
 
130
            mutter("%r is a bzr tree" %f)
 
131
        else:
 
132
            entry = inv.add_path(rf, kind=kind)
 
133
            mutter("added %r kind %r file_id={%s}" % (rf, kind, entry.file_id))
 
134
            count += 1 
 
135
            reporter(rf, kind, entry)
 
136
 
 
137
        if kind == 'directory' and recurse and not sub_tree:
 
138
            for subf in os.listdir(af):
 
139
                subp = os.path.join(rf, subf)
 
140
                if subf == bzrlib.BZRDIR:
 
141
                    mutter("skip control directory %r" % subp)
 
142
                elif tree.is_ignored(subp):
 
143
                    mutter("skip ignored sub-file %r" % subp)
 
144
                else:
 
145
                    mutter("queue to add sub-file %r" % subp)
 
146
                    file_list.append(branch.abspath(subp))
 
147
 
 
148
 
 
149
    mutter('added %d entries', count)
 
150
    
 
151
    if count > 0:
 
152
        branch._write_inventory(inv)
 
153
 
 
154
    return count