← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Jelmer Vernooij
  • Date: 2011-03-12 16:55:08 UTC
  • mto: This revision was merged to the branch mainline in revision 5737.
  • Revision ID: jelmer@samba.org-20110312165508-8aerwldchcf1n2ah
Test default control component format implementation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2010 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., 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
 
from os.path import dirname
22
 
 
23
 
def glob_expand_for_win32(file_list):
24
 
    import glob
25
 
    
26
 
    expanded_file_list = []
27
 
    for possible_glob in file_list:
28
 
        glob_files = glob.glob(possible_glob)
29
 
       
30
 
        if glob_files == []:
31
 
            # special case to let the normal code path handle
32
 
            # files that do not exists
33
 
            expanded_file_list.append(possible_glob)
34
 
        else:
35
 
            expanded_file_list += glob_files
36
 
    return expanded_file_list
37
 
 
38
 
 
39
 
def add_reporter_null(path, kind, entry):
40
 
    """Absorb add reports and do nothing."""
41
 
    pass
42
 
 
43
 
def add_reporter_print(path, kind, entry):
44
 
    """Print a line to stdout for each file that's added."""
45
 
    print "added", quotefn(path)
46
 
    
47
 
def _prepare_file_list(file_list):
48
 
    """Prepare a file list for use by smart_add_*."""
49
 
    import sys
50
 
    if sys.platform == 'win32':
51
 
        file_list = glob_expand_for_win32(file_list)
52
 
    if not file_list:
53
 
        file_list = ['.']
54
 
    file_list = list(file_list)
55
 
    return file_list
56
 
 
57
 
 
58
 
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
59
 
    """Add files to version, optionally recursing into directories.
60
 
 
61
 
    This is designed more towards DWIM for humans than API simplicity.
62
 
    For the specific behaviour see the help for cmd_add().
63
 
 
64
 
    Returns the number of files added.
65
 
    """
66
 
    file_list = _prepare_file_list(file_list)
67
 
    b = Branch(file_list[0], find_root=True)
68
 
    return smart_add_branch(b, file_list, recurse, reporter)
69
 
 
70
 
        
71
 
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
72
 
    """Add files to version, optionally recursing into directories.
73
 
 
74
 
    This is designed more towards DWIM for humans than API simplicity.
75
 
    For the specific behaviour see the help for cmd_add().
76
 
 
77
 
    This yields a sequence of (path, kind, file_id) for added files.
78
 
 
79
 
    Returns the number of files added.
80
 
    """
81
 
    import os
82
 
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
83
 
    import bzrlib.branch
84
 
 
85
 
    assert isinstance(recurse, bool)
86
 
 
87
 
    file_list = _prepare_file_list(file_list)
88
 
    user_list = file_list[:]
89
 
    inv = branch.read_working_inventory()
90
 
    tree = branch.working_tree()
91
 
    count = 0
92
 
 
93
 
    for f in file_list:
94
 
        rf = branch.relpath(f)
95
 
        af = branch.abspath(rf)
96
 
 
97
 
        kind = bzrlib.osutils.file_kind(af)
98
 
 
99
 
        if kind != 'file' and kind != 'directory':
100
 
            if f in user_list:
101
 
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
102
 
            else:
103
 
                warning("skipping %s (can't add file of kind '%s')", f, kind)
104
 
                continue
105
 
 
106
 
        mutter("smart add of %r, abs=%r" % (f, af))
107
 
        
108
 
        if bzrlib.branch.is_control_file(af):
109
 
            raise ForbiddenFileError('cannot add control file %s' % f)
110
 
            
111
 
        versioned = (inv.path2id(rf) != None)
112
 
 
113
 
        if kind == 'directory':
114
 
            try:
115
 
                sub_branch = Branch(af, find_root=False)
116
 
                sub_tree = True
117
 
            except NotBranchError:
118
 
                sub_tree = False
119
 
        else:
120
 
            sub_tree = False
121
 
 
122
 
        if rf == '':
123
 
            mutter("branch root doesn't need to be added")
124
 
            sub_tree = False
125
 
        elif versioned:
126
 
            mutter("%r is already versioned" % f)
127
 
        elif sub_tree:
128
 
            mutter("%r is a bzr tree" %f)
129
 
        else:
130
 
            count += __add_one(branch, inv, rf, kind, reporter)
131
 
 
132
 
        if kind == 'directory' and recurse and not sub_tree:
133
 
            for subf in os.listdir(af):
134
 
                subp = os.path.join(rf, subf)
135
 
                if subf == bzrlib.BZRDIR:
136
 
                    mutter("skip control directory %r" % subp)
137
 
                elif tree.is_ignored(subp):
138
 
                    mutter("skip ignored sub-file %r" % subp)
139
 
                else:
140
 
                    mutter("queue to add sub-file %r" % subp)
141
 
                    file_list.append(branch.abspath(subp))
142
 
 
143
 
 
144
 
    mutter('added %d entries', count)
145
 
    
146
 
    if count > 0:
147
 
        branch._write_inventory(inv)
148
 
 
149
 
    return count
150
 
 
151
 
def __add_one(branch, inv, path, kind, reporter):
152
 
    """Add a file or directory, automatically add unversioned parents."""
153
 
 
154
 
    # Nothing to do if path is already versioned.
155
 
    # This is safe from infinite recursion because the branch root is
156
 
    # always versioned.
157
 
    if inv.path2id(path) != None:
158
 
        return 0
159
 
 
160
 
    # add parent
161
 
    count = __add_one(branch, inv, dirname(path), 'directory', reporter)
162
 
 
163
 
    entry = inv.add_path(path, kind=kind)
164
 
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
165
 
    reporter(path, kind, entry)
166
 
 
167
 
    return count + 1
 
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
 
 
21
import bzrlib.osutils
 
22
 
 
23
 
 
24
class AddAction(object):
 
25
    """A class which defines what action to take when adding a file."""
 
26
 
 
27
    def __init__(self, to_file=None, should_print=None):
 
28
        """Initialize an action which prints added files to an output stream.
 
29
 
 
30
        :param to_file: The stream to write into. This is expected to take
 
31
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
 
32
        :param should_print: If False, printing will be suppressed.
 
33
        """
 
34
        self._to_file = to_file
 
35
        if to_file is None:
 
36
            self._to_file = sys.stdout
 
37
        self.should_print = False
 
38
        if should_print is not None:
 
39
            self.should_print = should_print
 
40
 
 
41
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
 
42
        """Add path to inventory.
 
43
 
 
44
        The default action does nothing.
 
45
 
 
46
        :param inv: The inventory we are working with.
 
47
        :param path: The FastPath being added
 
48
        :param kind: The kind of the object being added.
 
49
        """
 
50
        if self.should_print:
 
51
            self._to_file.write('adding %s\n' % _quote(path.raw_path))
 
52
        return None
 
53
 
 
54
 
 
55
class AddFromBaseAction(AddAction):
 
56
    """This class will try to extract file ids from another tree."""
 
57
 
 
58
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
 
59
        super(AddFromBaseAction, self).__init__(to_file=to_file,
 
60
                                                should_print=should_print)
 
61
        self.base_tree = base_tree
 
62
        self.base_path = base_path
 
63
 
 
64
    def __call__(self, inv, parent_ie, path, kind):
 
65
        # Place the parent call
 
66
        # Now check to see if we can extract an id for this file
 
67
        file_id, base_path = self._get_base_file_id(path, parent_ie)
 
68
        if file_id is not None:
 
69
            if self.should_print:
 
70
                self._to_file.write('adding %s w/ file id from %s\n'
 
71
                                    % (path.raw_path, base_path))
 
72
        else:
 
73
            # we aren't doing anything special, so let the default
 
74
            # reporter happen
 
75
            file_id = super(AddFromBaseAction, self).__call__(
 
76
                        inv, parent_ie, path, kind)
 
77
        return file_id
 
78
 
 
79
    def _get_base_file_id(self, path, parent_ie):
 
80
        """Look for a file id in the base branch.
 
81
 
 
82
        First, if the base tree has the parent directory,
 
83
        we look for a file with the same name in that directory.
 
84
        Else, we look for an entry in the base tree with the same path.
 
85
        """
 
86
 
 
87
        if (parent_ie.file_id in self.base_tree):
 
88
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
 
89
            base_child_ie = base_parent_ie.children.get(path.base_path)
 
90
            if base_child_ie is not None:
 
91
                return (base_child_ie.file_id,
 
92
                        self.base_tree.id2path(base_child_ie.file_id))
 
93
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
 
94
        # This may return None, but it is our last attempt
 
95
        return self.base_tree.path2id(full_base_path), full_base_path