← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

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 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 Branch
24
 
from bzrlib.osutils import quotefn
25
 
 
26
 
def glob_expand_for_win32(file_list):
27
 
    import glob
28
 
    expanded_file_list = []
29
 
    for possible_glob in file_list:
30
 
        glob_files = glob.glob(possible_glob)
31
 
       
32
 
        if glob_files == []:
33
 
            # special case to let the normal code path handle
34
 
            # files that do not exists
35
 
            expanded_file_list.append(possible_glob)
36
 
        else:
37
 
            expanded_file_list += glob_files
38
 
    return expanded_file_list
39
 
 
40
 
 
41
 
def add_reporter_null(path, kind, entry):
42
 
    """Absorb add reports and do nothing."""
43
 
    pass
44
 
 
45
 
def add_reporter_print(path, kind, entry):
46
 
    """Print a line to stdout for each file that's added."""
47
 
    print "added", quotefn(path)
48
 
    
49
 
def _prepare_file_list(file_list):
50
 
    """Prepare a file list for use by smart_add_*."""
51
 
    import sys
52
 
    if sys.platform == 'win32':
53
 
        file_list = glob_expand_for_win32(file_list)
54
 
    if not file_list:
55
 
        file_list = ['.']
56
 
    file_list = list(file_list)
57
 
    return file_list
58
 
 
59
 
 
60
 
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
61
 
    """Add files to version, optionally recursing into directories.
62
 
 
63
 
    This is designed more towards DWIM for humans than API simplicity.
64
 
    For the specific behaviour see the help for cmd_add().
65
 
 
66
 
    Returns the number of files added.
67
 
    """
68
 
    file_list = _prepare_file_list(file_list)
69
 
    b = Branch.open_containing(file_list[0])[0]
70
 
    return smart_add_branch(b, file_list, recurse, reporter)
71
 
 
72
 
        
73
 
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
74
 
    """Add files to version, optionally recursing into directories.
75
 
 
76
 
    This is designed more towards DWIM for humans than API simplicity.
77
 
    For the specific behaviour see the help for cmd_add().
78
 
 
79
 
    This yields a sequence of (path, kind, file_id) for added files.
80
 
 
81
 
    Returns the number of files added.
82
 
    """
83
 
    import os
84
 
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
85
 
    import bzrlib.branch
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 = tree.relpath(f)
97
 
        af = branch.abspath(rf)
98
 
 
99
 
        kind = bzrlib.osutils.file_kind(af)
100
 
 
101
 
        if not InventoryEntry.versionable_kind(kind):
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.open(af)
118
 
                sub_tree = True
119
 
            except NotBranchError:
120
 
                sub_tree = False
121
 
            except errors.UnsupportedFormatError:
122
 
                sub_tree = True
123
 
        else:
124
 
            sub_tree = False
125
 
 
126
 
        if rf == '':
127
 
            mutter("branch root doesn't need to be added")
128
 
            sub_tree = False
129
 
        elif versioned:
130
 
            mutter("%r is already versioned" % f)
131
 
        elif sub_tree:
132
 
            mutter("%r is a bzr tree" %f)
133
 
        else:
134
 
            count += __add_one(branch, inv, rf, kind, reporter)
135
 
 
136
 
        if kind == 'directory' and recurse and not sub_tree:
137
 
            for subf in os.listdir(af):
138
 
                subp = os.path.join(rf, subf)
139
 
                if subf == bzrlib.BZRDIR:
140
 
                    mutter("skip control directory %r" % subp)
141
 
                elif tree.is_ignored(subp):
142
 
                    mutter("skip ignored sub-file %r" % subp)
143
 
                else:
144
 
                    mutter("queue to add sub-file %r" % subp)
145
 
                    file_list.append(branch.abspath(subp))
146
 
 
147
 
 
148
 
    mutter('added %d entries', count)
149
 
    
150
 
    if count > 0:
151
 
        branch._write_inventory(inv)
152
 
 
153
 
    return count
154
 
 
155
 
def __add_one(branch, inv, path, kind, reporter):
156
 
    """Add a file or directory, automatically add unversioned parents."""
157
 
 
158
 
    # Nothing to do if path is already versioned.
159
 
    # This is safe from infinite recursion because the branch root is
160
 
    # always versioned.
161
 
    if inv.path2id(path) != None:
162
 
        return 0
163
 
 
164
 
    # add parent
165
 
    count = __add_one(branch, inv, dirname(path), 'directory', reporter)
166
 
 
167
 
    entry = inv.add_path(path, kind=kind)
168
 
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
169
 
    reporter(path, kind, entry)
170
 
 
171
 
    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