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, parent_ie, path, kind):
55
"""Absorb add actions and do nothing."""
59
def add_action_print(inv, parent_ie, path, kind):
60
"""Print a line to stdout for each file that would be added."""
61
print "added", bzrlib.osutils.quotefn(path)
64
def add_action_add(inv, parent_ie, path, kind):
65
"""Add each file to the given inventory. Produce no output."""
66
if parent_ie is not None:
67
entry = bzrlib.inventory.make_entry(
68
kind, bzrlib.osutils.basename(path), parent_ie.file_id)
71
entry = inv.add_path(path, kind=kind)
72
# mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
75
def add_action_add_and_print(inv, parent_ie, path, kind):
76
"""Add each file to the given inventory, and print a line to stdout."""
77
add_action_add(inv, parent_ie, path, kind)
78
add_action_print(inv, parent_ie, path, kind)
81
def smart_add(file_list, recurse=True, action=add_action_add):
82
"""Add files to version, optionally recursing into directories.
84
This is designed more towards DWIM for humans than API simplicity.
85
For the specific behaviour see the help for cmd_add().
87
Returns the number of files added.
89
file_list = _prepare_file_list(file_list)
90
tree = WorkingTree.open_containing(file_list[0])[0]
91
return smart_add_tree(tree, file_list, recurse, action)
94
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
95
"""Add files to version, optionally recursing into directories.
97
This is designed more towards DWIM for humans than API simplicity.
98
For the specific behaviour see the help for cmd_add().
100
This calls reporter with each (path, kind, file_id) of added files.
102
Returns the number of files added.
105
from bzrlib.errors import BadFileKindError, ForbiddenFileError
106
assert isinstance(recurse, bool)
108
orig_list = file_list
109
file_list = _prepare_file_list(file_list)
110
mutter("smart add of %r, originally %r", file_list, orig_list)
111
inv = tree.read_working_inventory()
114
user_files = list(file_list)
117
# validate user file paths and convert all paths to tree
118
# relative : its cheaper to make a tree relative path an abspath
119
# than to convert an abspath to tree relative.
120
for filepath in user_files:
121
rf = tree.relpath(filepath)
122
file_list.append((rf, None))
123
# validate user parameters. Our recursive code avoids adding new files
124
# that need such validation
125
if tree.is_control_filename(rf):
126
raise ForbiddenFileError('cannot add control file %s' % filepath)
128
user_files = set([path for path, parent_ie in file_list])
130
for filepath, parent_ie in file_list:
131
# filepath is tree-relative
132
abspath = tree.abspath(filepath)
134
# find the kind of the path being added. This is not
135
# currently determined when we list directories
136
# recursively, but in theory we can determine while
137
# doing the directory listing on *some* platformans.
138
# TODO: a safe, portable, clean interface which will
139
# be faster than os.listdir() + stat. Specifically,
140
# readdir - dirent.d_type supplies the file type when
141
# it is defined. (Apparently Mac OSX has the field but
142
# does not fill it in ?!) Robert C, Martin P.
144
kind = bzrlib.osutils.file_kind(abspath)
146
if hasattr(e, 'errno') and e.errno == errno.ENOENT:
147
raise errors.NoSuchFile(abspath)
150
# we need to call this to determine the inventory kind to create.
151
if not InventoryEntry.versionable_kind(kind):
152
if filepath in user_files:
153
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
155
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
158
if parent_ie is not None:
159
versioned = bzrlib.osutils.basename(filepath) in parent_ie.children
161
# without the parent ie, use the relatively slower inventory
163
versioned = inv.has_filename(filepath)
165
if kind == 'directory':
167
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
169
except NotBranchError:
171
except errors.UnsupportedFormatError:
177
# mutter("tree root doesn't need to be added")
181
# mutter("%r is already versioned", abspath)
183
mutter("%r is a nested bzr tree", abspath)
185
added.extend(__add_one(tree, inv, parent_ie, filepath, kind, action))
187
if kind == 'directory' and recurse and not sub_tree:
189
if parent_ie is not None:
191
this_ie = parent_ie.children[bzrlib.osutils.basename(filepath)]
193
# without the parent ie, use the relatively slower inventory
195
this_id = inv.path2id(filepath)
199
this_ie = inv[this_id]
203
for subf in os.listdir(abspath):
204
# here we could use TreeDirectory rather than
205
# string concatenation.
206
subp = bzrlib.osutils.pathjoin(filepath, subf)
207
# TODO: is_control_filename is very slow. Make it faster.
208
# TreeDirectory.is_control_filename could also make this
209
# faster - its impossible for a non root dir to have a
211
if tree.is_control_filename(subp):
212
mutter("skip control directory %r", subp)
214
# ignore while selecting files - if we globbed in the
215
# outer loop we would ignore user files.
216
ignore_glob = tree.is_ignored(subp)
217
if ignore_glob is not None:
218
# mutter("skip ignored sub-file %r", subp)
219
if ignore_glob not in ignored:
220
ignored[ignore_glob] = []
221
ignored[ignore_glob].append(subp)
223
#mutter("queue to add sub-file %r", subp)
224
file_list.append((subp, this_ie))
227
tree._write_inventory(inv)
228
return added, ignored
231
def __add_one(tree, inv, parent_ie, path, kind, action):
232
"""Add a file or directory, automatically add unversioned parents."""
234
# Nothing to do if path is already versioned.
235
# This is safe from infinite recursion because the tree root is
237
if parent_ie is not None:
238
# we have a parent ie already
241
# slower but does not need parent_ie
242
if inv.has_filename(path):
245
added = __add_one(tree, inv, None, dirname(path), 'directory', action)
246
parent_id = inv.path2id(dirname(path))
247
if parent_id is not None:
248
parent_ie = inv[inv.path2id(dirname(path))]
251
action(inv, parent_ie, path, kind)
253
return added + [path]
added
removed
bzrlib/add.py
