1
# Copyright (C) 2005 Canonical Ltd
 
 
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.
 
 
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.
 
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
from os.path import dirname
 
 
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.workingtree import is_control_file
 
 
25
from bzrlib.workingtree import WorkingTree
 
 
27
def glob_expand_for_win32(file_list):
 
 
31
    expanded_file_list = []
 
 
32
    for possible_glob in file_list:
 
 
33
        glob_files = glob.glob(possible_glob)
 
 
36
            # special case to let the normal code path handle
 
 
37
            # files that do not exists
 
 
38
            expanded_file_list.append(possible_glob)
 
 
40
            expanded_file_list += glob_files
 
 
41
    return expanded_file_list
 
 
44
def _prepare_file_list(file_list):
 
 
45
    """Prepare a file list for use by smart_add_*."""
 
 
47
    if sys.platform == 'win32':
 
 
48
        file_list = glob_expand_for_win32(file_list)
 
 
51
    file_list = list(file_list)
 
 
55
def add_action_null(inv, path, kind):
 
 
56
    """Absorb add actions and do nothing."""
 
 
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)
 
 
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))
 
 
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)
 
 
74
def smart_add(file_list, recurse=True, action=add_action_add):
 
 
75
    """Add files to version, optionally recursing into directories.
 
 
77
    This is designed more towards DWIM for humans than API simplicity.
 
 
78
    For the specific behaviour see the help for cmd_add().
 
 
80
    Returns the number of files added.
 
 
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)
 
 
86
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
 
 
87
    """Add files to version, optionally recursing into directories.
 
 
89
    This is designed more towards DWIM for humans than API simplicity.
 
 
90
    For the specific behaviour see the help for cmd_add().
 
 
92
    This calls reporter with each (path, kind, file_id) of added files.
 
 
94
    Returns the number of files added.
 
 
97
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
 
98
    assert isinstance(recurse, bool)
 
 
100
    file_list = _prepare_file_list(file_list)
 
 
101
    user_list = file_list[:]
 
 
102
    inv = tree.read_working_inventory()
 
 
108
        af = tree.abspath(rf)
 
 
111
            kind = bzrlib.osutils.file_kind(af)
 
 
113
            if hasattr(e, 'errno') and e.errno == errno.ENOENT:
 
 
114
                raise errors.NoSuchFile(rf)
 
 
117
        if not InventoryEntry.versionable_kind(kind):
 
 
119
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
 
 
121
                warning("skipping %s (can't add file of kind '%s')", f, kind)
 
 
124
        mutter("smart add of %r, abs=%r", f, af)
 
 
126
        if tree.is_control_filename(af):
 
 
127
            raise ForbiddenFileError('cannot add control file %s' % f)
 
 
129
        versioned = (inv.path2id(rf) != None)
 
 
131
        if kind == 'directory':
 
 
133
                sub_branch = WorkingTree.open(af)
 
 
135
            except NotBranchError:
 
 
137
            except errors.UnsupportedFormatError:
 
 
143
            mutter("tree root doesn't need to be added")
 
 
146
            mutter("%r is already versioned", f)
 
 
148
            mutter("%r is a bzr tree", f)
 
 
150
            added.extend(__add_one(tree, inv, rf, kind, action))
 
 
152
        if kind == 'directory' and recurse and not sub_tree:
 
 
153
            for subf in os.listdir(af):
 
 
154
                subp = bzrlib.osutils.pathjoin(rf, subf)
 
 
155
                if tree.is_control_filename(subp):
 
 
156
                    mutter("skip control directory %r", subp)
 
 
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)
 
 
165
                        mutter("queue to add sub-file %r", subp)
 
 
166
                        file_list.append(tree.abspath(subp))
 
 
169
    mutter('added %d entries', len(added))
 
 
172
        tree._write_inventory(inv)
 
 
174
    return added, ignored
 
 
176
def __add_one(tree, inv, path, kind, action):
 
 
177
    """Add a file or directory, automatically add unversioned parents."""
 
 
179
    # Nothing to do if path is already versioned.
 
 
180
    # This is safe from infinite recursion because the tree root is
 
 
182
    if inv.path2id(path) != None:
 
 
186
    added = __add_one(tree, inv, dirname(path), 'directory', action)
 
 
187
    action(inv, path, kind)
 
 
189
    return added + [path]