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
24
from bzrlib.workingtree import WorkingTree
26
def glob_expand_for_win32(file_list):
30
expanded_file_list = []
31
for possible_glob in file_list:
32
glob_files = glob.glob(possible_glob)
35
# special case to let the normal code path handle
36
# files that do not exists
37
expanded_file_list.append(possible_glob)
39
expanded_file_list += glob_files
40
return expanded_file_list
43
def _prepare_file_list(file_list):
44
"""Prepare a file list for use by smart_add_*."""
46
if sys.platform == 'win32':
47
file_list = glob_expand_for_win32(file_list)
50
file_list = list(file_list)
54
def add_action_null(inv, path, kind):
55
"""Absorb add actions and do nothing."""
58
def add_action_print(inv, path, kind):
59
"""Print a line to stdout for each file that would be added."""
60
print "added", bzrlib.osutils.quotefn(path)
62
def add_action_add(inv, path, kind):
63
"""Add each file to the given inventory. Produce no output."""
64
entry = inv.add_path(path, kind=kind)
65
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)
87
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
88
"""Add files to version, optionally recursing into directories.
90
This is designed more towards DWIM for humans than API simplicity.
91
For the specific behaviour see the help for cmd_add().
93
This calls reporter with each (path, kind, file_id) of added files.
95
Returns the number of files added.
98
from bzrlib.errors import BadFileKindError, ForbiddenFileError
99
assert isinstance(recurse, bool)
101
file_list = _prepare_file_list(file_list)
102
user_list = file_list[:]
103
inv = tree.read_working_inventory()
106
user_files = set(file_list)
110
af = tree.abspath(rf)
113
kind = bzrlib.osutils.file_kind(af)
115
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
116
raise errors.NoSuchFile(rf)
119
if not InventoryEntry.versionable_kind(kind):
121
raise BadFileKindError("cannot add %s of type %s" % (f, kind))
123
warning("skipping %s (can't add file of kind '%s')", f, kind)
126
mutter("smart add of %r, abs=%r", f, af)
128
# validate user parameters. Our recursive code avoids adding new files
129
# that need such validation
130
if f in user_files and tree.is_control_filename(af):
131
raise ForbiddenFileError('cannot add control file %s' % f)
133
versioned = (inv.path2id(rf) != None)
135
if kind == 'directory':
137
sub_branch = WorkingTree.open(af)
139
except NotBranchError:
141
except errors.UnsupportedFormatError:
147
mutter("tree root doesn't need to be added")
150
mutter("%r is already versioned", f)
152
mutter("%r is a bzr tree", f)
154
added.extend(__add_one(tree, inv, rf, kind, action))
156
if kind == 'directory' and recurse and not sub_tree:
157
for subf in os.listdir(af):
158
subp = bzrlib.osutils.pathjoin(rf, subf)
159
if tree.is_control_filename(subp):
160
mutter("skip control directory %r", subp)
162
ignore_glob = tree.is_ignored(subp)
163
if ignore_glob is not None:
164
mutter("skip ignored sub-file %r", subp)
165
if ignore_glob not in ignored:
166
ignored[ignore_glob] = []
167
ignored[ignore_glob].append(subp)
169
mutter("queue to add sub-file %r", subp)
170
file_list.append(tree.abspath(subp))
172
mutter('added %d entries', len(added))
175
tree._write_inventory(inv)
177
return added, ignored
180
def __add_one(tree, inv, path, kind, action):
181
"""Add a file or directory, automatically add unversioned parents."""
183
# Nothing to do if path is already versioned.
184
# This is safe from infinite recursion because the tree root is
186
if inv.path2id(path) != None:
190
added = __add_one(tree, inv, dirname(path), 'directory', action)
191
action(inv, path, kind)
193
return added + [path]