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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Helper functions for adding files to working trees."""
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from os.path import dirname
20
import bzrlib.errors as errors
21
from bzrlib.inventory import InventoryEntry
22
from bzrlib.trace import mutter, note, warning
23
from bzrlib.errors import NotBranchError
22
24
import bzrlib.osutils
23
from bzrlib.symbol_versioning import *
25
from bzrlib.workingtree import WorkingTree
28
def glob_expand_for_win32(file_list):
32
expanded_file_list = []
33
for possible_glob in file_list:
34
glob_files = glob.glob(possible_glob)
37
# special case to let the normal code path handle
38
# files that do not exists
39
expanded_file_list.append(possible_glob)
41
expanded_file_list += glob_files
42
return expanded_file_list
45
def _prepare_file_list(file_list):
46
"""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)
26
55
class AddAction(object):
27
56
"""A class which defines what action to take when adding a file."""
29
58
def __init__(self, to_file=None, should_print=None):
30
"""Initialize an action which prints added files to an output stream.
32
:param to_file: The stream to write into. This is expected to take
33
Unicode paths. If not supplied, it will default to ``sys.stdout``.
34
:param should_print: If False, printing will be suppressed.
36
59
self._to_file = to_file
37
60
if to_file is None:
38
61
self._to_file = sys.stdout
49
72
:param path: The FastPath being added
50
73
:param kind: The kind of the object being added.
53
self._to_file.write('adding %s\n' % _quote(path.raw_path))
57
class AddFromBaseAction(AddAction):
58
"""This class will try to extract file ids from another tree."""
60
def __init__(self, base_tree, base_path, to_file=None, should_print=None):
61
super(AddFromBaseAction, self).__init__(to_file=to_file,
62
should_print=should_print)
63
self.base_tree = base_tree
64
self.base_path = base_path
66
def __call__(self, inv, parent_ie, path, kind):
67
# Place the parent call
68
# Now check to see if we can extract an id for this file
69
file_id, base_path = self._get_base_file_id(path, parent_ie)
70
if file_id is not None:
72
self._to_file.write('adding %s w/ file id from %s\n'
73
% (path.raw_path, base_path))
75
# we aren't doing anything special, so let the default
77
file_id = super(AddFromBaseAction, self).__call__(
78
inv, parent_ie, path, kind)
81
def _get_base_file_id(self, path, parent_ie):
82
"""Look for a file id in the base branch.
84
First, if the base tree has the parent directory,
85
we look for a file with the same name in that directory.
86
Else, we look for an entry in the base tree with the same path.
89
if (parent_ie.file_id in self.base_tree):
90
base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
91
base_child_ie = base_parent_ie.children.get(path.base_path)
92
if base_child_ie is not None:
93
return (base_child_ie.file_id,
94
self.base_tree.id2path(base_child_ie.file_id))
95
full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
96
# This may return None, but it is our last attempt
97
return self.base_tree.path2id(full_base_path), full_base_path
75
if not self.should_print:
77
self._to_file.write('added ')
78
self._to_file.write(bzrlib.osutils.quotefn(path.raw_path))
79
self._to_file.write('\n')
100
82
# TODO: jam 20050105 These could be used for compatibility
106
88
add_action_null = add_action_add
107
89
add_action_add_and_print = AddAction(should_print=True)
108
90
add_action_print = add_action_add_and_print
93
def smart_add(file_list, recurse=True, action=None, save=True):
94
"""Add files to version, optionally recursing into directories.
96
This is designed more towards DWIM for humans than API simplicity.
97
For the specific behaviour see the help for cmd_add().
99
Returns the number of files added.
100
Please see smart_add_tree for more detail.
102
file_list = _prepare_file_list(file_list)
103
tree = WorkingTree.open_containing(file_list[0])[0]
104
return smart_add_tree(tree, file_list, recurse, action=action)
107
class FastPath(object):
108
"""A path object with fast accessors for things like basename."""
110
__slots__ = ['raw_path', 'base_path']
112
def __init__(self, path, base_path=None):
113
"""Construct a FastPath from path."""
114
if base_path is None:
115
self.base_path = bzrlib.osutils.basename(path)
117
self.base_path = base_path
121
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
122
"""Add files to version, optionally recursing into directories.
124
This is designed more towards DWIM for humans than API simplicity.
125
For the specific behaviour see the help for cmd_add().
127
This calls reporter with each (path, kind, file_id) of added files.
129
Returns the number of files added.
131
:param save: Save the inventory after completing the adds. If False this
132
provides dry-run functionality by doing the add and not saving the
133
inventory. Note that the modified inventory is left in place, allowing
134
further dry-run tasks to take place. To restore the original inventory
135
call tree.read_working_inventory().
138
from bzrlib.errors import BadFileKindError, ForbiddenFileError
139
assert isinstance(recurse, bool)
143
prepared_list = _prepare_file_list(file_list)
144
mutter("smart add of %r, originally %r", prepared_list, file_list)
145
inv = tree.read_working_inventory()
151
# validate user file paths and convert all paths to tree
152
# relative : its cheaper to make a tree relative path an abspath
153
# than to convert an abspath to tree relative.
154
for filepath in prepared_list:
155
rf = FastPath(tree.relpath(filepath))
156
# validate user parameters. Our recursive code avoids adding new files
157
# that need such validation
158
if tree.is_control_filename(rf.raw_path):
159
raise ForbiddenFileError('cannot add control file %s' % filepath)
161
abspath = tree.abspath(rf.raw_path)
162
kind = bzrlib.osutils.file_kind(abspath)
163
if kind == 'directory':
164
# schedule the dir for scanning
165
user_dirs.add(rf.raw_path)
167
if not InventoryEntry.versionable_kind(kind):
168
raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
169
# ensure the named path is added, so that ignore rules in the later directory
171
# we dont have a parent ie known yet.: use the relatively slower inventory
173
versioned = inv.has_filename(rf.raw_path)
176
added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
179
# no need to walk any directories at all.
180
if len(added) > 0 and save:
181
tree._write_inventory(inv)
182
return added, ignored
184
# only walk the minimal parents needed: we have user_dirs to override
187
for path in sorted(user_dirs):
188
if (prev_dir is None or not
189
bzrlib.osutils.is_inside_or_parent_of_any([prev_dir], path)):
190
dirs_to_add.append((rf, None))
193
# this will eventually be *just* directories, right now it starts off with
195
for directory, parent_ie in dirs_to_add:
196
# directory is tree-relative
197
abspath = tree.abspath(directory.raw_path)
199
# get the contents of this directory.
201
# find the kind of the path being added.
202
kind = bzrlib.osutils.file_kind(abspath)
204
if not InventoryEntry.versionable_kind(kind):
205
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
208
if parent_ie is not None:
209
versioned = directory.base_path in parent_ie.children
211
# without the parent ie, use the relatively slower inventory
213
versioned = inv.has_filename(directory.raw_path)
215
if kind == 'directory':
217
sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
219
except NotBranchError:
221
except errors.UnsupportedFormatError:
226
if directory.raw_path == '':
227
# mutter("tree root doesn't need to be added")
231
# mutter("%r is already versioned", abspath)
233
mutter("%r is a nested bzr tree", abspath)
235
__add_one(tree, inv, parent_ie, directory, kind, action)
236
added.append(directory.raw_path)
238
if kind == 'directory' and not sub_tree:
239
if parent_ie is not None:
241
this_ie = parent_ie.children[directory.base_path]
243
# without the parent ie, use the relatively slower inventory
245
this_id = inv.path2id(directory.raw_path)
249
this_ie = inv[this_id]
251
for subf in os.listdir(abspath):
252
# here we could use TreeDirectory rather than
253
# string concatenation.
254
subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
255
# TODO: is_control_filename is very slow. Make it faster.
256
# TreeDirectory.is_control_filename could also make this
257
# faster - its impossible for a non root dir to have a
259
if tree.is_control_filename(subp):
260
mutter("skip control directory %r", subp)
261
elif subf in this_ie.children:
262
# recurse into this already versioned subdir.
263
dirs_to_add.append((FastPath(subp, subf), this_ie))
265
# user selection overrides ignoes
266
# ignore while selecting files - if we globbed in the
267
# outer loop we would ignore user files.
268
ignore_glob = tree.is_ignored(subp)
269
if ignore_glob is not None:
270
# mutter("skip ignored sub-file %r", subp)
271
if ignore_glob not in ignored:
272
ignored[ignore_glob] = []
273
ignored[ignore_glob].append(subp)
275
#mutter("queue to add sub-file %r", subp)
276
dirs_to_add.append((FastPath(subp, subf), this_ie))
278
if len(added) > 0 and save:
279
tree._write_inventory(inv)
280
return added, ignored
283
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
284
"""Add a new entry to the inventory and automatically add unversioned parents.
286
:param inv: Inventory which will receive the new entry.
287
:param parent_ie: Parent inventory entry if known, or None. If
288
None, the parent is looked up by name and used if present, otherwise
289
it is recursively added.
290
:param kind: Kind of new entry (file, directory, etc)
291
:param action: callback(inv, parent_ie, path, kind); return ignored.
292
:returns: A list of paths which have been added.
294
# Nothing to do if path is already versioned.
295
# This is safe from infinite recursion because the tree root is
297
if parent_ie is not None:
298
# we have a parent ie already
301
# slower but does not need parent_ie
302
if inv.has_filename(path.raw_path):
304
# its really not there : add the parent
305
# note that the dirname use leads to some extra str copying etc but as
306
# there are a limited number of dirs we can be nested under, it should
307
# generally find it very fast and not recurse after that.
308
added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
309
parent_id = inv.path2id(dirname(path.raw_path))
310
if parent_id is None:
311
parent_ie = inv[inv.path2id(dirname(path.raw_path))]
313
parent_ie = inv[parent_id]
314
__add_one(tree, inv, parent_ie, path, kind, action)
315
return added + [path.raw_path]
318
def __add_one(tree, inv, parent_ie, path, kind, action):
319
"""Add a new entry to the inventory.
321
:param inv: Inventory which will receive the new entry.
322
:param parent_ie: Parent inventory entry.
323
:param kind: Kind of new entry (file, directory, etc)
324
:param action: callback(inv, parent_ie, path, kind); return ignored.
327
action(inv, parent_ie, path, kind)
328
entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id)
added
removed
bzrlib/add.py
